Skip to content

DOC ADD Link PrecisionRecallDisplay to both visualization and evaluat… #31308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion sklearn/metrics/_plot/precision_recall_curve.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ class PrecisionRecallDisplay(_BinaryClassifierCurveDisplayMixin):
a :class:`~sklearn.metrics.PrecisionRecallDisplay`. All parameters are
stored as attributes.

Read more in the :ref:`User Guide <visualizations>`.
For general information regarding `scikit-learn` visualization tools, see
the :ref:`Visualization Guide <visualizations>`.
For guidance on interpreting these plots, refer to the :ref:`Model
Evaluation Guide <precision_recall_f_measure_metrics>`.

Parameters
----------
Expand Down Expand Up @@ -276,6 +279,11 @@ def from_estimator(
):
"""Plot precision-recall curve given an estimator and some data.

For general information regarding `scikit-learn` visualization tools, see
the :ref:`Visualization Guide <visualizations>`.
For guidance on interpreting these plots, refer to the :ref:`Model
Evaluation Guide <precision_recall_f_measure_metrics>`.

Parameters
----------
estimator : estimator instance
Expand Down Expand Up @@ -416,6 +424,11 @@ def from_predictions(
):
"""Plot precision-recall curve given binary class predictions.

For general information regarding `scikit-learn` visualization tools, see
the :ref:`Visualization Guide <visualizations>`.
For guidance on interpreting these plots, refer to the :ref:`Model
Evaluation Guide <precision_recall_f_measure_metrics>`.

Parameters
----------
y_true : array-like of shape (n_samples,)
Expand Down