DOC ensure SpectralClustering passes numpydoc validation and improve references #20987
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documentation update:
Remove the irrelevant reference, already used in the discretize function:
- Multiclass spectral clustering, 2003
Stella X. Yu, Jianbo Shi
Add two new references, proposing ARPACK, LOBPCG/AMG algorithms actually coded here:
- Modern Preconditioned Eigensolvers for Spectral Image Segmentation
and Graph Bisection, 2003
Andrew Knyazev
https://bit.ly/3tmTR4k
- Multiscale Spectral Graph Partitioning and Image Segmentation, 2006
Andrew Knyazev
https://bit.ly/3toJU6i
glemaitre
reviewed
Sep 9, 2021
made changes proposed by the reviewer
minor error fixed
lint errors fix
|
@glemaitre I have made your requested changes. Could you please have another look? |
|
I made a push to create hyperlinks to the PDF and add references in the docstring parameters entry. Since I was modifying, I checked that the docstring was passing numpydoc validation. Now, looks good. I will check the rendering after that the CI documentation will be completed. |
|
Thanks @lobpcg Rendering looks good. Merging. |
|
Thanks @glemaitre |
glemaitre
added a commit
to glemaitre/scikit-learn
that referenced
this pull request
Oct 23, 2021
…references (scikit-learn#20987) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
added a commit
that referenced
this pull request
Oct 25, 2021
…references (#20987) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
…references (scikit-learn#20987) 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements the following changes:
SpectralClusteringfollows numpydoc convention