Add URL to reference of Minka paper used in PCA #19207
Merged
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
glemaitre
reviewed
Jan 20, 2021
|
Unfortunately, I know find myself wit ha linting error, that I don't understand. Any advice? Do you see the problem? |
|
Fixed error and squashed commit. |
jeremiedbb
reviewed
Jan 22, 2021
hamogu
commented
Jan 22, 2021
|
linter failed with I rebased on current main, but that did not change the situation. Probably related to |
|
Yes it should be fixed by #19237 |
This PR adds a link to the reference of the Minka paper implemented in the PCA for `method='mle'`. That paper is cited twice: In the method `_asses_dimension` I add a direct link to the exact paper, in the general docstring of the PCA I add a reference to Minka's page with the algorithm, because on that page there is an extended and updated write-up on this method in addition to a copy of the original paper. That write-up is more useful as an introduction to the method, but obviously has different equation numbers etc. thus it is not a good link for the `_asses_dimension` method, which explicitly refers to "equation (31) from the paper".
applied comments from review, homogenized layout for all references in the main PCA docstring
|
Thanks @hamogu |
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Apr 22, 2021
glemaitre
pushed a commit
that referenced
this pull request
Apr 28, 2021
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 adds a link to the reference of the Minka paper implemented in the PCA for
method='mle'. That paper is cited twice: In the method_asses_dimensionI add a direct link to the exact paper, in the general docstring of the PCA I add a reference to Minka's page with the algorithm, because on that page there is an extended and updated write-up on this method in addition to a copy of the original paper. That write-up is more useful as an introduction to the method, but obviously has different equation numbers etc. thus it is not a good link for the_asses_dimensionmethod, which explicitly refers to "equation (31) from the paper".Reference Issues/PRs
What does this implement/fix? Explain your changes.
Any other comments?