8000 DOC add examples in docstring for decomposition by yuanx749 · Pull Request #28131 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC add examples in docstring for decomposition #28131

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jan 15, 2024
Merged

DOC add examples in docstring for decomposition #28131

merged 4 commits into from
Jan 15, 2024

Conversation

yuanx749
Copy link
Contributor

Reference Issues/PRs

Fixes parts of #27982

What does this implement/fix? Explain your changes.

Adds examples to docstring of the following functions:

  • sklearn.decomposition.dict_learning
  • sklearn.decomposition.dict_learning_online
  • sklearn.decomposition.sparse_encode

Any other comments?

I try to reuse the corresponding examples in DictionaryLearning, MiniBatchDictionaryLearning, SparseCoder.

Note that the results of functions are different from classes, since other than alpha, there is a different transform_alpha parameter that affects the behavior of transform in class.

@github-actions GitHub Actions
Copy link
github-actions bot commented Jan 15, 2024 •
edited
Loading

✔️ Linting Passed

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

Generated for commit: 15eda71. Link to the linter CI: here

@glemaitre glemaitre self-requested a review January 15, 2024 20:05
glemaitre
glemaitre approved these changes Jan 15, 2024
View reviewed changes
Copy link
Member
@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM. The CIs was failing only because of codecov upload.
I pushed a small commit for nitpicks.
Let's merge if it passes.

Thanks @yuanx749. I appreciate that you looked at the examples of the corresponding classes.

@glemaitre glemaitre enabled auto-merge (squash) January 15, 2024 20:13
@glemaitre glemaitre merged commit 65c907d into scikit-learn:main Jan 15, 2024
@yuanx749 yuanx749 deleted the decomposition-docstrings branch January 16, 2024 03:41
jeremiedbb pushed a commit to jeremiedbb/scikit-learn that referenced this pull request Jan 17, 2024
@yuanx749 @glemaitre @jeremiedbb
DOC add examples in docstring for decomposition (scikit-learn#28131)
d9fc7a7 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
jeremiedbb pushed a commit that referenced this pull request Jan 17, 2024
@yuanx749 @glemaitre @jeremiedbb
DOC add examples in docstring for decomposition (#28131)
fa0f1a8 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre added a commit to glemaitre/scikit-learn that referenced this pull request Feb 10, 2024
@yuanx749 @glemaitre
DOC add examples in docstring for decomposition (scikit-learn#28131)
7613580 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glemaitre glemaitre glemaitre approved these changes

Assignees
No one assigned
Labels
Documentation module:decomposition
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@yuanx749 @glemaitre
0