.. _f-sklearnbasetransform:

module ``sklapi.sklearn_base_transform``
========================================





.. inheritance-diagram:: mlinsights.sklapi.sklearn_base_transform


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

module ``mlinsights.sklapi.sklearn_base_transform``

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


:githublink:`%|py|7`




Classes
+++++++

+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+
| class                                                                               | truncated documentation                                                     |
+=====================================================================================+=============================================================================+
| :class:`SkBaseTransform <mlinsights.sklapi.sklearn_base_transform.SkBaseTransform>` | Pattern of a *learner* which follows the same API que :epkg:`scikit-learn`. |
+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+










Methods
+++++++

+------------------------------------------------------------------------------------------------+---------------------------------+
| method                                                                                         | truncated documentation         |
+================================================================================================+=================================+
| :py:meth:`__init__ <mlinsights.sklapi.sklearn_base_transform.SkBaseTransform.__init__>`        | Stores the parameters.          |
+------------------------------------------------------------------------------------------------+---------------------------------+
| :meth:`fit <mlinsights.sklapi.sklearn_base_transform.SkBaseTransform.fit>`                     | Trains a model.                 |
+------------------------------------------------------------------------------------------------+---------------------------------+
| :meth:`fit_transform <mlinsights.sklapi.sklearn_base_transform.SkBaseTransform.fit_transform>` | Trains and transforms the data. |
+------------------------------------------------------------------------------------------------+---------------------------------+
| :meth:`transform <mlinsights.sklapi.sklearn_base_transform.SkBaseTransform.transform>`         | Transforms the data.            |
+------------------------------------------------------------------------------------------------+---------------------------------+


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

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