LogitNestSpec

settings activitysim.core.configuration.logit.LogitNestSpec

Bases: BaseModel

Defines a nest in a nested logit model.

Fields:

• alternatives (list[activitysim.core.configuration.logit.LogitNestSpec | str])

• coefficient (str | float)

• name (str)

Validators:

• prefer_float_to_str » coefficient

field alternatives: list[LogitNestSpec | str] [Required]

The alternatives within this nest.

These can be either the names of elemental alternatives, or LogitNestSpec definitions for more nests, or a mixture of these.

field coefficient: str | float [Required]

The named parameter to be used as the logsum coefficient.

If given as a string, this named parameter should appear in the logit models’s COEFFICIENTS file.

Validated by:

• prefer_float_to_str

field name: str [Required]

A descriptive name for this nest.

validator prefer_float_to_str  »  coefficient

Convert string values to float directly if possible.