leaspy.models.settings

Classes

ModelSettings

Used in models.base.load to create a model class object from a json file.

Module Contents

class ModelSettings(path_to_model_settings_or_dict)

Used in models.base.load to create a model class object from a json file.

Parameters:

path_to_model_settings_or_dictdict or str

• If a str: path to a json file containing model settings

• If a dict: content of model settings

Attributes:

namestr

The model’s name.

parametersKwargsType

The model’s parameters.

hyperparametersKwargsType

The model’s hyperparameters.

Raises:

LeaspyModelInputError

If the provided settings are not valid or if the file cannot be read.

Parameters:

path_to_model_settings_or_dict (Union[str, dict])

name: str

parameters: leaspy.utils.typing.KwargsType

hyperparameters: leaspy.utils.typing.KwargsType