biogeme.default_parameters module

Generation of the default parameter file and values

author:

Michel Bierlaire

date:

Wed Nov 30 10:14:35 2022

IMPORTANT: when only one “check” function is provided, do not forget to insert a comma at the end, before the closing parenthesis for the tuple. See https://www.w3schools.com/python/gloss_python_tuple_one_item.asp

class biogeme.default_parameters.ParameterTuple(name, value, type, section, description, check)

Bases: NamedTuple

Parameters:

• name (str)

• value (bool | int | float | str)

• type (Type)

• section (str)

• description (str)

• check (tuple[Callable[[bool | int | float | str], tuple[bool, str | None]], ...])

check: tuple[Callable[[bool | int | float | str], tuple[bool, str | None]], ...]

Alias for field number 5

description: str

Alias for field number 4

name: str

Alias for field number 0

section: str

Alias for field number 3

type: Type

Alias for field number 2

value: bool | int | float | str

Alias for field number 1

biogeme.default_parameters.all_parameters_tuple()

Return type:

tuple[ParameterTuple, ...]