euromod.calibrate¶

Below are listed the main public classes of the euromod.calibrate module.

**Classes**¶
`Calibration`	-

**Function**¶
`calibrate_function`(system, data, dataset_id, target_variable, base, functional_form, group_filters, constantsToOverwrite)	“

**Attributes**¶
`model_path`	-

class euromod.calibrate.Calibration(model_version, system: str, dataset_id: str, functional_form: sympy.Expr, data_vars: List[str], parameter_vars: List[str], estimates: Dict[str, Dict[str, float]], target_variable, constantsToOverwrite: dict = {})¶

Overview

Attributes¶
`base_lambda`	-
`constantsToOverwrite`	-
`data_vars`	-
`dataset_id`	-
`estimates`	-
`functional_form`	-
`group_lambdas`	-
`model_version`	-
`parameter_vars`	-
`pretty_function`	-
`system`	-
`target_variable`	-

Methods¶
`evaluate`(system, output_data, target_variable, group_filters, dataset_id)	Compare fitted vs actual target values per group.
`from_json`(system, path)	:summarylabel:`static` -
`get_estimates`()	-
`get_value_function`(group_key, data)	-
`to_json`(path)	-

Attributes

base_lambda¶

constantsToOverwrite¶

data_vars¶

dataset_id¶

estimates¶

functional_form¶

group_lambdas¶

model_version¶

parameter_vars¶

pretty_function¶

system¶

target_variable¶

Methods

evaluate(system: core.System, output_data: polars.DataFrame, target_variable: str, group_filters: dict[str, polars.Expr] | None = None, dataset_id: str | None = None) → tuple[polars.DataFrame, polars.DataFrame]¶: Compare fitted vs actual target values per group. Returns (metrics_df, comparison_df).

static from_json(system: core.System, path: str)¶

get_estimates()¶

get_value_function(group_key: str, data: Dict[str, numpy.ndarray])¶

to_json(path: str)¶

Functions¶

euromod.calibrate.calibrate_function(system, data, dataset_id, target_variable, base, functional_form: sympy.Expr, group_filters: dict[str, polars.Expr] = {}, constantsToOverwrite: dict = {})¶: ” Calibrate the functional form for the specified dataset and target variable.

Attributes¶

euromod.calibrate.model_path = 'R:\\B2\\04 - EUROMOD JRC\\06 - Working area\\01 - Common\\15 - Release...¶