.. _modelplotpy-index:

modelplotpy
======================================================================

This module contains functions related to :py:mod:`~.modelplotpy`.

The :py:mod:`~.modelplotpy` module to build nice plots to explain
your modelling efforts easily to business colleages.

.. seealso::

   * https://github.com/modelplot/modelplotpy/blob/master/modelplotpy/functions.py
   * https://modelplot.github.io/intro_modelplotpy.html


modelplotpy Plots
----------------------------------------------------------------------

* Let's introduce the Gains, Lift and (cumulative) Response plots.

.. _plot_response:

plot response
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_response`

.. rubric:: Examples

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



.. _plot_cumresponse:

plot cumresponse
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_cumresponse`

.. rubric:: Examples

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



.. _plot_cumlift:

plot cumlift
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_cumlift`

.. rubric:: Examples

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



.. _plot_cumgains:

plot cumgains
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_cumgains`

.. rubric:: Examples

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



.. plot_all:

plot all
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_all`

.. rubric:: Examples

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



.. _modelplotpy_financial-index:

modelplotpy financial
----------------------------------------------------------------------

.. _plot_costsrevs:

plot costsrevs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_costsrevs`

.. rubric:: Examples

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



.. plot_profit:

plot profit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_profit`

.. rubric:: Examples

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



.. plot_roi:

plot roi
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:py:func:`~.modelplotpy.plot_roi`

.. rubric:: Examples

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