Skip to content

DOC Ensures that sklearn.utils.extmath.randomized_svd passes numpydoc validation #24607

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

Jump to bottom
Merged
merged 5 commits into from
Oct 13, 2022
Merged

DOC Ensures that sklearn.utils.extmath.randomized_svd passes numpydoc validation #24607

merged 5 commits into from
Oct 13, 2022

Conversation

awinml
Copy link
Contributor

@awinml awinml commented Oct 8, 2022

DOC Ensures that sklearn.utils.extmath.randomized_svd passes numpydoc validation

Reference Issues/PRs

Addresses #21350
Ensures that sklearn.utils.extmath.randomized_svd passes numpydoc validation.

What does this implement/fix? Explain your changes.

  • Removed sklearn.utils.extmath.randomized_svd from test_docstrings.py
  • The Short Summary has been changed to start with an infinitive verb.
  • Added a Returns section which explains the three matrices returned after SVD.
  • Created an Examples section and added a simple example demonstrating the use of the function.

@thomasjpfan thomasjpfan mentioned this pull request Oct 12, 2022
Closed
glemaitre
glemaitre reviewed Oct 13, 2022
View reviewed changes
@glemaitre
Copy link
Member

I solved the conflicts and slighlty modified the examples and follow our scikit-learn convention.

If the tests are passing I will merge this PR soonish.

@awinml
Copy link
Contributor Author

awinml commented Oct 13, 2022

Thanks @glemaitre. Appreciate it!

@glemaitre glemaitre merged commit aa7fd7a into scikit-learn:main Oct 13, 2022
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Oct 31, 2022
@awinml @glemaitre
DOC Ensures that sklearn.utils.extmath.randomized_svd passes numpyd…
e9c57b4 
…oc validation (scikit-learn#24607)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glemaitre glemaitre glemaitre left review comments

Assignees
No one assigned
Labels
Documentation module:utils No Changelog Needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@awinml @glemaitre @cmarmo