DOC: Add link to plot_sparse_coding.py in DictionaryLearning and Mini… #31472
Conversation
…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, |
There was a problem hiding this comment.
Hi @Marcilesm,
thanks for your work in framing the references. The descriptions you've added are very informative in describing the context when and how the results from dictionary learning would be used.
We need to fix the linting and remove the duplicate reference before making a final call.
| See the example: | ||
| :ref:`sphx_glr_auto_examples_decomposition_plot_sparse_coding.py` | ||
|
|
There was a problem hiding this comment.
| See the example: | |
| :ref:`sphx_glr_auto_examples_decomposition_plot_sparse_coding.py` | |
Removing duplicate reference.
Also, note we had a linting error that showed up in the CI like this:
|
1965 | See the example:
1966 | :ref:`sphx_glr_auto_examples_decomposition_plot_sparse_coding.py`
1967 |
| ^^^^ W293
1968 | .. note::
|
= help: Remove whitespace from blank line
If there is any character in a blank line (even a tab or a white space), the linter will fail.
When you commit this change, the CI will run again and then hopefully to the end, so we can see if everything renders fine.
…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