Skip to content

DOC Ensures that label_binarize passes numpydoc validation #24002

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 2 commits into from
Jul 26, 2022
Merged

DOC Ensures that label_binarize passes numpydoc validation #24002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a277fd5
Fixed sklearn.preprocessing._label.label_binarize Docstring.
SabriDW Jul 26, 2022
0d23f7f
Merge branch 'main' into sabri
glemaitre Jul 26, 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
10 changes: 5 additions & 5 deletions sklearn/preprocessing/_label.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,11 @@ def label_binarize(y, *, classes, neg_label=0, pos_label=1, sparse_output=False)
Shape will be (n_samples, 1) for binary problems. Sparse matrix will
be of CSR format.

See Also
--------
LabelBinarizer : Class used to wrap the functionality of label_binarize and
allow for fitting to classes independently of the transform operation.

Examples
--------
>>> from sklearn.preprocessing import label_binarize
Expand All @@ -476,11 +481,6 @@ def label_binarize(y, *, classes, neg_label=0, pos_label=1, sparse_output=False)
[0],
[0],
[1]])

See Also
--------
LabelBinarizer : Class used to wrap the functionality of label_binarize and
allow for fitting to classes independently of the transform operation.
"""
if not isinstance(y, list):
# XXX Workaround that will be removed when list of list format is
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 @@ -47,7 +47,6 @@
"sklearn.metrics.pairwise.pairwise_distances_chunked",
"sklearn.preprocessing._data.maxabs_scale",
"sklearn.preprocessing._data.scale",
"sklearn.preprocessing._label.label_binarize",
"sklearn.svm._bounds.l1_min_c",
"sklearn.tree._export.plot_tree",
"sklearn.utils.axis0_safe_slice",
Expand Down