Skip to content

DOC add links to cross decomposition examples #26934

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 7 commits into from
Feb 6, 2024
Merged

DOC add links to cross decomposition examples #26934

merged 7 commits into from
Feb 6, 2024

Conversation

punndcoder28
Copy link
Contributor

@punndcoder28 punndcoder28 commented Jul 29, 2023 •
edited
Loading

Reference Issues/PRs

Adds links to cross-decomposition examples as mentioned in #26927

What does this implement/fix? Explain your changes.

Adds links to the auto-generated examples for classes PLSRegression and PLSCanonical. The diff also adds link to the example comparing PLSRegression and PCR

Classes linked with examples

  1. PLSRegression in sklearn/cross_decomposition/_pls.py
  2. PLSCanonical in sklearn/cross_decomposition/_pls.py

@punndcoder28 punndcoder28 mentioned this pull request Jul 29, 2023
Closed
@github-actions
Copy link

github-actions bot commented Jul 29, 2023 •
edited
Loading

✔️ Linting Passed

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

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

@punndcoder28 punndcoder28 changed the title docs(cross_decomposition): add links to cross decomposition examples DOC add links to cross decomposition examples Jul 29, 2023
@adrinjalali
Copy link
Member

Could you please limit this PR to PLS* examples only, and list all files in the description which are being linked to?

@punndcoder28
Copy link
Contributor Author

Will update the PR description. Should another PR be created to address the changes for CCA class?

@adrinjalali
Copy link
Member

Yes, a separate PR for CCA sounds good.

@punndcoder28
Copy link
Contributor Author

punndcoder28 commented Aug 1, 2023 •
edited
Loading

@adrinjalali Moved out the changes concerning CCA from this PR and also added more information about the changes in the PR description

#26966 addresses the linking of examples for the CCA class

adrinjalali
adrinjalali reviewed Aug 2, 2023
View reviewed changes
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.

It would make sense to keep all links to a single example in a single PR, but limit the PR to a single example, rather than splitting the PR in a way that links to the same example are in different PRs.

@adrinjalali adrinjalali mentioned this pull request Aug 2, 2023
Closed
@punndcoder28 punndcoder28 force-pushed the link_examples_cross_decomposition branch from befd232 to 339139c Compare August 29, 2023 16:18
@adrinjalali
Copy link
Member

Note: linter's failing. This probably shouldn't happen if you enable pre-commit hooks. You also need to pull first before you work on this branch since I've pushed an update here.

@adrinjalali
Copy link
Member

@punndcoder28 are you gonna be working on this?

@punndcoder28
Copy link
Contributor Author

Sorry @adrinjalali missed this, will fix the linting issue

adrinjalali
adrinjalali reviewed Oct 5, 2023
View reviewed changes
sklearn/cross_decomposition/_pls.py Outdated
Comment on lines 593 to 594
For a comparison between PLS Regression and :class:`~sklearn.decomposition.PCA`, see
:ref:`sphx_glr_auto_examples_cross_decomposition_plot_pcr_vs_pls.py`.
Copy link
Member

Choose a reason for hiding this comment

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

I think moving this to the Examples section directly bellow should fix the CI issue.

@marenwestermann
Copy link
Member

@punndcoder28 would you like to continue working on this PR? If you need help let us know.

@punndcoder28
Copy link
Contributor Author

Apologies, the comments did not notify me. Will update the PR again

@punndcoder28 punndcoder28 force-pushed the link_examples_cross_decomposition branch from 15c37dd to cd39b3b Compare January 6, 2024 03:42
punndcoder28
punndcoder28 commented Jan 6, 2024
View reviewed changes
sklearn/cross_decomposition/_pls.py
@@ -596,6 +599,9 @@ class PLSRegression(_PLS):
>>> pls2.fit(X, Y)
PLSRegression()
>>> Y_pred = pls2.predict(X)

For a comparison between PLS Regression and :class:`~sklearn.decomposition.PCA`, see
:ref:`sphx_glr_auto_examples_cross_decomposition_plot_pcr_vs_pls.py`.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved this to the example section. Is this OK @adrinjalali

@adrinjalali adrinjalali merged commit 8189bc3 into scikit-learn:main Feb 6, 2024
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Feb 10, 2024
@punndcoder28 @glemaitre
DOC add links to cross decomposition examples (scikit-learn#26934)
3e4b875
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Feb 13, 2024
@punndcoder28 @glemaitre
DOC add links to cross decomposition examples (scikit-learn#26934)
7cf9298
glemaitre pushed a commit that referenced this pull request Feb 13, 2024
@punndcoder28 @glemaitre
DOC add links to cross decomposition examples (#26934)
e8612d6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adrinjalali adrinjalali adrinjalali approved these changes

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

Successfully merging this pull request may close these issues.
3 participants
@punndcoder28 @adrinjalali @marenwestermann