biogeme.catalog.specification module

Model specification in a multiple expression context

Michel Bierlaire Sat Jun 28 2025, 12:13:22

Implements a model specification in a multiple expression context (using Catalogs)

class biogeme.catalog.specification.Specification(configuration)

Bases: object

Implements a specification

Parameters:

configuration (Configuration)

all_results: dict[slice(<class 'str'>, <class 'biogeme.results_processing.estimation_results.EstimationResults'>, None)] = {}

central_controller: CentralController | None = None

function that generates all the objectives: fct(bioResults) -> list[floatNone]

property config_id: str

Defined config_id as a property

configure_expression()

Configure the expression to the current configuration

Return type:

None

database: Database | None = None

biogeme.database.Database object

classmethod default_specification()

Alternative constructor for generate the default specification

Return type:

Specification

describe()

Short description of the solution. Used for reporting.

Returns:

short description of the solution.

Return type:

str

classmethod from_string_id(configuration_id)

Constructor using a configuration

Parameters:

configuration_id (str)

generic_name = 'default_name'

short name for file names

get_element(multi_objectives)

Obtains the element from the Pareto set corresponding to a specification

Parameters:

multi_objectives (Callable[[EstimationResults | None], list[float]]) – function calculating the objectives from the estimation results

Returns:

element from the Pareto set

Return type:

SetElement

get_results()

Obtain the estimation results of the specification

Return type:

EstimationResults

maximum_number_parameters: int = 50

model_names: ModelNames | None = None

user_defined_validity_check = None

function that checks the validity of the results