.. _f-quantileregression:

module ``mlmodel.quantile_regression``
======================================





.. inheritance-diagram:: mlinsights.mlmodel.quantile_regression


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

module ``mlinsights.mlmodel.quantile_regression``

Implements a quantile linear regression.


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                               | truncated documentation                                                                                                                                    |
+=====================================================================================================+============================================================================================================================================================+
| :class:`QuantileLinearRegression <mlinsights.mlmodel.quantile_regression.QuantileLinearRegression>` | Quantile Linear Regression or linear regression trained with norm :epkg:`L1`. This class inherits from :epkg:`sklearn:linear_models:LinearRegression`. ... |
+-----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

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




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

+------------------------------------------------------------------------------------------------+-------------------------+
| staticmethod                                                                                   | truncated documentation |
+================================================================================================+=========================+
| :py:meth:`_epsilon <mlinsights.mlmodel.quantile_regression.QuantileLinearRegression._epsilon>` |                         |
+------------------------------------------------------------------------------------------------+-------------------------+




Methods
+++++++

+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| method                                                                                         | truncated documentation                                                                                       |
+================================================================================================+===============================================================================================================+
| :py:meth:`__init__ <mlinsights.mlmodel.quantile_regression.QuantileLinearRegression.__init__>` |                                                                                                               |
+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`fit <mlinsights.mlmodel.quantile_regression.QuantileLinearRegression.fit>`              | Fits a linear model with :epkg:`L1` norm which is equivalent to a quantile regression. The implementation ... |
+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`score <mlinsights.mlmodel.quantile_regression.QuantileLinearRegression.score>`          | Returns Mean absolute error regression loss.                                                                  |
+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+


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

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