.. _deciles:

.. currentmodule:: scikitplot.deciles

=============
Deciles
=============

This module contains functions related to deciles.



.. _deciles_plot_cumulative_gain:

plot cumulative gain
---------------------

:func:`~scikitplot.deciles.plot_cumulative_gain`

The mathematical formulation is the following:

.. math::

    \hat{K}

Trained model of :class:`~sklearn.linear_model.LogisticRegression` and
:class:`~sklearn.ensemble.RandomForestClassifier`. For an example of
performing image:

.. rubric:: Examples

* :ref:`sphx_glr_auto_examples_deciles_plot_cumulative_gain_script.py`: Example usage of
  :class:`~sklearn.linear_model.LogisticRegression` using the iris dataset

* :ref:`sphx_glr_auto_examples_deciles_plot_cumulative_gain_script.py`: Example usage of
  :class:`~sklearn.ensemble.RandomForestClassifier` using the iris dataset


.. dropdown:: References

  * cumulative_gain



.. _deciles_plot_lift:

plot lift
---------------------

:func:`~scikitplot.deciles.plot_lift`

.. note:: **Lift Curve**

Trained model of :class:`~sklearn.linear_model.LogisticRegression` and
:class:`~sklearn.ensemble.RandomForestClassifier`. For an example of
performing image:

.. rubric:: Examples

* :ref:`sphx_glr_auto_examples_deciles_plot_lift_script.py`: Example usage of
  :class:`~sklearn.linear_model.LogisticRegression` using the iris dataset

* :ref:`sphx_glr_auto_examples_deciles_plot_lift_script.py`: Example usage of
  :class:`~sklearn.ensemble.RandomForestClassifier` using the iris dataset


.. dropdown:: References

  * lift_curve



.. _deciles_plot_ks_statistic:

plot_ks_statistic
---------------------

:func:`~scikitplot.deciles.plot_ks_statistic`

Trained model of :class:`~sklearn.linear_model.LogisticRegression` and
:class:`~sklearn.ensemble.RandomForestClassifier`. For an example of
performing image:

.. rubric:: Examples

* :ref:`sphx_glr_auto_examples_deciles_plot_ks_statistic_script.py`: Example usage of
  :class:`~sklearn.linear_model.LogisticRegression` using the iris dataset

* :ref:`sphx_glr_auto_examples_deciles_plot_ks_statistic_script.py`: Example usage of
  :class:`~sklearn.ensemble.RandomForestClassifier` using the iris dataset


.. dropdown:: References

  * ks_statistic