.. _f-sklearntransforminv:

module ``mlmodel.sklearn_transform_inv``
========================================





.. inheritance-diagram:: mlinsights.mlmodel.sklearn_transform_inv


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

module ``mlinsights.mlmodel.sklearn_transform_inv``

Implements a base class which defines a pair of transforms
applied around a predictor to modify the target as well.


:githublink:`%|py|6`




Classes
+++++++

+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                   | truncated documentation                                                                                                      |
+=========================================================================================================+==============================================================================================================================+
| :class:`BaseReciprocalTransformer <mlinsights.mlmodel.sklearn_transform_inv.BaseReciprocalTransformer>` | Base for transform which transforms the features and the targets at the same time. It must also return another transform ... |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| property                                                                                                | truncated documentation                                                                                          |
+=========================================================================================================+==================================================================================================================+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.sklearn_transform_inv.BaseReciprocalTransformer._repr_html_>` | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+---------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| method                                                                                               | truncated documentation                                                 |
+======================================================================================================+=========================================================================+
| :py:meth:`__init__ <mlinsights.mlmodel.sklearn_transform_inv.BaseReciprocalTransformer.__init__>`    |                                                                         |
+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`get_fct_inv <mlinsights.mlmodel.sklearn_transform_inv.BaseReciprocalTransformer.get_fct_inv>` | Returns a trained transform which reverse the target after a predictor. |
+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`transform <mlinsights.mlmodel.sklearn_transform_inv.BaseReciprocalTransformer.transform>`     | Transforms *X* and *y*. Returns transformed *X* and *y*.                |
+------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+


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

.. automodule:: mlinsights.mlmodel.sklearn_transform_inv
    :members:
    :special-members: __init__
    :show-inheritance: