Label docstrings with versionadded / versionchanged #15426

jnothman · 2019-11-01T02:33:57Z

We should be using Sphinx's versionadded and versionchanged directives to indicate when classes, functions, methods and parameters are added or modified in their semantics. We are not very good at ensuring this labelling is done.

Towards the upcoming release of v0.22, it would be useful if some contributors (or sprinters) scoured the change log and identified whether any added/changed parameters/classes needed a versionadded or versionchanged label, and to produce pull requests adding them when otherwise omitted.

I also note past omissions, for example KBinsDiscretizer and IterativeImputer do not mention their versionadded, while ColumnTransformer does. Recording for each estimator when it was first released would be helpful for users when looking at the documentation.

Suggested procedure

Check the changelog in doc/whats_new/ one what's a new file at a time.
**Make a single PR for an estimator and a specific version. Do not include multiple estimators and multiple versions at once (it makes it difficult to review).

Focus on Public API: if a method has been made private, check the tickbox and move to another.

.. versionadded:: 0.xx

should be included only for new estimators/parameters

.. versionchanged:: 0.xx
   `param_xxx` change from 'xx' to 'yy'

should be included when the default value of a parameter change.

Classes lacking label

The list may be incomplete.

The text was updated successfully, but these errors were encountered:

jnothman · 2019-11-01T02:42:55Z

@rth, please feel free to add a Sprint tag if you think this is suitable...

Btw, these classes appear to lack a versionadded... not sure though that we want to add to all of them (and I've not filtered private classes out): ARDRegression, AdaBoostClassifier, AdaBoostRegressor, AdamOptimizer, AdditiveChi2Sampler, AffinityPropagation, AgglomerationTransform, BaggingRegressor, BaseBagging, BaseCrossValidator, BaseDecisionTree, BaseDiscreteNB, BaseEnsemble, BaseForest, BaseGradientBoosting, BaseHistGradientBoosting, BaseLabelPropagation, BaseLibSVM, BaseLoss, BaseMixture, BaseNB, BaseRandomProjection, BaseSGD, BaseSVC, BaseSearchCV, BaseShuffleSplit, BaseSpectral, BaseWeightBoosting, BernoulliNB, BernoulliRBM, Binarizer, BinaryCrossEntropy, BinomialDeviance, BinomialDeviance, Birch, Bunch, CCA, CalibratedClassifierCV, CategoricalCrossEntropy, CategoricalNB, ChangedBehaviorWarning, CheckingClassifier, ClassificationLossFunction, ClassificationLossFunction, ClassifierChain, ComplementNB, ConvergenceWarning, CountVectorizer, DataConversionWarning, DataDimensionalityWarning, DictVectorizer, DummyRegressor, ElasticNet, ElasticNetCV, EllipticEnvelope, EmpiricalCovariance, ExponentialLoss, ExponentialLoss, FactorAnalysis, FastICA, FeatureHasher, FeatureUnion, FitFailedWarning, ForestClassifier, ForestRegressor, GaussianNB, GaussianRandomProjection, GenericUnivariateSelect, GraphicalLasso, GraphicalLassoCV, GridSearchCV, GroupKFold, HistGradientBoostingClassifier, HistGradientBoostingRegressor, HuberLossFunction, HuberLossFunction, IncrementalPCA, IsotonicRegression, IterativeImputer, KBinsDiscretizer, KFold, KMeans, KNeighborsClassifier, KNeighborsRegressor, KernelCenterer, KernelDensity, KernelRidge, KeyValTuple, KeyValTupleParam, LabelBinarizer, LabelEncoder, LabelPropagation, LabelSpreading, Lars, LarsCV, Lasso, LassoCV, LassoLars, LassoLarsCV, LassoLarsIC, LeastAbsoluteDeviation, LeastAbsoluteError, LeastAbsoluteError, LeastSquares, LeastSquaresError, LeastSquaresError, LeaveOneGroupOut, LeaveOneOut, LeavePGroupsOut, LeavePOut, LedoitWolf, LinearClassifierMixin, LinearModel, LinearModelCV, LinearRegression, LinearSVC, LinearSVR, LocalOutlierFactor, LocallyLinearEmbedding, LossFunction, LossFunction, MDS, MinCovDet, MiniBatchKMeans, MissingIndicator, Module_six_moves_urllib, Module_six_moves_urllib_error, Module_six_moves_urllib_parse, Module_six_moves_urllib_request, Module_six_moves_urllib_response, Module_six_moves_urllib_robotparser, MultiLabelBinarizer, MultiOutputClassifier, MultiOutputRegressor, MultiTaskElasticNet, MultiTaskElasticNetCV, MultiTaskLasso, MultiTaskLassoCV, MultinomialDeviance, MultinomialDeviance, MultinomialNB, NearestCentroid, NearestNeighbors, NeighborhoodComponentsAnalysis, NeighborsBase, NoSampleWeightWrapper, NonBLASDotWarning, Normalizer, NotFittedError, NuSVR, Nystroem, OAS, OPTICS, OneClassSVM, OneHotEncoder, OneVsOneClassifier, OneVsRestClassifier, OrdinalEncoder, OrthogonalMatchingPursuit, OrthogonalMatchingPursuitCV, OutputCodeClassifier, PLSCanonical, PLSRegression, PLSSVD, PatchExtractor, Pipeline, PowerTransformer, PredefinedSplit, QuantileLossFunction, QuantileLossFunction, QuantileTransformer, RBFSampler, RFE, RFECV, RadiusNeighborsClassifier, RadiusNeighborsRegressor, RandomizedSearchCV, RegressionLossFunction, RegressionLossFunction, RegressorChain, RepeatedKFold, RepeatedStratifiedKFold, RidgeCV, RidgeClassifierCV, SGDOptimizer, SVR, ScaledLogOddsEstimator, SelectFdr, SelectFpr, SelectFwe, SelectKBest, SelectPercentile, SelectorMixin, ShrunkCovariance, ShuffleSplit, SkewedChi2Sampler, SkipTestWarning, SparseCodingMixin, SparseRandomProjection, SpectralBiclustering, SpectralClustering, SpectralCoclustering, SpectralEmbedding, StratifiedKFold, StratifiedShuffleSplit, TfidfTransformer, TfidfVectorizer, TheilSenRegressor, TimeSeriesSplit, TransformedTargetRegressor, TruncatedSVD, UndefinedMetricWarning, VarianceThreshold

rth · 2019-11-01T04:08:56Z

Thanks @jnothman !

natashaborders-zz · 2019-11-02T17:41:30Z

I'll work on AdaBoostClassifier, AdaBoostRegressor.
Put in a pull request.

alekslovesdata · 2019-11-02T17:41:32Z

LIST OF STUFF I SUBMITTED PULL REQUESTS FOR:
ARDRegression
AffinityPropogation
KNeighborsClassifier
RadiusNeighborsClassifier
BernoulliRBM
CCA
CalibratedClassifierCV
CategoricalNB
GroupKFold
StratifiedKFold
LeaveOneGroupOut
LeavePGroupsOut
VarianceThreshold
SpectralBiclustering
SpectralCoclustering
SpectralEmbedding
BaseBagging
BaseSGD

Ongoing Progress:

lotusea · 2019-11-02T18:14:57Z

@lotusea worked on KernelRidge, AgglomerativeClustering

EricaXia · 2019-11-02T18:19:57Z

@EricaXia @Mzeej are working on TfidfTransformer, TfidfVectorizer, TheilSenRegressor, TimeSeriesSplit, TransformedTargetRegressor, TruncatedSVD

geoninja · 2019-11-02T18:36:34Z

@geoninja is working on 'OrdinalEncoder' and 'OneHotEncoder' and LabelEncoder'

harini-sridhar · 2019-11-02T19:04:06Z

@Drajan and I are working on PLSCanonical, PLSRegression, PLSSVD, PatchExtractor, Pipeline, PowerTransformer, PredefinedSplit.

natashaborders-zz · 2019-11-02T19:22:24Z

Going to work on BaggingRegressor, BaseBagging, BaseCrossValidator, BaseDecisionTree, BaseDiscreteNB, BaseEnsemble, BaseForest, BaseGradientBoosting, BaseHistGradientBoosting, BaseLabelPropagation, BaseLibSVM, BaseLoss, BaseMixture, BaseNB, BaseRandomProjection, BaseSGD, BaseSVC, BaseSearchCV, BaseShuffleSplit, BaseSpectral, BaseWeightBoosting.

ghost · 2019-11-02T19:24:13Z

@Mzeej @EricaXia Going to work on:

CheckingClassifier, ClassificationLossFunction, ClassificationLossFunction, ClassifierChain, ComplementNB, ConvergenceWarning, CountVectorizer

…-learn#15426

…learn#15426)

…n, PLSSVD, PatchExtractor, Pipeline, PowerTransformer, PredefinedSplit (Issue scikit-learn#15426)

ghost · 2019-11-02T20:16:07Z

Please see ongoing list of items which versioning is being added during the WiMLDS sprint:

https://tinyurl.com/y57jsvbg

I think we should merge all our changes into one branch and submit a single PR to the reviewers from the account of someone who can commit to addressing any comments the reviewers have.

…rsClassifier: Issue scikit-learn#15426

ghost · 2019-11-02T20:27:30Z

Claiming MultinomialNB

EricaXia · 2019-11-02T21:00:02Z

Working on DataConversionWarning, DataDimensionalityWarning, DictVectorizer , DummyRegressor

…earn#15426

natashaborders-zz · 2019-11-02T21:06:17Z

LocalOutlierFactor

jnothman · 2019-11-30T10:59:35Z

But we should label one version at a time rather than one module at a time, I now reckon

glemaitre · 2020-01-09T13:16:32Z

@cmarmo I updated the list on the top.

cmarmo · 2020-01-09T14:11:55Z

@cmarmo I updated the list on the top.

Thanks!

alhewpl · 2020-01-21T19:33:37Z

Could @Schindst and I work on the LinearClassifierMixin, LinearModel, LinearRegression?

jnothman · 2020-01-21T20:33:46Z

I think it is better to work version (perhaps split by subpackage) by version than class by class.

alhewpl · 2020-01-25T09:19:00Z

ok, we'll take v0.21 - with @Schindst

borovikova · 2020-01-25T10:06:00Z

We will work on v0.20.0 with @ellenkoenig

brigitteunger · 2020-01-25T10:24:42Z

We (@shravaniCD and @hhnnhh and @brigitteunger ) are going to take care of those:
#WiMLDS @noatamir
HistGradientBoostingClassifier
HistGradientBoostingRegressor

Was already fixed here: natashaborders/scikit-learn@3ca653a

adrinjalali · 2020-01-25T10:48:03Z

As a reminder, people who take on this issue, please take on a version (the changelog for v0.18 for instance), and tackle everything mentioned there, instead of working on classes or files or modules. This makes the review process much easier.

brigitteunger · 2020-01-25T10:56:39Z

We (@shravaniCD and @hhnnhh and @brigitteunger) are going to pick v0.18

noatamir · 2020-01-25T12:25:42Z

I'm starting to work on v0.19

@adrinjalali

Towards scikit-learn#15426 @adrinjalali #wimlds #scikitlearnsprint

noatamir · 2020-04-08T12:52:32Z

@jnothman or @adrinjalali do you know which versions still need documentation or are all the major ones done/in progress?

I can start another one or pick one up but I’m not sure how far back it makes sense to go and the original list isn’t up-to-date (or relevant?!) anymore..

adrinjalali · 2020-04-08T15:37:51Z

I think we've covered most of the relevant ones. I personally wouldn't worry about anything older than 0.18

@adrinjalali

* added v0.19.1 and wip v0.19 * finished adding vchanged strings for v0.19 Towards #15426 @adrinjalali #wimlds #scikitlearnsprint * fixing linter issues * caught line issues with flake8 * caught the last line issue * added lines and cleaned gtiignore * Update sklearn/multiclass.py Co-Authored-By: Thomas J Fan <[email protected]> * Update sklearn/multiclass.py Co-Authored-By: Thomas J Fan <[email protected]> Co-authored-by: Thomas J Fan <[email protected]>

cmarmo · 2020-05-11T08:32:00Z

The issue has been addressed until version 0.18. I'm closing it. Feel free to open a new one for specific sklearn features.

@adrinjalali

* added v0.19.1 and wip v0.19 * finished adding vchanged strings for v0.19 Towards scikit-learn#15426 @adrinjalali #wimlds #scikitlearnsprint * fixing linter issues * caught line issues with flake8 * caught the last line issue * added lines and cleaned gtiignore * Update sklearn/multiclass.py Co-Authored-By: Thomas J Fan <[email protected]> * Update sklearn/multiclass.py Co-Authored-By: Thomas J Fan <[email protected]> Co-authored-by: Thomas J Fan <[email protected]>

jnothman added Documentation good first issue Easy with clear instructions to resolve help wanted labels Nov 1, 2019

rth added the Sprint label Nov 1, 2019

natashaborders-zz mentioned this issue Nov 2, 2019

scikit-learn#15426 adding versionadded labels (part of the list included with the issue) #15476

Merged

alekslovesdata added a commit to alekslovesdata/scikit-learn that referenced this issue Nov 2, 2019

put in version_added label: Issue scikit-learn#15426

79903f2

alekslovesdata added a commit to alekslovesdata/scikit-learn that referenced this issue Nov 2, 2019

putting in adding_version label for AffinityPropogation: Issue scikit…

74a473f

…-learn#15426

harini-sridhar added a commit to harini-sridhar/scikit-learn that referenced this issue Nov 2, 2019

Added Sphinx versionadded to TimeSeriesSplit docstring (Issue scikit-…

a3e6d43

…learn#15426)

harini-sridhar added a commit to harini-sridhar/scikit-learn that referenced this issue Nov 2, 2019

Added Sphinx versionadded to docstrings of PLSCanonical, PLSRegressio…

baccef5

…n, PLSSVD, PatchExtractor, Pipeline, PowerTransformer, PredefinedSplit (Issue scikit-learn#15426)

harini-sridhar mentioned this issue Nov 2, 2019

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

Closed

alekslovesdata added a commit to alekslovesdata/scikit-learn that referenced this issue Nov 2, 2019

put in version_added label for RadiusNeighborsClassifier and KNeighbo…

1dd5bba

…rsClassifier: Issue scikit-learn#15426

natashaborders-zz pushed a commit to natashaborders-zz/scikit-learn that referenced this issue Nov 2, 2019

Fixing Issue scikit-learn#15426 (Bagging Regressor, Bagging Classifier)

1ef4391

alekslovesdata mentioned this issue Nov 2, 2019

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

Closed

alekslovesdata added a commit to alekslovesdata/scikit-learn that referenced this issue Nov 2, 2019

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

a556f41

alekslovesdata added a commit to alekslovesdata/scikit-learn that referenced this issue Nov 2, 2019

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

f4f4ec8

alekslovesdata added a commit to alekslovesdata/scikit-learn that referenced this issue Nov 2, 2019

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

1c7ed7c

…earn#15426

reshamas mentioned this issue Dec 9, 2019

[MRG] DOC add versionadded directive to some estimators #15849

Merged

reshamas mentioned this issue Dec 26, 2019

put in version_added label #15973

Closed

cmarmo mentioned this issue Jan 9, 2020

adding versionadded to a few modules #16015

Closed

adrinjalali mentioned this issue Jan 25, 2020

[WIP] DOC fix default values in isotonic.py #16198

Merged

borovikova mentioned this issue Jan 25, 2020

DOC Add versionchanged and versionadded for v0.20 #16199

Merged

alhewpl mentioned this issue Jan 25, 2020

added versionadded 0.21 and versionchanged 0.21 where applicable, aft… #16214

Closed

brigitteunger mentioned this issue Jan 25, 2020

[MRG] DOC Version added and changed labels added for v0.18 (#wimlds) #16222

Merged

noatamir mentioned this issue Jan 25, 2020

[MRG] DOC add versionadded versionchanged v0.19 #16233

Merged

noatamir added a commit to noatamir/scikit-learn that referenced this issue Feb 25, 2020

finished adding vchanged strings for v0.19

167bb1a

Towards scikit-learn#15426 @adrinjalali #wimlds #scikitlearnsprint

Reksbril mentioned this issue Mar 21, 2020

[MRG] DOC add versionadded versionchanged for 0.21 #16737

Merged

reshamas mentioned this issue May 8, 2020

Label docstrings with versionadded / versionchanged data-umbrella/data-umbrella-scikit-learn-sprint#1

Closed

cmarmo closed this as completed May 11, 2020

cmarmo mentioned this issue May 13, 2020

ENH Add parameter in colorbar in plot_confusion_matrix #17192

Merged

thomasjpfan mentioned this issue Apr 8, 2021

[ MRG | doc | #15426 | KernelRidge, AgglomerativeClustering ] #15518

Closed

Uh oh!

Label docstrings with versionadded / versionchanged #15426

Label docstrings with versionadded / versionchanged #15426

Comments

jnothman commented Nov 1, 2019 • edited by glemaitre Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Suggested procedure

Classes lacking label

jnothman commented Nov 1, 2019

Uh oh!

rth commented Nov 1, 2019

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

EricaXia commented Nov 2, 2019

Uh oh!

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

Uh oh!

Uh oh!

harini-sridhar commented Nov 2, 2019

Uh oh!

natashaborders-zz commented Nov 2, 2019

Uh oh!

ghost commented Nov 2, 2019

Uh oh!

ghost commented Nov 2, 2019

Uh oh!

ghost commented Nov 2, 2019

Uh oh!

EricaXia commented Nov 2, 2019

Uh oh!

natashaborders-zz commented Nov 2, 2019

Uh oh!

jnothman commented Nov 30, 2019 via email

Uh oh!

glemaitre commented Jan 9, 2020

Uh oh!

cmarmo commented Jan 9, 2020

Uh oh!

alhewpl commented Jan 21, 2020

Uh oh!

jnothman commented Jan 21, 2020 via email

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

adrinjalali commented Jan 25, 2020

Uh oh!

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

Uh oh!

Uh oh!

noatamir commented Jan 25, 2020

Uh oh!

noatamir commented Apr 8, 2020

Uh oh!

adrinjalali commented Apr 8, 2020

Uh oh!

cmarmo commented May 11, 2020

Uh oh!

jnothman commented Nov 1, 2019 •

edited by glemaitre

Loading

natashaborders-zz commented Nov 2, 2019 •

edited

Loading

alekslovesdata commented Nov 2, 2019 •

edited

Loading

lotusea commented Nov 2, 2019 •

edited

Loading

geoninja commented Nov 2, 2019 •

edited

Loading

alhewpl commented Jan 25, 2020 •

edited

Loading

borovikova commented Jan 25, 2020 •

edited

Loading

brigitteunger commented Jan 25, 2020 •

edited

Loading

brigitteunger commented Jan 25, 2020 •

edited

Loading