baohan
/
scikit-learn
mirror of https://github.com/scikit-learn/scikit-learn.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DOC Ensure plot_det_curve passes numpydoc validation (#24334)

This commit is contained in:
Maria Telenczuk 2022-09-03 10:53:15 +02:00 committed by GitHub
parent bc40e30b64
commit 37e2ffd7a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sklearn/metrics/_plot/det_curve.py
View File

@ -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

2
sklearn/tests/test_docstrings.py
View File

@ -15,6 +15,8 @@ FUNCTION_DOCSTRING_IGNORE_LIST = [
"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",