DOC: Add link to plot_sparse_coding.py in DictionaryLearning and Mini… #31472
+16
−0
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
…BatchDictionaryLearning docstrings
❌ Linting issuesThis PR is introducing linting issues. Here's a summary of the issues. Note that you can avoid having linting issues by enabling You can see the details of the linting issues under the
|
There was a problem hiding this comment.
Hi @Marcilesm, thanks for opening a PR!
I think it needs a bit more work though, so that users can get the most of this.
- Please provide some more context with the links that make it obvious why you put them into the docstrings of
DictionaryLearningandMiniBatchDictionaryLearning. I seeSparseCoderused in the example, that codes based on a manually defined dictionary. What is the connection between these and the manually definedricker_functionandricker_matrix? Adding this information will actually make users see this example's usefulness for them. - We strive for not adding references into the "Examples" section of a docstring, since it is reserved for pure code snippets only. Maybe you can find a new location to these?
…g and MiniBatchDictionaryLearning
ba41816 to
6a858ff
Compare
|
Hi @StefanieSenger, |
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.
…BatchDictionaryLearning docstrings
Reference Issues/PRs
Addresses part of issue #30621
What does this implement/fix? Explain your changes.
This PR adds a reference to the example plot_sparse_coding.py in the
Examplessections of theDictionaryLearningandMiniBatchDictionaryLearningclass docstrings.This improves documentation discoverability by linking relevant usage examples to their associated estimators.
Any other comments?
N/A