macrostat.models.ECO3IOPC.ParametersECO3IOPC#

class macrostat.models.ECO3IOPC.ParametersECO3IOPC(parameters: dict | None = None, hyperparameters: dict | None = None, bounds: dict | None = None, *args, **kwargs)[source]#

Bases: Parameters

Parameters class for the ECO-3IO-PC model.

__init__(parameters: dict | None = None, hyperparameters: dict | None = None, bounds: dict | None = None, *args, **kwargs)[source]#

Initialize the parameters of Marco Veronese Passarella’s ECO-3IO-PC model

Parameters:

  • parameters (dict | None) – The parameters of the model.

  • hyperparameters (dict | None) – The hyperparameters of the model.

  • bounds (dict | None) – The bounds of the parameters.

Methods

__init__([parameters, hyperparameters, bounds])

Initialize the parameters of Marco Veronese Passarella's ECO-3IO-PC model

from_csv(file_path, *args, **kwargs)

Initialize the parameters from a CSV file.

from_excel(file_path, *args, **kwargs)

Initialize the parameters from an Excel file.

from_json(file_path, *args, **kwargs)

Initialize the parameters from a JSON file.

get_bounds()

Return the bounds for the parameters.

get_default_hyperparameters()

Return the default hyperparameter values.

get_default_parameters()

Return the default parameter values.

get_values()

Return the values for the parameters.

is_equal(other)

Compare the parameters to another Parameters object.

set_bound(key, value)

Set the bounds for a single parameter

set_notation(key, value)

Set the notation for a single parameter.

set_unit(key, value)

Set the unit for a single parameter.

to_csv(file_path[, sphinx_math])

Convert the parameters to a CSV file.

to_excel(file_path, *args, **kwargs)

Convert the parameters to an Excel file.

to_json(file_path, *args, **kwargs)

Convert the parameters to a JSON file.

to_nn_parameters()

Convert the parameters to a nn.ParameterDict.

vectorize_parameters()

Vectorize the parameters.

verify_bounds()

Verify that the bounds are valid.

verify_parameters()

Verify that the parameters are within the bounds.

Attributes

version

get_default_hyperparameters()[source]#

Return the default hyperparameter values.

get_default_parameters()[source]#

Return the default parameter values.

version = 'ECO3IOPC'#