.. _f-sklearnparameters:

module ``sklapi.sklearn_parameters``
====================================





.. inheritance-diagram:: mlinsights.sklapi.sklearn_parameters


Short summary
+++++++++++++

module ``mlinsights.sklapi.sklearn_parameters``

Defines class :class:`SkLearnParameters`.


:githublink:`%|py|6`




Classes
+++++++

+-------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| class                                                                               | truncated documentation                                              |
+=====================================================================================+======================================================================+
| :class:`SkException <mlinsights.sklapi.sklearn_parameters.SkException>`             | custom exception                                                     |
+-------------------------------------------------------------------------------------+----------------------------------------------------------------------+
| :class:`SkLearnParameters <mlinsights.sklapi.sklearn_parameters.SkLearnParameters>` | Defines a class to store parameters of a *learner* or a *transform*. |
+-------------------------------------------------------------------------------------+----------------------------------------------------------------------+






Properties
++++++++++

+----------------------------------------------------------------------------+--------------------------+
| property                                                                   | truncated documentation  |
+============================================================================+==========================+
| :meth:`Keys <mlinsights.sklapi.sklearn_parameters.SkLearnParameters.Keys>` | Returns parameter names. |
+----------------------------------------------------------------------------+--------------------------+






Methods
+++++++

+---------------------------------------------------------------------------------------+---------------------------------------------------+
| method                                                                                | truncated documentation                           |
+=======================================================================================+===================================================+
| :py:meth:`__init__ <mlinsights.sklapi.sklearn_parameters.SkLearnParameters.__init__>` | Stores parameters as members of the class itself. |
+---------------------------------------------------------------------------------------+---------------------------------------------------+
| :py:meth:`__repr__ <mlinsights.sklapi.sklearn_parameters.SkLearnParameters.__repr__>` | usual                                             |
+---------------------------------------------------------------------------------------+---------------------------------------------------+
| :meth:`to_dict <mlinsights.sklapi.sklearn_parameters.SkLearnParameters.to_dict>`      | Returns parameters as a dictionary.               |
+---------------------------------------------------------------------------------------+---------------------------------------------------+
| :meth:`validate <mlinsights.sklapi.sklearn_parameters.SkLearnParameters.validate>`    | Verifies a parameter and its value.               |
+---------------------------------------------------------------------------------------+---------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: mlinsights.sklapi.sklearn_parameters
    :members:
    :special-members: __init__
    :show-inheritance: