Skip to content

DOC add links to cross decomposition examples#26934

Merged
adrinjalali merged 7 commits intoscikit-learn:mainfrom
punndcoder28:link_examples_cross_decomposition
Feb 6, 2024
Merged

DOC add links to cross decomposition examples#26934
adrinjalali merged 7 commits intoscikit-learn:mainfrom
punndcoder28:link_examples_cross_decomposition

Conversation

@punndcoder28
Copy link
Copy Markdown
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
Copy Markdown

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
Copy Markdown
Member

adrinjalali commented Jul 31, 2023

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
Copy Markdown
Contributor Author

punndcoder28 commented Jul 31, 2023

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

@adrinjalali
Copy link
Copy Markdown
Member

adrinjalali commented Aug 1, 2023

Yes, a separate PR for CCA sounds good.

@punndcoder28
Copy link
Copy Markdown
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
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.

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
Copy Markdown
Member

adrinjalali commented Sep 14, 2023

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
Copy Markdown
Member

adrinjalali commented Sep 29, 2023

@punndcoder28 are you gonna be working on this?

@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Sep 29, 2023

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
Copy Markdown
Member

@adrinjalali adrinjalali Oct 5, 2023

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
Copy Markdown
Member

marenwestermann commented Jan 5, 2024

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

@punndcoder28
Copy link
Copy Markdown
Contributor Author

punndcoder28 commented Jan 6, 2024

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
>>> 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
Copy Markdown
Contributor Author

@punndcoder28 punndcoder28 Jan 6, 2024

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