leaspy.models.settings
======================

.. py:module:: leaspy.models.settings


Classes
-------

.. autoapisummary::

   leaspy.models.settings.ModelSettings


Module Contents
---------------

.. py: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_dict** : :obj:`dict` or :obj:`str`
           * If a str: path to a json file containing model settings
           * If a dict: content of model settings

   :Attributes:

       **name** : :obj:`str`
           The model's name.

       **parameters** : :obj:`KwargsType`
           The model's parameters.

       **hyperparameters** : :obj:`KwargsType`
           The model's hyperparameters.






   :Raises:

       :exc:`.LeaspyModelInputError`
           If the provided settings are not valid or if the file cannot be read.







   ..
       !! processed by numpydoc !!

   .. py:attribute:: name
      :type:  str


   .. py:attribute:: parameters
      :type:  leaspy.utils.typing.KwargsType


   .. py:attribute:: dataset_info
      :type:  dict


   .. py:attribute:: training_info
      :type:  dict


   .. py:attribute:: hyperparameters
      :type:  leaspy.utils.typing.KwargsType