From c09572e2989016360415b078a7e49a4f37f98c9c Mon Sep 17 00:00:00 2001 From: Pinky-Chaudhary Date: Tue, 28 Sep 2021 12:44:30 +0530 Subject: [PATCH] fixed pytest errorts for PLSCanonical --- maint_tools/test_docstrings.py | 1 - sklearn/cross_decomposition/_pls.py | 12 ++++++------ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py index 4bd301d795937..6a9c6c83cfd23 100644 --- a/maint_tools/test_docstrings.py +++ b/maint_tools/test_docstrings.py @@ -23,7 +23,6 @@ "MultiTaskLassoCV", "OrthogonalMatchingPursuit", "OrthogonalMatchingPursuitCV", - "PLSCanonical", "PLSRegression", "PLSSVD", "PassiveAggressiveClassifier", diff --git a/sklearn/cross_decomposition/_pls.py b/sklearn/cross_decomposition/_pls.py index e36b79648d6c7..66dc4e74ab4a0 100644 --- a/sklearn/cross_decomposition/_pls.py +++ b/sklearn/cross_decomposition/_pls.py @@ -680,7 +680,7 @@ class PLSCanonical(_PLS): will compute the whole SVD. max_iter : int, default=500 - the maximum number of iterations of the power method when + The maximum number of iterations of the power method when `algorithm='nipals'`. Ignored otherwise. tol : float, default=1e-06 @@ -748,6 +748,11 @@ class PLSCanonical(_PLS): .. versionadded:: 1.0 + See Also + -------- + CCA : Canonical Correlation Analysis. + PLSSVD : Partial Least Square SVD. + Examples -------- >>> from sklearn.cross_decomposition import PLSCanonical @@ -757,11 +762,6 @@ class PLSCanonical(_PLS): >>> plsca.fit(X, Y) PLSCanonical() >>> X_c, Y_c = plsca.transform(X, Y) - - See Also - -------- - CCA - PLSSVD """ # This implementation provides the same results that the "plspm" package