.. _f-sklearntransforminvfct:

module ``mlmodel.sklearn_transform_inv_fct``
============================================





.. inheritance-diagram:: mlinsights.mlmodel.sklearn_transform_inv_fct


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

module ``mlinsights.mlmodel.sklearn_transform_inv_fct``

Implements a transform which modifies the target
and applies the reverse transformation on the target.


:githublink:`%|py|6`




Classes
+++++++

+---------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                                     | truncated documentation                                                                                                |
+===========================================================================================================================+========================================================================================================================+
| :class:`FunctionReciprocalTransformer <mlinsights.mlmodel.sklearn_transform_inv_fct.FunctionReciprocalTransformer>`       | The transform is used to apply a function on a the target, predict, then transform the target back before scoring. ... |
+---------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :class:`PermutationReciprocalTransformer <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer>` | The transform is used to permute targets, predict, then permute the target back before scoring. nan values remain ...  |
+---------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

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




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

+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
| staticmethod                                                                                                       | truncated documentation                   |
+====================================================================================================================+===========================================+
| :meth:`available_fcts <mlinsights.mlmodel.sklearn_transform_inv_fct.FunctionReciprocalTransformer.available_fcts>` | Returns the list of predefined functions. |
+--------------------------------------------------------------------------------------------------------------------+-------------------------------------------+




Methods
+++++++

+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| method                                                                                                                       | truncated documentation                                                                                 |
+==============================================================================================================================+=========================================================================================================+
| :py:meth:`__init__ <mlinsights.mlmodel.sklearn_transform_inv_fct.FunctionReciprocalTransformer.__init__>`                    |                                                                                                         |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer.__init__>`                 |                                                                                                         |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :py:meth:`_check_is_fitted <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer._check_is_fitted>` |                                                                                                         |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :py:meth:`_find_closest <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer._find_closest>`       |                                                                                                         |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.mlmodel.sklearn_transform_inv_fct.FunctionReciprocalTransformer.fit>`                                 | Just defines *fct* and *fct_inv*.                                                                       |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer.fit>`                              | Defines a random permutation over the targets.                                                          |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :meth:`get_fct_inv <mlinsights.mlmodel.sklearn_transform_inv_fct.FunctionReciprocalTransformer.get_fct_inv>`                 | Returns a trained transform which reverse the target after a predictor.                                 |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :meth:`get_fct_inv <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer.get_fct_inv>`              | Returns a trained transform which reverse the target after a predictor.                                 |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :meth:`transform <mlinsights.mlmodel.sklearn_transform_inv_fct.FunctionReciprocalTransformer.transform>`                     | Transforms *X* and *y*. Returns transformed *X* and *y*. If *y* is None, the returned value for *y* ... |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| :meth:`transform <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer.transform>`                  | Transforms *X* and *y*. Returns transformed *X* and *y*. If *y* is None, the returned value for *y* ... |
+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+


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

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