Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Added example plot_image_denoising.py in User Guide #30864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
Loading
from

Conversation

GesaLoof
Copy link

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

Copy link

github-actions bot commented Feb 19, 2025

✔️ Linting Passed

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

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

Copy link
Contributor

@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?

doc/modules/decomposition.rst Outdated Show resolved Hide resolved
doc/modules/decomposition.rst Outdated Show resolved Hide resolved
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
Contributor

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
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
Contributor

@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
Author

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

Copy link
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.