.. _f-sklearnbasetransformlearner:

module ``sklapi.sklearn_base_transform_learner``
================================================





.. inheritance-diagram:: mlinsights.sklapi.sklearn_base_transform_learner


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

module ``mlinsights.sklapi.sklearn_base_transform_learner``

Implements a *transform* which converts a *learner* into
a *transform*.


:githublink:`%|py|0`




Classes
+++++++

+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| class                                                                                                     | truncated documentation                                                                                              |
+===========================================================================================================+======================================================================================================================+
| :class:`SkBaseTransformLearner <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner>` | A *transform* which hides a *learner*, it converts method *predict* into *transform*. This way, two learners can ... |
+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| method                                                                                                       | truncated documentation                                             |
+==============================================================================================================+=====================================================================+
| :py:meth:`__init__ <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner.__init__>`       |                                                                     |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :py:meth:`__repr__ <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner.__repr__>`       | usual                                                               |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :py:meth:`_set_method <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner._set_method>` | Defines the method to use to convert the features into predictions. |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`fit <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner.fit>`                    | Trains a model.                                                     |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`get_params <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner.get_params>`      | Returns the parameters mandatory to clone the class.                |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`set_params <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner.set_params>`      | Sets parameters.                                                    |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`transform <mlinsights.sklapi.sklearn_base_transform_learner.SkBaseTransformLearner.transform>`        | Predictions, output of the embedded learner.                        |
+--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+


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

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