DOC Specify the meaning of dict_init=None in sklearn.decomposition.dict_learning_online #23261
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
May 2, 2022
Comment on lines
813
to
815
| using :func:`randomized_svd` as:: | ||
|
|
||
| _, S, dictionary = randomized_svc(X, n_components, random_state) |
There was a problem hiding this comment.
Suggested change
| using :func:`randomized_svd` as:: | |
| _, S, dictionary = randomized_svc(X, n_components, random_state) | |
| using :func:`~sklearn.utils.randomized_svd` as:: | |
| _, S, dictionary = randomized_svd(X, n_components, random_state) |
jeremiedbb
reviewed
May 3, 2022
There was a problem hiding this comment.
Thanks for the PR @marenwestermann. I think it's good to say that the initial dict is built from an svd of the data, but I don't think it's necessary to expose the corresponding lines of code.
We actually discussed it yesterday during office hours and it was my feedback as well. |
|
Thank you for your feedback. I updated the PR. |
glemaitre
reviewed
May 4, 2022
| Initial value for the dictionary for warm restart scenarios. | ||
| Initial values for the dictionary for warm restart scenarios. | ||
| If `None`, the initial values for the dictionary are created | ||
| using :func:`~sklearn.utils.randomized_svd`. |
There was a problem hiding this comment.
Suggested change
| using :func:`~sklearn.utils.randomized_svd`. | |
| with an SVD decomposition of the data via :func:`~sklearn.utils.randomized_svd`. |
jeremiedbb
approved these changes
May 4, 2022
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
May 19, 2022
glemaitre
pushed a commit
that referenced
this pull request
May 19, 2022
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.
Reference Issues/PRs
Towards #17295
What does this implement/fix? Explain your changes.
I added documentation to the
dict_learning_onlinefunction insklearn/decomposition/_dict_learning.pyfor the casedict_init=None.Any other comments?
In #17295 it is said that
dict_learning_onlinealso has the attributecode_initwhich also needs further documentation. However, this is a mistake asdict_learning_onlinedoesn't have this attribute.