Skip to content

[MRG] Label docstrings with versionadded #15426 - classes starting with 'p' #15494

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

Closed
wants to merge 2 commits into from
Closed

[MRG] Label docstrings with versionadded #15426 - classes starting with 'p' #15494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3e6d43
Added Sphinx versionadded to TimeSeriesSplit docstring (Issue #15426)
harini-sridhar Nov 2, 2019
baccef5
Added Sphinx versionadded to docstrings of PLSCanonical, PLSRegressio…
harini-sridhar Nov 2, 2019
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
6 changes: 6 additions & 0 deletions sklearn/cross_decomposition/_pls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,6 +634,8 @@ class PLSRegression(_PLS):
In french but still a reference:
Tenenhaus, M. (1998). La regression PLS: theorie et pratique. Paris:
Editions Technic.

.. versionadded:: 0.8
Copy link
Member

Choose a reason for hiding this comment

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

These need to be added after the description, before parameters. Adding it here will be a problem with numpydoc

"""

def __init__(self, n_components=2, scale=True,
Expand Down Expand Up @@ -778,6 +780,8 @@ class PLSCanonical(_PLS):
--------
CCA
PLSSVD

.. versionadded:: 0.8
"""

def __init__(self, n_components=2, scale=True, algorithm="nipals",
Expand Down Expand Up @@ -845,6 +849,8 @@ class PLSSVD(TransformerMixin, BaseEstimator):
--------
PLSCanonical
CCA

.. versionadded:: 0.8
"""

def __init__(self, n_components=2, scale=True, copy=True):
Expand Down
2 changes: 2 additions & 0 deletions sklearn/feature_extraction/image.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,8 @@ class PatchExtractor(BaseEstimator):
>>> pe_trans = pe.transform(X)
>>> print('Patches shape: {}'.format(pe_trans.shape))
Patches shape: (545706, 2, 2)

.. versionadded:: 0.9
"""

def __init__(self, patch_size=None, max_patches=None, random_state=None):
Expand Down
2 changes: 2 additions & 0 deletions sklearn/model_selection/_split.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1842,6 +1842,8 @@ class PredefinedSplit(BaseCrossValidator):
... y_train, y_test = y[train_index], y[test_index]
TRAIN: [1 2 3] TEST: [0]
TRAIN: [0 2] TEST: [1 3]

.. versionadded:: 0.16
"""

def __init__(self, test_fold):
Expand Down
3 changes: 3 additions & 0 deletions sklearn/pipeline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ class Pipeline(_BaseComposition):
(1, 10)
>>> sub_pipeline.inverse_transform(coef).shape
(1, 20)

.. versionadded:: 0.5

"""

# BaseEstimator interface
Expand Down
2 changes: 2 additions & 0 deletions sklearn/preprocessing/_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2715,6 +2715,8 @@ class PowerTransformer(TransformerMixin, BaseEstimator):

.. [2] G.E.P. Box and D.R. Cox, "An Analysis of Transformations", Journal
of the Royal Statistical Society B, 26, 211-252 (1964).

.. versionadded:: 0.19.2
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason you specified 0.19.2 as opposed to 0.19 ?

Copy link
Member

@TomDLT TomDLT Nov 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

I double checked, and it seems to have been added in 0.20, as stated in the doc/whats_new/v0.20.rst file (here). Where did you find the 0.19.2 mention ?

"""
def __init__(self, method='yeo-johnson', standardize=True, copy=True):
self.method = method
Expand Down