Skip to content

DOC Ensures that sklearn.metrics._ranking.auc passes numpydoc validation #23433

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 8 commits into from
May 20, 2022
Merged

DOC Ensures that sklearn.metrics._ranking.auc passes numpydoc validation #23433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2638b1f
Remove img_to_graph from FUNCTION_DOCSTRING_IGNORE_LIST
boraxpr May 17, 2022
999961c
Fix SS03, PR09, RT01 at sklearn.feature_extraction.image.img_to_graph
boraxpr May 17, 2022
6cfd031
Apply suggestions from code review
boraxpr May 17, 2022
0b32ae5
Merge branch 'main' into main
boraxpr May 17, 2022
c59161f
Remove sklearn.metrics._ranking.auc from FUNCTION_DOCSTRING_IGNORE_LIST
boraxpr May 20, 2022
a568268
Merge branch 'main' of https://github.com/boraxpr/scikit-learn
boraxpr May 20, 2022
6b67c1c
Fix PR08,RT03 sklearn.metrics._ranking.auc
boraxpr May 20, 2022
3f49b31
Merge branch 'scikit-learn:main' into main
boraxpr May 20, 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
5 changes: 3 additions & 2 deletions sklearn/metrics/_ranking.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,15 @@ def auc(x, y):
Parameters
----------
x : ndarray of shape (n,)
x coordinates. These must be either monotonic increasing or monotonic
X coordinates. These must be either monotonic increasing or monotonic
decreasing.
y : ndarray of shape, (n,)
y coordinates.
Y coordinates.

Returns
-------
auc : float
Area Under the Curve.

See Also
--------
Expand Down
1 change: 0 additions & 1 deletion sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@
"sklearn.metrics._classification.log_loss",
"sklearn.metrics._plot.det_curve.plot_det_curve",
"sklearn.metrics._plot.precision_recall_curve.plot_precision_recall_curve",
"sklearn.metrics._ranking.auc",
"sklearn.metrics._ranking.coverage_error",
"sklearn.metrics._ranking.dcg_score",
"sklearn.metrics._ranking.label_ranking_average_precision_score",
Expand Down