Skip to content

Commit 12fc355

Browse files
committed
[skip ci] update doc
1 parent abed627 commit 12fc355

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/users-guide/ways_to_run.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,11 @@ For interaction_simulate models, users can manually specify trace IDs to perform
312312
Users can configure ActivitySim to not skip failed choices by setting the
313313
``skip_failed_choices`` option to ``False`` in the settings file. When this option is disabled, the system will fall back to
314314
using the legacy ``overflow_protection`` mechanism to handle such cases. Specifically, if the computed utilities lead to zero or infinite exponentiated values,
315-
overflow protection will adjust the utilities to prevent numerical overflow during exponentiation and arbitarily making a choice.
316-
No loggings will be made for these cases. When ``skip_failed_choices`` is enabled,
317-
ActivitySim will not use the legacy ``overflow_protection`` mechanism to handle failed choices.
315+
the legacy ``overflow_protection`` will adjust the utilities to prevent numerical overflow during exponentiation and arbitarily making a choice, however, no loggings will be made for these cases.
316+
When ``skip_failed_choices`` is enabled, ActivitySim will not use the legacy ``overflow_protection`` mechanism to handle failed choices.
317+
318+
.. note::
319+
When an agency turns on ``skip_failed_choices`` for the first time in an existing ActivitySim implementation,
320+
warning messages may appear in the log for failed choices that were previously handled silently by the legacy ``overflow_protection`` mechanism.
321+
These warnings are expected and reflect the change in behavior: failed choices are now explicitly skipped and traced rather than silently handled.
322+
In some cases, model runs may crash if the number of skipped failed choices exceeds the configured ``fraction_of_failed_choices_allowed`` threshold.

0 commit comments

Comments
 (0)