leaspy.models.settings

Classes

ModelSettings

Used in Leaspy.load() to create a Leaspy class object from a json file.

Module Contents

class ModelSettings(path_to_model_settings_or_dict)

Used in Leaspy.load() to create a Leaspy 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

Raises:

LeaspyModelInputError

Parameters:

path_to_model_settings_or_dict (Union[str, dict])

name: str

parameters: leaspy.utils.typing.KwargsType

hyperparameters: leaspy.utils.typing.KwargsType