8000 DOC Ensures that PLSRegression passes numpydoc validation by jmloyola · Pull Request #21208 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Ensures that PLSRegression passes numpydoc validation #21208

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

Merged
merged 3 commits into from
Oct 1, 2021
Merged

DOC Ensures that PLSRegression passes numpydoc validation #21208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39aa60c
Remove PLSRegression from DOCSTRING_IGNORE_LIST
jmloyola Oct 1, 2021
8651a8e
Fix numpydocs from PLSRegression
jmloyola Oct 1, 2021
31092b5
Change docstrings to maintain consistency
jmloyola Oct 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
"MultiTaskLassoCV",
"OrthogonalMatchingPursuit",
"OrthogonalMatchingPursuitCV",
"PLSRegression",
"PassiveAggressiveClassifier",
"PassiveAggressiveRegressor",
"PatchExtractor",
Expand Down
12 changes: 8 additions & 4 deletions sklearn/cross_decomposition/_pls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ def _more_tags(self):


class PLSRegression(_PLS):
"""PLS regression
"""PLS regression.

PLSRegression is also known as PLS2 or PLS1, depending on the number of
targets.
Expand Down Expand Up @@ -577,9 +577,9 @@ class PLSRegression(_PLS):
than `tol`, where `u` corresponds to the left singular vector.

copy : bool, default=True
Whether to copy `X` and `Y` in fit before applying centering, and
potentially scaling. If False, these operations will be done inplace,
modifying both arrays.
Whether to copy `X` and `Y` in :term:`fit` before applying centering,
and potentially scaling. If `False`, these operations will be done
inplace, modifying both arrays.

Attributes
----------
Expand Down Expand Up @@ -626,6 +626,10 @@ class PLSRegression(_PLS):

.. versionadded:: 1.0

See Also
--------
PLSCanonical : Partial Least Squares transformer and regressor.

Examples
--------
>>> from sklearn.cross_decomposition import PLSRegression
Expand Down
0