At-work Subtour Mode#
The at-work subtour mode choice model assigns a travel mode to each at-work subtour using the tour_mode_choice
model.
The main interface to the at-work subtour mode choice model is the
atwork_subtour_mode_choice
function. This function is called in the Inject step atwork_subtour_mode_choice
and
is registered as an Inject step in the example Pipeline.
writing_logsums for how to write logsums for estimation.
Structure#
Configuration File:
tour_mode_choice.yaml
Core Table:
tour
Result Field:
tour_mode
Skims keys:
workplace_taz, destination, start, end
Configuration#
- settings activitysim.abm.models.atwork_subtour_mode_choice.TourModeComponentSettings#
Bases:
TemplatedLogitComponentSettings
- Config:
extra: str = forbid
- Fields:
COEFFICIENTS ()
COEFFICIENT_TEMPLATE ()
COMPUTE_TRIP_MODE_CHOICE_LOGSUMS (bool)
CONSTANTS ()
FORCE_ESCORTEE_CHAUFFEUR_MODE_MATCH (bool)
LOGIT_TYPE ()
LOGSUM_CHOOSER_COLUMNS (list[str])
MODE_CHOICE_LOGSUM_COLUMN_NAME (str | None)
NESTS ()
SPEC ()
annotate_tours (PreprocessorSettings | None)
compute_settings ()
nontour_preprocessor (PreprocessorSettings | list[PreprocessorSettings] | None)
preprocessor (PreprocessorSettings | list[PreprocessorSettings] | None)
source_file_paths ()
tvpb_mode_path_types (dict[str, Any] | None)
use_TVPB_constants (bool)
- Validators:
update_sharrow_skip
»all fields
- field COEFFICIENTS: Path | None = None#
Coefficients filename.
This is a CSV file giving named parameters for use in the utility expression. If it is not provided, then it is assumed that all model coefficients are given explicitly in the SPEC as numerical values instead of named parameters. This is perfectly acceptable for use with ActivitySim for typical simulation applications, but may be problematic if used with “estimation mode”.
- Validated by:
update_sharrow_skip
- field COEFFICIENT_TEMPLATE: str | None = None#
Coefficients template filename.
For a segmented model component, this maps the named parameters to segment-specific names.
- Validated by:
update_sharrow_skip
- field CONSTANTS: dict[str, Any] = {}#
Named constants usable in the utility expressions.
- Validated by:
update_sharrow_skip
- field LOGIT_TYPE: Literal['MNL', 'NL'] = 'MNL'#
Logit model mathematical form.
- “MNL”
Multinomial logit model.
- “NL”
Nested multinomial logit model.
- Validated by:
update_sharrow_skip
- field NESTS: LogitNestSpec | None = None#
Nesting structure for a nested logit model.
The nesting structure is specified heirarchically from the top, so the value of this field should be the “root” level nest of the nested logit tree, which should contain references to lower level nests and/or the actual alternatives.
For example, this YAML defines a simple nesting structure for four alternatives (DRIVE, WALK, WALK_TO_TRANSIT, DRIVE_TO_TRANSIT) with the two transit alternatives grouped together in a nest:
NESTS: name: root coefficient: coef_nest_root alternatives: - DRIVE - WALK - name: TRANSIT coefficient: coef_nest_transit alternatives: - WALK_TO_TRANSIT - DRIVE_TO_TRANSIT
- Validated by:
update_sharrow_skip
- field SPEC: Path [Required]#
Utility specification filename.
This is sometimes alternatively called the utility expressions calculator (UEC). It is a CSV file giving all the functions for the terms of a linear-in-parameters utility expression.
- Validated by:
update_sharrow_skip
- field annotate_tours: PreprocessorSettings | None = None#
- Validated by:
update_sharrow_skip
- field compute_settings: ComputeSettings = ComputeSettings(sharrow_skip=False, fastmath=True, use_bottleneck=None, use_numexpr=None, use_numba=None, drop_unused_columns=True, protect_columns=[])#
Sharrow settings for this component.
- Validated by:
update_sharrow_skip
- field nontour_preprocessor: PreprocessorSettings | list[PreprocessorSettings] | None = None#
- Validated by:
update_sharrow_skip
- field preprocessor: PreprocessorSettings | list[PreprocessorSettings] | None = None#
- Validated by:
update_sharrow_skip
- field source_file_paths: list[Path] = None#
A list of source files from which these settings were loaded.
This value should not be set by the user within the YAML settings files, instead it is populated as those files are loaded. It is primarily provided for debugging purposes, and does not actually affect the operation of any model.
- Validated by:
update_sharrow_skip
- classmethod nests_are_for_nl(nests, values)#
Checks that nests are provided if (and only if) LOGIT_TYPE is NL.
- validator update_sharrow_skip » all fields#
Examples#
Implementation#
- activitysim.abm.models.atwork_subtour_mode_choice.atwork_subtour_mode_choice(state: State, tours: DataFrame, persons_merged: DataFrame, network_los: Network_LOS, model_settings: TourModeComponentSettings | None = None, model_settings_file_name: str = 'tour_mode_choice.yaml', trace_label: str = 'atwork_subtour_mode_choice') None #
At-work subtour mode choice simulate