Skip to content

DOC Add links to example plot_image_denoising.py#30864

Merged
marenwestermann merged 7 commits intoscikit-learn:mainfrom
GesaLoof:feature_gesa
Sep 6, 2025
Merged

DOC Add links to example plot_image_denoising.py#30864
marenwestermann merged 7 commits intoscikit-learn:mainfrom
GesaLoof:feature_gesa

Conversation

@GesaLoof
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Towards Issue #30621 - Linked example plot_image_denoising.py for Mini-batch dictionary learning

What does this implement/fix? Explain your changes.

Added example plot_image_denoising.py for Mini-batch dictionary learning in the User Guide section 2.5.4.3.
Nothing changed in API documentation.

Any other comments?

@adrinjalali
@StefanieSenger

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 19, 2025

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: a2f1619. Link to the linter CI: here

Copy link
Copy Markdown
Member

@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, @GesaLoof!

The example is already linked several times in the section above ("Generic dictionary learning"), but it uses MiniBatchDictionaryLearning and thus would rather belong to the section you have linked it to. Since we don't want to pollute the UserGuide too much and aim to pin point examples to their best spots: would you suggest to actually remove a few of the references above, for instance this one or maybe more? What do you think?

GesaLoof and others added 3 commits February 20, 2025 18:24
Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
@StefanieSenger
Copy link
Copy Markdown
Member

Hello @GesaLoof,

thanks for the changes. The example-linking looks good now.

Only one more thing: you have changed and pushed the .pre-commit-config.yaml. Can you please re-do that? For instance using git checkout --theirs to select main's file - or just by hand the commits get squashed before merging anyways.
(git add * is dangerous in large projects :-))

Thanks a lot!

@GesaLoof
Copy link
Copy Markdown
Contributor Author

Hi @StefanieSenger
Oh yes of course, I will change that!
I had to add the python default version to the yaml for pre-commit to work, maybe you remember this strange error I was getting. In case you're interested, I found the solution here: https://stackoverflow.com/questions/72177222/runtimeerror-failed-to-find-interpreter-for-builtin-discover-of-python-spec-py

Copy link
Copy Markdown
Member

@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I remember. I am glad you found a solution!

So, this PR looks fine! Thank you for your work!

Can we merge it, @marenwestermann or @adrinjalali ?

@GesaLoof
Copy link
Copy Markdown
Contributor Author

Amazing, thank you so much for helping and teaching us how to contribute!

Copy link
Copy Markdown
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this also reserves to have a link in the MiniBatchDictionaryLearning docstring.

@marenwestermann
Copy link
Copy Markdown
Member

Hi @GesaLoof! Would you like to continue working on this pull request?

@marenwestermann marenwestermann changed the title Added example plot_image_denoising.py in User Guide DOC Add links to example plot_image_denoising.py Sep 6, 2025
@marenwestermann marenwestermann merged commit 0033630 into scikit-learn:main Sep 6, 2025
37 checks passed
@marenwestermann
Copy link
Copy Markdown
Member

I finished the PR. Thank you for your contribution @GesaLoof!

DeaMariaLeon pushed a commit to DeaMariaLeon/scikit-learn that referenced this pull request Sep 12, 2025
Co-authored-by: Stefanie Senger <91849487+StefanieSenger@users.noreply.github.com>
Co-authored-by: Maren Westermann <maren.westermann@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants