Skip to content

DOC Ensures that svd_flip passes numpydoc validation #24581

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 4 commits into from
Oct 11, 2022
Merged

DOC Ensures that svd_flip passes numpydoc validation #24581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
422aad3
Ensures sklearn.utils.extmath.svd_flip passes npdoc
mansi1597 Oct 5, 2022
65fb7d8
Removed svd_flip from function doctring ignore list
mansi1597 Oct 5, 2022
7bb4cf7
Update sklearn/utils/extmath.py
mansi1597 Oct 11, 2022
fb29e08
Merge remote-tracking branch 'upstream/main' into dev/mansi-1597/upda…
mansi1597 Oct 11, 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
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 @@ -14,7 +14,6 @@
FUNCTION_DOCSTRING_IGNORE_LIST = [
"sklearn.utils.extmath.fast_logdet",
"sklearn.utils.extmath.randomized_svd",
"sklearn.utils.extmath.svd_flip",
"sklearn.utils.gen_batches",
"sklearn.utils.metaestimators.if_delegate_has_method",
]
Expand Down
10 changes: 6 additions & 4 deletions sklearn/utils/extmath.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,12 +740,12 @@ def svd_flip(u, v, u_based_decision=True):
Parameters
----------
u : ndarray
u and v are the output of `linalg.svd` or
Parameters u and v are the output of `linalg.svd` or
:func:`~sklearn.utils.extmath.randomized_svd`, with matching inner
dimensions so one can compute `np.dot(u * s, v)`.
v : ndarray
u and v are the output of `linalg.svd` or
Parameters u and v are the output of `linalg.svd` or
:func:`~sklearn.utils.extmath.randomized_svd`, with matching inner
dimensions so one can compute `np.dot(u * s, v)`.
The input v should really be called vt to be consistent with scipy's
Expand All @@ -756,11 +756,13 @@ def svd_flip(u, v, u_based_decision=True):
Otherwise, use the rows of v. The choice of which variable to base the
decision on is generally algorithm dependent.
Returns
-------
u_adjusted, v_adjusted : arrays with the same dimensions as the input.
u_adjusted : ndarray
Array u with adjusted columns and the same dimensions as u.
v_adjusted : ndarray
Array v with adjusted rows and the same dimensions as v.
"""
if u_based_decision:
# columns of u, rows of v
Expand Down