biogeme.expressions.prepare_for_panel module¶
- class biogeme.expressions.prepare_for_panel.PanelColumnSetting(panel_column)[source]¶
Bases:
NamedTuple- Parameters:
panel_column (str)
-
panel_column:
str¶ Alias for field number 0
- biogeme.expressions.prepare_for_panel.panel_column_handler(expr, context)[source]¶
- Return type:
None- Parameters:
expr (DistributedParameter)
context (dict)
- biogeme.expressions.prepare_for_panel.prepare_for_panel(expr, panel_column)[source]¶
- Return type:
None- Parameters:
expr (Expression)
panel_column (str)
- biogeme.expressions.prepare_for_panel.set_draw_dimension_for_all_draws(expr, mode)[source]¶
Sets the draw dimension for all Draws expressions inside expr.
- Parameters:
expr – Root expression of the model.
mode (
Literal['observation','individual']) – {“observation”, “individual”} Whether draws should be generated per observation or per individual.
- Return type:
int- Returns:
Number of Draws expressions updated.
- biogeme.expressions.prepare_for_panel.set_draw_dimension_handler(expr, context)[source]¶
- Return type:
None- Parameters:
expr (Draws)
context (dict)
- biogeme.expressions.prepare_for_panel.set_panel_column_on_distributed_parameters(expr, panel_column)[source]¶
Sets panel_column on all DistributedParameter nodes in expr.
- Parameters:
expr (
Expression) – Root expression.panel_column (
str) – Name of the panel id column in the dataframe.
- Return type:
int- Returns:
Number of DistributedParameter nodes updated.