Skip to content

Commit 4ed400e

Browse files
committed
add docs on locking size terms
1 parent ed3ee7f commit 4ed400e

File tree

1 file changed

+10
-0
lines changed
  • docs/users-guide/estimation-mode

1 file changed

+10
-0
lines changed

docs/users-guide/estimation-mode/larch.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,16 @@ for all other size-based models. When copying the revised size term specificati
269269
to the model configuration, the user should be careful that re-estimation updates
270270
from multiple models are not inadvertently overwriting each other.
271271

272+
As an alternative, users can choose to *not* re-estimate the size terms, by
273+
providing exogenous size terms in the model specification, and instructing Larch
274+
not to re-estimate these parameters. This is done via the `Model.lock_value`
275+
command, which will fix any given named parameter to a specific value. This command
276+
takes two arguments: the name of the parameter to be fixed, and the value to
277+
fix it to. The `lock_value` command can be used to fix the size term parameters
278+
to the values in the size term specification file, and then the model will be
279+
estimated without re-estimating the size terms. If no re-estimation is desired,
280+
users can also safely ignore the `update_size_spec` function.
281+
272282
## Example Notebooks
273283

274284
ActivitySim includes a collection of Jupyter notebooks with

0 commit comments

Comments
 (0)