.. _f-targetpredictors:

module ``mlmodel.target_predictors``
====================================





.. inheritance-diagram:: mlinsights.mlmodel.target_predictors


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

module ``mlinsights.mlmodel.target_predictors``

Implements a slightly different
version of the :epkg:`sklearn:compose:TransformedTargetRegressor`.


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                     | truncated documentation                                                                                                  |
+===========================================================================================================+==========================================================================================================================+
| :class:`TransformedTargetClassifier2 <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2>` | Meta-estimator to classify on a transformed target. Useful for applying permutation transformation in classification ... |
+-----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :class:`TransformedTargetRegressor2 <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2>`   | Meta-estimator to regress on a transformed target. Useful for applying a non-linear transformation in regression ...     |
+-----------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+--------------------------------------------------------------------------------------------+-------------------------+
| function                                                                                   | truncated documentation |
+============================================================================================+=========================+
| :func:`_common_get_transform <mlinsights.mlmodel.target_predictors._common_get_transform>` |                         |
+--------------------------------------------------------------------------------------------+-------------------------+




Properties
++++++++++

+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| property                                                                                               | truncated documentation                                                                                          |
+========================================================================================================+==================================================================================================================+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2._repr_html_>` | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2._repr_html_>`  | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`classes_ <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.classes_>`          | Returns the classes.                                                                                             |
+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| method                                                                                                           | truncated documentation                                                                              |
+==================================================================================================================+======================================================================================================+
| :py:meth:`__init__ <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.__init__>`                 |                                                                                                      |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2.__init__>`                  |                                                                                                      |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :py:meth:`_apply <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2._apply>`                     | Calls *predict*, *predict_proba* or *decision_function* using the base classifier, applying inverse. |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :py:meth:`_check_is_fitted <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2._check_is_fitted>` |                                                                                                      |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :py:meth:`_more_tags <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2._more_tags>`             |                                                                                                      |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :py:meth:`_more_tags <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2._more_tags>`              |                                                                                                      |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`decision_function <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.decision_function>`  | Predicts using the base classifier, applying inverse.                                                |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.fit>`                              | Fits the model according to the given training data.                                                 |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2.fit>`                               | Fits the model according to the given training data.                                                 |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`predict <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.predict>`                      | Predicts using the base classifier, applying inverse.                                                |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`predict <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2.predict>`                       | Predicts using the base regressor, applying inverse.                                                 |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`predict_proba <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.predict_proba>`          | Predicts using the base classifier, applying inverse.                                                |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`score <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.score>`                          | Scores the model with :epkg:`sklearn:metrics:accuracy_score`.                                        |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+
| :meth:`score <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2.score>`                           | Scores the model with :epkg:`sklearn:metrics:r2_score`.                                              |
+------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+


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

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