.. _f-sklearnbase:

module ``sklapi.sklearn_base``
==============================





.. inheritance-diagram:: mlinsights.sklapi.sklearn_base


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

module ``mlinsights.sklapi.sklearn_base``

Implements a *learner* or a *transform* which follows the same API
as every :epkg:`scikit-learn` transform.


:githublink:`%|py|7`




Classes
+++++++

+---------------------------------------------------------+----------------------------------------------------------------------------------------+
| class                                                   | truncated documentation                                                                |
+=========================================================+========================================================================================+
| :class:`SkBase <mlinsights.sklapi.sklearn_base.SkBase>` | Pattern of a *learner* or a *transform* which follows the API of :epkg:`scikit-learn`. |
+---------------------------------------------------------+----------------------------------------------------------------------------------------+








Static Methods
++++++++++++++

+-------------------------------------------------------------------------------+----------------------------------+
| staticmethod                                                                  | truncated documentation          |
+===============================================================================+==================================+
| :meth:`compare_params <mlinsights.sklapi.sklearn_base.SkBase.compare_params>` | Compares two sets of parameters. |
+-------------------------------------------------------------------------------+----------------------------------+




Methods
+++++++

+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| method                                                                      | truncated documentation                                                                                           |
+=============================================================================+===================================================================================================================+
| :py:meth:`__eq__ <mlinsights.sklapi.sklearn_base.SkBase.__eq__>`            | Compares two objects, more precisely, compares the parameters which define the object.                            |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mlinsights.sklapi.sklearn_base.SkBase.__init__>`        | Stores the parameters, see :class:`SkLearnParameters`, it keeps a copy of the parameters to easily implements ... |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <mlinsights.sklapi.sklearn_base.SkBase.__repr__>`        | usual                                                                                                             |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.sklapi.sklearn_base.SkBase.fit>`                     | Trains a model.                                                                                                   |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :meth:`get_params <mlinsights.sklapi.sklearn_base.SkBase.get_params>`       | Returns the parameters which define the objet, all are needed to clone the object.                                |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :meth:`set_params <mlinsights.sklapi.sklearn_base.SkBase.set_params>`       | Udpates parameters which define the object, all needed to clone the object.                                       |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :meth:`test_equality <mlinsights.sklapi.sklearn_base.SkBase.test_equality>` | Compares two objects and checks parameters have the same values.                                                  |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+


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

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