Specification

Model specification in a multiple expression context.

biogeme.specification module

Model specification in a multiple expression context

author:

Michel Bierlaire

date:

Mon Apr 10 12:33:18 2023

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

class biogeme.specification.Specification(configuration)

Bases: object

Implements a specification

__init__(configuration)

Creates a specification from a configuration

Parameters:

configuration (Configuration) – configuration of the multiple expression

all_results = {}

dict(str: biogeme.results.bioResults)

property config_id

Defined config_id as a property

configure_expression()

Configure the expression to the current configuration

database = None

biogeme.database.Database object

classmethod default_specification()

Alternative constructor for generate the default specification

describe()

Short description of the solution. Used for reporting.

Returns:

short description of the solution.

Return type:

str

expression = None

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

classmethod from_string_id(configuration_id)

Constructor using a configuration

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 (fct(bioResults) --> list[float]) – function calculating the objectives from the estimation results

Returns:

element from the Pareto set

Return type:

biogeme.pareto.SetElement

get_results()

Obtain the estimation results of the specification

user_defined_validity_check = None

function that checks the validity of the results