10000 DOC add links to cross decomposition examples (#26934) · scikit-learn/scikit-learn@8189bc3 · GitHub
[go: up one dir, main page]

Skip to content

Commit 8189bc3

Browse files
authored
DOC add links to cross decomposition examples (#26934)
1 parent cf1fb22 commit 8189bc3

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

sklearn/cross_decomposition/_pls.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,9 @@ class PLSRegression(_PLS):
505505
PLSRegression is also known as PLS2 or PLS1, depending on the number of
506506
targets.
507507
508+
For a comparison between other cross decomposition algorithms, see
509+
:ref:`sphx_glr_auto_examples_cross_decomposition_plot_compare_cross_decomposition.py`.
510+
508511
Read more in the :ref:`User Guide <cross_decomposition>`.
509512
510513
.. versionadded:: 0.8
@@ -596,6 +599,9 @@ class PLSRegression(_PLS):
596599
>>> pls2.fit(X, Y)
597600
PLSRegression()
598601
>>> Y_pred = pls2.predict(X)
602+
603+
For a comparison between PLS Regression and :class:`~sklearn.decomposition.PCA`, see
604+
:ref:`sphx_glr_auto_examples_cross_decomposition_plot_pcr_vs_pls.py`.
599605
"""
600606

601607
_parameter_constraints: dict = {**_PLS._parameter_constraints}
@@ -650,6 +656,9 @@ def fit(self, X, Y):
650656
class PLSCanonical(_PLS):
651657
"""Partial Least Squares transformer and regressor.
652658
659+
For a comparison between other cross decomposition algorithms, see
660+
:ref:`sphx_glr_auto_examples_cross_decomposition_plot_compare_cross_decomposition.py`.
661+
653662
Read more in the :ref:`User Guide <cross_decomposition>`.
654663
655664
.. versionadded:: 0.8
@@ -780,6 +789,9 @@ def __init__(
780789
class CCA(_PLS):
781790
"""Canonical Correlation Analysis, also known as "Mode B" PLS.
782791
792+
For a comparison between other cross decomposition algorithms, see
793+
:ref:`sphx_glr_auto_examples_cross_decomposition_plot_compare_cross_decomposition.py`.
794+
783795
Read more in the :ref:`User Guide <cross_decomposition>`.
784796
785797
Parameters

0 commit comments

Comments
 (0)
0