DOC Add versionchanged and versionadded for v0.20 #16199

borovikova · 2020-01-25T10:37:32Z

Towards to #15426

This PR will add versionchanged and versionadded label to parameters changed in v0.20

With @ellenkoenig

@WiMLDS_Berlin
@adrinjalali
@noatamir

This reverts commit 667c372.

…earn into version20-docstrings

sklearn/covariance/_elliptic_envelope.py

sklearn/pipeline.py

Co-Authored-By: Adrin Jalali <[email protected]>

…scikit-learn into version20-docstrings

noatamir · 2020-04-17T08:30:06Z

@borovikova let me know if you need help finishing those last two features 😃 I just finished my PR for documenting v.19 changes and would be happy to pair remotely

borovikova · 2020-04-17T08:51:08Z

@noatamir Thanks! But I have finished those so now there is nothing to do. At least until the PR is reviewed :-D

NicolasHug

Thanks for the PR @borovikova @ellenkoenig, this will be useful

Made a few comments but this looks good in general.
Are you available to address these? You'll also need to merge with master.

Thanks for your patience!

sklearn/cluster/_agglomerative.py

sklearn/covariance/_graph_lasso.py

sklearn/metrics/_classification.py

sklearn/model_selection/_search.py

sklearn/pipeline.py

sklearn/preprocessing/_discretization.py

Co-Authored-By: Nicolas Hug <[email protected]>

…vikova/scikit-learn into version20-docstrings

…into version20-docstrings � Conflicts: � sklearn/linear_model/_stochastic_gradient.py � sklearn/model_selection/_search.py � sklearn/multiclass.py � sklearn/neighbors/_kde.py

borovikova · 2020-04-25T08:48:41Z

@NicolasHug Thanks for the review! Everything is done except for that one case where I'm not sure what to do.

Co-Authored-By: Nicolas Hug <[email protected]>

NicolasHug

Thanks to you both, nice work!

@cmarmo if you're available to review this one, I think we would be OK to merge it after your approval

cmarmo

Thanks for your work and your patience @borovikova

jnothman

Otherwise lgtm, thanks @borovikova!

jnothman · 2020-01-26T13:12:50Z

sklearn/covariance/_elliptic_envelope.py

@@ -179,6 +180,8 @@ def predict(self, X):
        -------
        is_inlier : ndarray of shape (n_samples,)
            Returns -1 for anomalies/outliers and +1 for inliers.
+
+         .. versionadded:: 0.20


I don't think this indent is valid in this context

jnothman · 2020-01-26T13:12:58Z

sklearn/covariance/_graph_lasso.py

@@ -561,6 +561,9 @@ class GraphicalLassoCV(GraphicalLasso):
        ``-1`` means using all processors. See :term:`Glossary <n_jobs>`
        for more details.

+        ..versionchanged:: v0.20


space after .. please

jnothman · 2020-01-26T13:13:12Z

sklearn/covariance/_graph_lasso.py

@@ -561,6 +561,9 @@ class GraphicalLassoCV(GraphicalLasso):
        ``-1`` means using all processors. See :term:`Glossary <n_jobs>`
        for more details.

+        ..versionchanged:: v0.20
+           `n_jobs` changed from ``1`` to ``None``


Do we really need this level of detailed annotation?

I'm sorry I'm not sure I understand what you mean. Shall I remove the versionchanged docstring here?

jnothman · 2020-04-25T22:42:21Z

sklearn/preprocessing/_encoders.py

@@ -603,8 +605,6 @@ class OrdinalEncoder(_BaseEncoder):

    Read more in the :ref:`User Guide <preprocessing_categorical_features>`.

-    .. versionchanged:: 0.20.1


We should note when OrdinalEncoder was added but maybe that's intentionality left for another pull request?

jnothman · 2020-04-25T22:42:38Z

sklearn/utils/_show_versions.py

-    """Print useful debugging information"""
+    """Print useful debugging information"
+
+        .. versionadded:: 0.20


Please outdent this

NicolasHug · 2020-04-26T13:28:04Z

Joel's comments have been addressed, merging

Thanks again @borovikova @ellenkoenig, and @cmarmo for the review

Co-Authored-By: Adrin Jalali <[email protected]> Co-Authored-By: Chiara Marmo <[email protected]> Co-Authored-By: Nicolas Hug <[email protected]>

Add versionchanged to OneVsRestClassifier

7ec21a1

borovikova changed the title ~~[WIP] Add versionchanged to OneVsRestClassifier~~ [WIP] Add versionchanged and versionadded for v0.20 Jan 25, 2020

borovikova and others added 8 commits January 25, 2020 11:44

Add indentation for versionchanged in OneVsRestClassifier

8ef9273

Add versionchanged docstring to OneVsOne classifier

667c372

Revert "Add versionchanged docstring to OneVsOne classifier"

3ef35ea

This reverts commit 667c372.

Add versionchanged docstring to OneVsOne classifier

f441640

Add missing new line and fix quoting

ea0f2c6

Removed (probably) unecessarily newline

67ee16f

Fix unindent for versionchanged docstring

146ed61

Merge remote-tracking branch 'upstream/master' into version20-docstrings

15adc9c

borovikova changed the title ~~[WIP] Add versionchanged and versionadded for v0.20~~ [WIP] Add versionchanged and versionadded for v0.20.0 Jan 25, 2020

borovikova and others added 14 commits January 25, 2020 13:56

Add versionchanged to OutputCodeClassifier

99c969d

Add versionchanged to MultiOutputRegressor, MultiOutputClassifier

a7c3279

Added versionadded tag for score_samples method

3b4cd7b

Remove trailing whitespaces in OutputCodeClassifier

9b3521d

Merge branch 'version20-docstrings' of github.com:borovikova/scikit-l…

d117f6e

…earn into version20-docstrings

Added versionadded tag for offset_ parameter

1acb9dd

Add versionchanged to FeatureUnion, make_union

026a188

Add versionchanged GraphicalLassoCV

df82b12

Added versionadded tag for categories parameter

08ee866

Add versionchanged to GridSearchCV, RandomizedSearchCV

d18a232

Added versionadded tag to class

c8cee0c

Added versionadded tag to predict method

3051219

Added versionadded tag to novelty parameter

b84dcb2

Fixed whitespace

9294abb

adrinjalali reviewed Jan 25, 2020

View reviewed changes

sklearn/covariance/_elliptic_envelope.py Outdated Show resolved Hide resolved

sklearn/pipeline.py Outdated Show resolved Hide resolved

ellenkoenig and others added 4 commits January 25, 2020 14:57

Update sklearn/covariance/_elliptic_envelope.py

ba18554

Co-Authored-By: Adrin Jalali <[email protected]>

Replaced v0.20.0 with 0.20

44d7cce

Merge branch 'version20-docstrings' of https://github.com/borovikova/…

0394d8f

…scikit-learn into version20-docstrings

Change "n_jobs change" to "n_jobs changed"

0321012

borovikova changed the title ~~Add versionchanged and versionadded for v0.20~~ [MRG] Add versionchanged and versionadded for v0.20 Mar 30, 2020

cmarmo added the Waiting for Reviewer label Mar 31, 2020

NicolasHug reviewed Apr 24, 2020

View reviewed changes

borovikova and others added 8 commits April 25, 2020 09:15

Update sklearn/cluster/_agglomerative.py

2aa5a3f

Co-Authored-By: Nicolas Hug <[email protected]>

Update sklearn/covariance/_graph_lasso.py

6b4960b

Co-Authored-By: Nicolas Hug <[email protected]>

Update sklearn/covariance/_graph_lasso.py

36acdc6

Co-Authored-By: Nicolas Hug <[email protected]>

Update sklearn/covariance/_graph_lasso.py

13cc0a4

Co-Authored-By: Nicolas Hug <[email protected]>

Merge branches 'master' and 'version20-docstrings' of github.com:boro…

69e9c05

…vikova/scikit-learn into version20-docstrings

Merge branch 'master' of https://github.com/scikit-learn/scikit-learn …

211e148

…into version20-docstrings � Conflicts: � sklearn/linear_model/_stochastic_gradient.py � sklearn/model_selection/_search.py � sklearn/multiclass.py � sklearn/neighbors/_kde.py

Corrects several versionadded/changed docstrings according to the review

25d2c01

Fix linter errors

35e79a2

borovikova changed the title ~~[MRG] Add versionchanged and versionadded for v0.20~~ [WIP] Add versionchanged and versionadded for v0.20 Apr 25, 2020

borovikova and others added 4 commits April 25, 2020 14:15

Update sklearn/datasets/_samples_generator.py

fa29d30

Co-Authored-By: Nicolas Hug <[email protected]>

Move vesionadded docstring to fit_and_predict method

57e3fd2

Revert transformer_weights parameters to 'dict, default=None'

84ef36d

Clarifies which parameter the versionadded refers to

229b61f

NicolasHug approved these changes Apr 25, 2020

View reviewed changes

NicolasHug changed the title ~~[WIP] Add versionchanged and versionadded for v0.20~~ [MRG] Add versionchanged and versionadded for v0.20 Apr 25, 2020

cmarmo removed the Waiting for Reviewer label Apr 25, 2020

cmarmo approved these changes Apr 25, 2020

View reviewed changes

jnothman reviewed Apr 25, 2020

View reviewed changes

Docstrings corrections

1679e12

NicolasHug changed the title ~~[MRG] Add versionchanged and versionadded for v0.20~~ DOC Add versionchanged and versionadded for v0.20 Apr 26, 2020

NicolasHug merged commit 4755ae7 into scikit-learn:master Apr 26, 2020

		@@ -603,8 +605,6 @@ class OrdinalEncoder(_BaseEncoder):

		Read more in the :ref:`User Guide <preprocessing_categorical_features>`.

		.. versionchanged:: 0.20.1

Uh oh!

DOC Add versionchanged and versionadded for v0.20 #16199

DOC Add versionchanged and versionadded for v0.20 #16199

Uh oh!

Conversation

borovikova commented Jan 25, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

noatamir commented Apr 17, 2020

Uh oh!

borovikova commented Apr 17, 2020

Uh oh!

NicolasHug left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

borovikova commented Apr 25, 2020

Uh oh!

NicolasHug left a comment

Choose a reason for hiding this comment

Uh oh!

cmarmo left a comment

Choose a reason for hiding this comment

Uh oh!

jnothman left a comment

Choose a reason for hiding this comment

Uh oh!

jnothman Jan 26, 2020

Choose a reason for hiding this comment

Uh oh!

jnothman Jan 26, 2020

Choose a reason for hiding this comment

Uh oh!

jnothman Jan 26, 2020

Choose a reason for hiding this comment

Uh oh!

borovikova Apr 26, 2020

Choose a reason for hiding this comment

Uh oh!

jnothman Apr 25, 2020

Choose a reason for hiding this comment

Uh oh!

jnothman Apr 25, 2020

Choose a reason for hiding this comment

Uh oh!

NicolasHug commented Apr 26, 2020

Uh oh!

Uh oh!

borovikova commented Jan 25, 2020 •

edited

Loading