Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Ensure plot_det_curve passes numpydoc validation #24334

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 3, 2022
Merged

DOC Ensure plot_det_curve passes numpydoc validation #24334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d00df5b
fix docstring
maikia Sep 2, 2022
cc1ca41
cleanup
maikia Sep 2, 2022
14f320e
Merge branch 'main' into plot_det_curve_doc
glemaitre Sep 3, 2022
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
12 changes: 6 additions & 6 deletions sklearn/metrics/_plot/det_curve.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,18 +370,18 @@ def plot_det_curve(
):
"""Plot detection error tradeoff (DET) curve.

Extra keyword arguments will be passed to matplotlib's `plot`.

Read more in the :ref:`User Guide <visualizations>`.

.. versionadded:: 0.24

.. deprecated:: 1.0
`plot_det_curve` is deprecated in 1.0 and will be removed in
1.2. Use one of the following class methods:
:func:`~sklearn.metrics.DetCurveDisplay.from_predictions` or
:func:`~sklearn.metrics.DetCurveDisplay.from_estimator`.

Extra keyword arguments will be passed to matplotlib's `plot`.

Read more in the :ref:`User Guide <visualizations>`.

.. versionadded:: 0.24

Parameters
----------
estimator : estimator instance
Expand Down
2 changes: 2 additions & 0 deletions sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
"sklearn.decomposition._dict_learning.dict_learning",
"sklearn.externals._packaging.version.parse",
"sklearn.inspection._plot.partial_dependence.plot_partial_dependence",
# sklearn.deprecation._update_doc is updating the doc against the numpydoc.
# This will be fixed with issue: #24328
"sklearn.metrics._plot.det_curve.plot_det_curve",
"sklearn.metrics._plot.precision_recall_curve.plot_precision_recall_curve",
"sklearn.metrics._ranking.dcg_score",
Expand Down