put in version_added label for ARDRegression (and many others): Issue #15426 #15482

@@ -113,7 +113,8 @@ class TruncatedSVD(TransformerMixin, BaseEstimator):
    sign of the ``components_`` and the output from transform depend on the
    algorithm and random state. To work around this, fit instances of this
    class to data once, then keep the instance around to do transformations.
-
+
+    ..versionadded:: v0.14


I think we usually don't add the v (here and there is your PR)

This branch is a compilation of several different groups, so it looks like some of them put in v for version, but I agree it shouldn't be there. Should I go through and fix the formatting or is there a better process for handling that?

Yes you should fix them

TomDLT · 2019-11-02T22:09:42Z

sklearn/ensemble/_gb_losses.py

@@ -527,6 +527,8 @@ def _raw_prediction_to_proba(self, raw_predictions):
        -------
        probas : 2d array, shape (n_samples, K)
            The predicted probabilities.
+
+        .. versionadded:: 0.20.3


What is the reason you chose 0.20.3 over 0.20 ?

I can change it to 0.20. I have no idea why 20.3 was chosen.

please do :)

TomDLT · 2019-11-02T22:35:34Z

sklearn/feature_extraction/text.py

@@ -979,6 +979,17 @@ class CountVectorizer(_VectorizerMixin, BaseEstimator):
    The ``stop_words_`` attribute can get large and increase the model size
    when pickling. This attribute is provided only for introspection and can
    be safely removed using delattr or set to None before pickling.
+
+    ..versionchanged:: v0.22
+        Raise warning of parameter choide means the another parameter unused


I am pretty sure we do not want to be that specific, though I don't know what would be a good rule of thumb to pick only the major changes.

Ok I'm going to go through and remove all versionchanged tags, since we were only supposed to put in versionadded (according to the lead developer at our sprint). If we want to add in the versionchanged tags someone should put in a request for that with more details.

Sounds good to me

sklearn/feature_extraction/text.py

sklearn/linear_model/_stochastic_gradient.py

sklearn/model_selection/_split.py

sklearn/dummy.py

TomDLT · 2019-11-03T01:04:46Z

Merging my work with another group's

@@ -0,0 +1,6 @@
+Merge branch 'adding_version' of github.com:alekslovesdata/scikit-learn into adding_version


This file was included in the commit by mistake

TomDLT · 2019-11-03T01:05:01Z

sklearn/dummy.py

-        Accepts non-finite features
-    ..versionadded:: v0.13
+
+    ..versionadded:: 0.13


Suggested change

..versionadded:: 0.13

.. versionadded:: 0.13

TomDLT · 2019-11-03T01:05:38Z

sklearn/cluster/_bicluster.py

@@ -189,6 +189,8 @@ class SpectralCoclustering(BaseSpectral):

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

+    .. version:: 0.14


Suggested change

.. version:: 0.14

.. versionadded:: 0.14

TomDLT · 2019-11-03T01:06:03Z

sklearn/ensemble/_bagging.py

@@ -187,6 +187,8 @@ class BaseBagging(BaseEnsemble, metaclass=ABCMeta):

    Warning: This class should not be used directly. Use derived classes
    instead.
+
+    ..versionadded:: 0.18


Suggested change

..versionadded:: 0.18

.. versionadded:: 0.18

TomDLT · 2019-11-03T01:06:29Z

sklearn/feature_extraction/text.py

@@ -1775,6 +1777,8 @@ def fit(self, raw_documents, y=None):
        Returns
        -------
        self : TfidfVectorizer
+
+            Raise warning if a parameter choice means that another parameter will be unused on calling the fit() method.


Cleaning left over

TomDLT · 2019-11-03T01:06:39Z

sklearn/linear_model/_theil_sen.py

@@ -291,6 +291,8 @@ class TheilSenRegressor(RegressorMixin, LinearModel):
    - Theil-Sen Estimators in a Multiple Linear Regression Model, 2009
      Xin Dang, Hanxiang Peng, Xueqin Wang and Heping Zhang
      http://home.olemiss.edu/~xdang/papers/MTSE.pdf
+
+    ..versionadded:: v0.16


Suggested change

..versionadded:: v0.16

.. versionadded:: v0.16

TomDLT · 2019-11-03T01:06:50Z

sklearn/model_selection/_split.py

@@ -759,6 +763,8 @@ class TimeSeriesSplit(_BaseKFold):
    max_train_size : int, optional
        Maximum size for a single training set.

+        ..versionadded:: 0.19


Suggested change

..versionadded:: 0.19

.. versionadded:: 0.19

This should be above, in the summary section

TomDLT · 2019-11-03T01:07:02Z

sklearn/model_selection/_split.py

@@ -784,6 +790,8 @@ class TimeSeriesSplit(_BaseKFold):
    + n_samples % (n_splits + 1)`` in the ``i``th split,
    with a test set of size ``n_samples//(n_splits + 1)``,
    where ``n_samples`` is the number of samples.
+
+    ..versionadded:: v0.18


Suggested change

..versionadded:: v0.18

.. versionadded:: v0.18

This should be above, in the summary section

TomDLT · 2019-11-03T01:07:21Z

sklearn/naive_bayes.py

@@ -746,6 +746,12 @@ class MultinomialNB(BaseDiscreteNB):
    C.D. Manning, P. Raghavan and H. Schuetze (2008). Introduction to
    Information Retrieval. Cambridge University Press, pp. 234-265.
    https://nlp.stanford.edu/IR-book/html/htmledition/naive-bayes-text-classification-1.html
+
+    ..versionadded:: v0.14
+    ..versionchanged:: v0.16 


Do you want to keep these versionchanged ?

TomDLT · 2019-11-03T01:07:30Z

sklearn/naive_bayes.py

@@ -851,6 +857,8 @@ class ComplementNB(BaseDiscreteNB):
    Tackling the poor assumptions of naive bayes text classifiers. In ICML
    (Vol. 3, pp. 616-623).
    https://people.csail.mit.edu/jrennie/papers/icml03-nb.pdf
+
+    ..versionadded:: v0.20


Suggested change

..versionadded:: v0.20

.. versionadded:: v0.20

glemaitre · 2020-01-09T14:31:37Z

Closing this PR. We put back the estimator in the pool of the main issue for the next sprint.

CirceMcD and others added 30 commits November 2, 2019 11:37

TfidfTransformer versionadded and versionchange annotated

fbbe27a

TheilSenRegressor versionadded

edd84ae

TimeSeriesSplit versionadded and formatting

9801353

TruncatedSVD versionadded

60b20be

put in version_added label: Issue scikit-learn#15426

79903f2

Merge pull request #1 from MZeej/tversions

b8d200d

Tversions

added versionchanged label to TfidfVectorizer

ef7d51f

Revert "added versionchanged label to TfidfVectorizer"

56226ec

This reverts commit ef7d51f.

Revert "Revert "added versionchanged label to TfidfVectorizer""

19deab2

This reverts commit 56226ec.

added versionchanged label to TfidifVectorizer

f19bb78

putting in adding_version label for AffinityPropogation: Issue scikit…

74a473f

…-learn#15426

Merge branch 'version_docstrings' of https://github.com/EricaXia/scik…

6807064

…it-learn into version_docstrings

put in version_added label for RadiusNeighborsClassifier and KNeighbo…

1dd5bba

…rsClassifier: Issue scikit-learn#15426

added versionchanged label to TransformedTargetRegressor

355f83f

add versionchanged label to CheckingClassifier

3c90809

ComplementNB and MultinomialNB

7947a5f

add versionadded label to ClassificationLossFunction

78cf37f

added versionadded label to ClassifierChain

a4c1d59

put in version_added label for BernoulliRBM: Issue scikit-learn#15426

a556f41

put in version_added label for CCA: Issue scikit-learn#15426

f4f4ec8

put in version_added label for CalibratedClassifierCV: Issue scikit-l…

1c7ed7c

…earn#15426

CountVectorizer versionadded

63a9cc8

add versionchanged label to DictVectorizer

360052d

put in version_added label for CategoricalNB: Issue scikit-learn#15426

80d494d

DummyRegressor version added

8ae21cd

Minor correction

c3286d2

Merge pull request scikit-learn#2 from MZeej/tversions

e5044b9

Tversions

Merge pull request scikit-learn#3 from EricaXia/version_docstrings

4aaee26

Version docstrings

put in version_added label for GroupKFold, StratifiedKFold, LeaveOneG…

209b1b8

…roupOut, LeavePGroupsOut: Issue scikit-learn#15426

put in version_added label for VarianceThreshold: Issue scikit-learn#…

05bde40

…15426

alekslovesdata and others added 6 commits November 2, 2019 14:46

Merge pull request #1 from EricaXia/master

e5d7a97

Add versionadded and versionchanged docstrings

put in version_added label for SpectralBiclustering and SpectralCoclu…

d6b9085

…stering: Issue scikit-learn#15426

Merge branch 'adding_version' of github.com:alekslovesdata/scikit-lea…

84f26f3

…rn into adding_version Merging my work with the other group's so that our versionadded labels all get added at the same time.

put in version_added label for SpectralEmbedding: Issue scikit-learn#…

6e696b2

…15426

put in version_added label for BaseBagging: Issue scikit-learn#15426

63bca30

put in version_added label for BaseSGD: Issue scikit-learn#15426

d5e7354

TomDLT reviewed Nov 2, 2019

View reviewed changes

amueller reviewed Nov 2, 2019

View reviewed changes

sklearn/dummy.py Outdated Show resolved Hide resolved

amueller changed the title ~~put in version_added label for ARDRegression: Issue #15426~~ put in version_added label for ARDRegression (and many others): Issue #15426 Nov 2, 2019

formatting changes and responses to comments: Issue scikit-learn#15426

b20e02d

TomDLT reviewed Nov 3, 2019

View reviewed changes

TwsThomas mentioned this pull request Nov 6, 2019

DOC Add version_added label for impute module #15549

Merged

reshamas mentioned this pull request Dec 26, 2019

put in version_added label #15973

Closed

jnothman mentioned this pull request Jan 9, 2020

Label docstrings with versionadded / versionchanged #15426

Closed

glemaitre closed this Jan 9, 2020

		@@ -0,0 +1,6 @@
		Merge branch 'adding_version' of github.com:alekslovesdata/scikit-learn into adding_version

		@@ -189,6 +189,8 @@ class SpectralCoclustering(BaseSpectral):

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

		.. version:: 0.14

Uh oh!

put in version_added label for ARDRegression (and many others): Issue #15426 #15482

put in version_added label for ARDRegression (and many others): Issue #15426 #15482

Uh oh!

Conversation

alekslovesdata commented Nov 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

Uh oh!

TomDLT left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

glemaitre commented Jan 9, 2020

Uh oh!

Uh oh!

alekslovesdata commented Nov 2, 2019 •

edited

Loading