Skip to content

DOC Add wikipedia principal eigenvector example to API docs #30017

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.

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 5 commits into from
Oct 8, 2024

Conversation

azyleee
Copy link
Contributor

@azyleee azyleee commented Oct 6, 2024

Reference Issues/PRs

Fixes #26927

What does this implement/fix? Explain your changes.

Add wikipedia_principal_eigenvector.py example reference in randomized_svd docstring

Copy link

github-actions bot commented Oct 6, 2024

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: b8b62c3. Link to the linter CI: here

@glemaitre glemaitre self-requested a review October 8, 2024 15:51
@@ -482,6 +482,9 @@ def randomized_svd(
.. [3] An implementation of a randomized algorithm for principal component
analysis A. Szlam et al. 2014

See:ref:`sphx_glr_auto_examples_applications_wikipedia_principal_eigenvector.py`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this change in the long summary of the function.

Instead of "how to use the API", basically the example shows a typical case where randomized SVD was used: ranking of web pages also known as PageRank.

@glemaitre glemaitre self-requested a review October 8, 2024 16:04
Copy link
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the changes were minimum, I pushed directly in the branch.

I'll check the rendering of the page and I'll merge the PR.

Thanks @azyleee

@glemaitre glemaitre enabled auto-merge (squash) October 8, 2024 16:31
@glemaitre glemaitre merged commit b868a5d into scikit-learn:main Oct 8, 2024
30 checks passed
BenJourdan pushed a commit to gregoryschwartzman/scikit-learn that referenced this pull request Oct 11, 2024
…earn#30017)

Co-authored-by: Guillaume Lemaitre <guillaume@probabl.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add links to examples from the docstrings and user guides
2 participants