biogeme.latent_variables.resolved module

class biogeme.latent_variables.resolved.CutpointKind(*values)

Bases: str, Enum

DERIVED = 'derived'

FIXED = 'fixed'

FREE = 'free'

class biogeme.latent_variables.resolved.MeasurementErrorDistribution(*values)

Bases: str, Enum

GAUSSIAN = 'gaussian'

LOGISTIC = 'logistic'

class biogeme.latent_variables.resolved.ParameterCreationKind(*values)

Bases: str, Enum

BOUNDED_BETA = 'bounded_beta'

FIXED_BETA = 'fixed_beta'

FREE_BETA = 'free_beta'

LOG_EXP_BETA = 'log_exp_beta'

NUMERIC_CONSTANT = 'numeric_constant'

class biogeme.latent_variables.resolved.ParameterRole(*values)

Bases: str, Enum

MEASUREMENT_INTERCEPT = 'measurement_intercept'

MEASUREMENT_LOADING = 'measurement_loading'

MEASUREMENT_SIGMA = 'measurement_sigma'

STRUCTURAL_COEFFICIENT = 'structural_coefficient'

STRUCTURAL_INTERCEPT = 'structural_intercept'

STRUCTURAL_SIGMA = 'structural_sigma'

THRESHOLD_DELTA = 'threshold_delta'

THRESHOLD_FIRST = 'threshold_first'

class biogeme.latent_variables.resolved.ParameterStatus(*values)

Bases: str, Enum

FIXED = 'fixed'

FREE = 'free'

class biogeme.latent_variables.resolved.PositivityStrategy(*values)

Bases: str, Enum

LOG_EXP = 'log_exp'

LOWER_BOUND = 'lower_bound'

NONE = 'none'

class biogeme.latent_variables.resolved.ResolvedConstant(value)

Bases: object

Parameters:

value (float)

class biogeme.latent_variables.resolved.ResolvedCutpoint(symbol_name, kind, expression_text, source_parameter_names)

Bases: object

Parameters:

• symbol_name (str)

• kind (CutpointKind)

• expression_text (str)

• source_parameter_names (list[str])

class biogeme.latent_variables.resolved.ResolvedIndicatorType(type_name, symmetric, categories, neutral_labels)

Bases: object

Resolved metadata shared by indicators of the same semantic type.

Parameters:

• type_name (str)

• symmetric (bool)

• categories (list[int])

• neutral_labels (list[int])

class biogeme.latent_variables.resolved.ResolvedLatentVariable(name, structural_equation, indicator_names, reference_indicator, normalization_notes)

Bases: object

Parameters:

• name (str)

• structural_equation (ResolvedStructuralEquation)

• indicator_names (list[str])

• reference_indicator (str | None)

• normalization_notes (list[str])

class biogeme.latent_variables.resolved.ResolvedLinearCombination(intercept, terms)

Bases: object

Parameters:

• intercept (ResolvedParameterRef | ResolvedConstant | None)

• terms (list[ResolvedLinearTerm])

class biogeme.latent_variables.resolved.ResolvedLinearTerm(coefficient, variable_name)

Bases: object

Parameters:

• coefficient (ResolvedParameterRef | ResolvedConstant)

• variable_name (str)

class biogeme.latent_variables.resolved.ResolvedMeasurementEquation(indicator_name, statement, type_name, measurement_model, systematic_part, sigma, observed_variable_name, threshold_system_name, error_distribution, normalization_notes)

Bases: object

Parameters:

• indicator_name (str)

• statement (str)

• type_name (str)

• measurement_model (MeasurementModel)

• systematic_part (ResolvedLinearCombination)

• sigma (ResolvedParameterRef | None)

• observed_variable_name (str)

• threshold_system_name (str | None)

• error_distribution (MeasurementErrorDistribution)

• normalization_notes (list[str])

class biogeme.latent_variables.resolved.ResolvedModel(metadata, latent_variables, measurement_equations, threshold_systems, parameters, normalization, indicator_types=<factory>)

Bases: object

Parameters:

• metadata (ResolvedModelMetadata)

• latent_variables (dict[str, ResolvedLatentVariable])

• measurement_equations (dict[str, ResolvedMeasurementEquation])

• threshold_systems (dict[str, ResolvedThresholdSystem])

• parameters (dict[str, ResolvedParameter])

• normalization (ResolvedNormalizationSummary)

• indicator_types (dict[str, ResolvedIndicatorType])

free_parameters()

Return the parameters that are estimated.

Fixed parameters and numeric constants are excluded because they do not appear in the estimation results. The order follows the insertion order of self.parameters.

Return type:

list[ResolvedParameter]

Returns:

list of free resolved parameters.

class biogeme.latent_variables.resolved.ResolvedModelMetadata(estimation_mode, measurement_models_present, has_gaussian, has_ordered_probit, has_ordered_logit, has_ordinal, n_latent_variables, n_indicators, n_threshold_systems)

Bases: object

Parameters:

• estimation_mode (EstimationMode)

• measurement_models_present (list[MeasurementModel])

• has_gaussian (bool)

• has_ordered_probit (bool)

• has_ordered_logit (bool)

• has_ordinal (bool)

• n_latent_variables (int)

• n_indicators (int)

• n_threshold_systems (int)

class biogeme.latent_variables.resolved.ResolvedNormalizationRule(scope, target_name, value, reason)

Bases: object

Parameters:

• scope (str)

• target_name (str)

• value (float | str)

• reason (str)

class biogeme.latent_variables.resolved.ResolvedNormalizationSummary(rules, warnings, disclaimer)

Bases: object

Parameters:

• rules (list[ResolvedNormalizationRule])

• warnings (list[str])

• disclaimer (str)

class biogeme.latent_variables.resolved.ResolvedParameter(semantic_ref, final_name, role, status, fixed_value, initial_value, lower_bound, upper_bound, positivity_strategy, creation_kind, notes=<factory>)

Bases: object

Parameters:

• semantic_ref (ParameterRef | None)

• final_name (str)

• role (ParameterRole)

• status (ParameterStatus)

• fixed_value (float | None)

• initial_value (float)

• lower_bound (float | None)

• upper_bound (float | None)

• positivity_strategy (PositivityStrategy | None)

• creation_kind (ParameterCreationKind)

• notes (list[str])

class biogeme.latent_variables.resolved.ResolvedParameterRef(final_name, semantic_ref=None)

Bases: object

Parameters:

• final_name (str)

• semantic_ref (ParameterRef | None)

class biogeme.latent_variables.resolved.ResolvedStructuralEquation(latent_name, expression_name, systematic_part, sigma, draw_name, draw_type, error_distribution)

Bases: object

Parameters:

• latent_name (str)

• expression_name (str)

• systematic_part (ResolvedLinearCombination)

• sigma (ResolvedParameterRef | None)

• draw_name (str)

• draw_type (str)

• error_distribution (str)

class biogeme.latent_variables.resolved.ResolvedThresholdSystem(type_name, symmetric, categories, neutral_labels, construction_kind, cutpoints, used_by_indicators, normalization_notes)

Bases: object

Parameters:

• type_name (str)

• symmetric (bool)

• categories (list[int])

• neutral_labels (list[int])

• construction_kind (ThresholdConstructionKind)

• cutpoints (list[ResolvedCutpoint])

• used_by_indicators (list[str])

• normalization_notes (list[str])

class biogeme.latent_variables.resolved.ThresholdConstructionKind(*values)

Bases: str, Enum

MONOTONE = 'monotone'

SYMMETRIC = 'symmetric'