.. _metrics:

.. currentmodule:: scikitplot.metrics

=============
Metrics
=============

This module contains functions related to metrics.



.. _plot_precision_recall:

plot precision recall
-----------------------------

:func:`~scikitplot.metrics.plot_precision_recall`

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

.. rubric:: Examples

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


.. dropdown:: References

  * `"scikit-learn precision-recall"
    <https://scikit-learn.org/stable/auto_examples/model_selection/plot_precision_recall.html#precision-recall>`_.



.. _plot_roc:

plot roc
-----------------------------

:func:`~scikitplot.metrics.plot_roc`

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

.. rubric:: Examples

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


.. dropdown:: References

  * `"scikit-learn roc"
    <https://scikit-learn.org/stable/auto_examples/model_selection/plot_roc.html>`_.



.. _plot_calibration_curve:

plot calibration curve
-----------------------------

:func:`~scikitplot.metrics.plot_calibration_curve`

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

.. rubric:: Examples

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


.. dropdown:: References

  * `"scikit-learn PCA"
    <https://scikit-learn.org/stable/auto_examples/calibration/index.html#calibration>`_.