Ensure that docstrings pass numpydoc validation #20308
Description
- Make sure you have the development dependencies and documentation dependencies installed.
- Pick an estimator from the list below and leave a comment saying you are going to work on it. This way we can keep track of what everyone is working on.
- Remove the estimator from the list at:
- Let's say you picked
StandardScaler, run numpydoc validation as follows (Adding the-at the end helps with the regex).
pytest maint_tools/test_docstrings.py -k StandardScaler-
- If you see failing test, please fix them by following the recommendation provided by the failing test.
- If you see all the tests past, you do not need to do any additional changes.
- Commit your changes.
- Open a Pull Request with an opening message
Addresses #20308. Note that each item should be submitted in a separate Pull Request. - Include the estimator name in the title of the pull request. For example: "DOC Ensures that StandardScaler passes numpydoc validation".
- DOC Ensures that ARDRegression passes numpydoc validation #20381 ARDRegression
- DOC Ensures that AdaBoostClassifier passes numpydoc validation #20374 AdaBoostClassifier
- DOC Ensures that AdaBoostRegressor passes numpydoc validation #20400 AdaBoostRegressor
- DOC Ensures that AdditiveChi2Sampler passes numpydoc validation #20536 AdditiveChi2Sampler
- DOC Ensures that AffinityPropagation passes numpydoc validation #20532 AffinityPropagation
- DOC Ensures that AgglomerativeClustering passes numpydoc validation #20544 AgglomerativeClustering
- DOC Ensures that BaggingClassifier passes numpydoc validation #20377 #20407 BaggingClassifier
- DOC Ensures that BaggingRegressor passes numpydoc validation #20498 BaggingRegressor
- DOC Ensures BayesianGaussianMixture docstring passes numpydoc validation #20384 BayesianGaussianMixture
- DOC Ensures that BayesianRidge passes numpydoc validation #20389 BayesianRidge
- BernoulliNB
- DOC Ensures that BernoulliRBM passes numpydoc validation #20533 BernoulliRBM
- DOC Ensures that Binarizer passes numpydoc validation #20422 Binarizer
- Birch
- DOC Ensures that CCA passes numpydoc validation #20504 CCA
- CalibratedClassifierCV
- DOC Ensures that CategoricalNB passes numpydoc validation #20445 CategoricalNB
- ClassifierChain
- ColumnTransformer
- DOC ensure Naive Bayes classes passes numpydoc validation #20440 ComplementNB
- DOC Ensures numpydoc validation for CountVectorizer and TfidfVectorizer/Transformer #20403 CountVectorizer
- DOC ensures DBSCAN docstring passes numpydoc validation #20375 DBSCAN
- DOC Ensures DecisionTreeClassifier passes numpydoc validation #20399 DecisionTreeClassifier
- DecisionTreeRegressor
- DictVectorizer
- DictionaryLearning
- DummyClassifier
- DOC Ensures that DummyRegressor passes numpydoc validation #20394 DummyRegressor
- DOC Ensures that ElasticNet passes numpydoc validation #20454 ElasticNet
- ElasticNetCV
- DOC Ensures that EllipticEnvelope passes numpydoc validation #20548 EllipticEnvelope
- DOC Ensures that EmpiricalCovariance passes numpydoc validation #20551 EmpiricalCovariance
- ExtraTreeClassifier
- ExtraTreeRegressor
- ExtraTreesClassifier
- ExtraTreesRegressor
- FactorAnalysis
- DOC ensures FastICA estimator pass the numpydoc validation #20405 FastICA
- FeatureAgglomeration
- FeatureHasher
- FeatureUnion
- FunctionTransformer
- GammaRegressor
- GaussianMixture
- DOC ensure Naive Bayes classes passes numpydoc validation #20440 GaussianNB
- GaussianProcessClassifier
- GaussianProcessRegressor
- GaussianRandomProjection
- DOC Ensures that GenericUnivariateSelect passes numpydoc validation #20495 GenericUnivariateSelect
- GradientBoostingClassifier
- GradientBoostingRegressor
- DOC Ensures that GraphicalLasso passes numpydoc validation #20527 GraphicalLasso
- DOC Ensures that GraphicalLassoCV passes numpydoc validation #20546 GraphicalLassoCV
- GridSearchCV
- HalvingGridSearchCV
- HalvingRandomSearchCV
- HashingVectorizer
- HistGradientBoostingClassifier
- HistGradientBoostingRegressor
- HuberRegressor
- IncrementalPCA
- DOC ensure IsolationForest passes numpydoc #20437 IsolationForest
- Isomap
- DOC Ensures that IsotonicRegression passes numpydoc validation #20514 IsotonicRegression
- IterativeImputer
- KBinsDiscretizer
- DOC Ensures that KMeans passes numpydoc validation #20377 KMeans
- KNNImputer
- DOC Fixes numpydoc validation errors in KNeighborsClassifier #20373 KNeighborsClassifier
- DOC Ensures that K/RadiusNeighborsRegressor passes numpydoc validation #20378 KNeighborsRegressor
- KNeighborsTransformer
- KernelCenterer
- KernelDensity
- KernelPCA
- KernelRidge
- LabelBinarizer
- DOC Ensures LabelEncoder passes numpydoc validation #20456 LabelEncoder
- LabelPropagation
- LabelSpreading
- DOC Ensures that Lars passes numpydoc validation #20472 Lars
- DOC Ensures that LarsCV passes numpydoc validation #20501 LarsCV
- DOC Ensures Lasso passes numpydoc validation #20409 Lasso
- DOC Ensures that LassoCV passes numpydoc validation #20453 LassoCV
- DOC Ensures that LassoLars passes numpydoc validation #20459 LassoLars
- DOC Ensures that LassoLarsCV passes numpydoc validation #20462 LassoLarsCV
- DOC Ensures that LassoLarsIC passes numpydoc validation #20465 LassoLarsIC
- DOC Ensures that LatentDirichletAllocation passes numpydoc validation #20402 LatentDirichletAllocation
- DOC Ensures that LedoitWolf passes numpydoc validation #20578 LedoitWolf
- LinearDiscriminantAnalysis
- DOC Ensures that LinearRegression passes numpydoc validation #20369 LinearRegression
- DOC Ensures that LinearSVC passes numpydoc validation #20458 LinearSVC
- LinearSVR
- LocalOutlierFactor
- LocallyLinearEmbedding
- DOC Ensures that LogisticRegression passes numpydoc validation #20370 LogisticRegression
- DOC Ensures that LogisticRegressionCV passes numpydoc validation #20376 LogisticRegressionCV
- MDS
- DOC Ensures that MLPClassifier passes numpydoc validation #20444 MLPClassifier
- MLPRegressor
- DOC Ensures MaxAbsScaler passes numpydoc validation #20455 MaxAbsScaler
- MeanShift
- DOC Ensures that MinCovDet passes numpydoc validation #20580 MinCovDet
- MinMaxScaler
- MiniBatchDictionaryLearning
- MiniBatchKMeans
- MiniBatchSparsePCA
- MissingIndicator
- MultiLabelBinarizer
- MultiOutputClassifier
- MultiOutputRegressor
- MultiTaskElasticNet
- MultiTaskElasticNetCV
- MultiTaskLasso
- MultiTaskLassoCV
- DOC ensure Naive Bayes classes passes numpydoc validation #20440 MultinomialNB
- NMF
- NearestCentroid
- DOC Ensures that NearestNeighbors passes numpydoc validation #20446 NearestNeighbors
- NeighborhoodComponentsAnalysis
- Normalizer
- DOC Ensures that NuSVC passes numpydoc validation #20461 NuSVC
- NuSVR
- Nystroem
- DOC Ensures that OAS passes numpydoc validation #20579 OAS
- OPTICS
- DOC Ensures that OneClassSVM passes numpydoc validation #20463 OneClassSVM
- DOC Ensures that OneHotEncoder passes numpydoc validation #20406 OneHotEncoder
- OneVsOneClassifier
- OneVsRestClassifier
- OrdinalEncoder
- OrthogonalMatchingPursuit
- OrthogonalMatchingPursuitCV
- OutputCodeClassifier
- PCA
- PLSCanonical
- PLSRegression
- PLSSVD
- PassiveAggressiveClassifier
- PassiveAggressiveRegressor
- PatchExtractor
- DOC Ensures that Perceptron passes numpydoc validation #20404 Perceptron
- Pipeline
- DOC Ensures that PoissonRegressor passes numpydoc validation #20386 PoissonRegressor
- PolynomialCountSketch
- PolynomialFeatures
- PowerTransformer
- QuadraticDiscriminantAnalysis
- QuantileRegressor
- QuantileTransformer
- RANSACRegressor
- RBFSampler
- DOC Ensures that RFE passes numpydoc validation #20419 RFE
- DOC Ensures that RFECV passes numpydoc validation #20452 RFECV
- RadiusNeighborsClassifier
- RadiusNeighborsRegressor
- RadiusNeighborsTransformer
- DOC Ensures that RandomForestClassifier passes numpydoc validation #20383 RandomForestClassifer
- RandomForestRegressor
- RandomTreesEmbedding
- RandomizedSearchCV
- RegressorChain
- DOC Ensures that Ridge passes numpydoc validation #20499 Ridge
- DOC Ensures that RidgeCV passes numpydoc validation #20503 RidgeCV
- RidgeClassifier
- RidgeClassifierCV
- RobustScaler
- SGDOneClassSVM
- SGDRegressor
- DOC Ensures that SVC passes numpydoc validation #20457 SVC
- SVR
- SelectFdr
- SelectFpr
- SelectFromModel
- SelectFwe
- SelectKBest
- SelectPercentile
- DOC Ensures that SelfTrainingClassifier passes numpydoc validation #21277 SelfTrainingClassifier
- SequentialFeatureSelector
- DOC Ensures that ShrunkCovariance passes numpydoc validation #20571 ShrunkCovariance
- SimpleImputer
- SkewedChi2Sampler
- SparseCoder
- DOC ensures SparsePCA docstring passes numpydoc validation #20395 SparsePCA
- SparseRandomProjection
- SpectralBiclustering
- SpectralClustering
- SpectralCoclustering DOC Ensures that SpectralCoclustering passes numpydoc validation #21463
- SpectralEmbedding
- SplineTransformer
- StackingClassifier
- StackingRegressor
- DOC Fixes numpydoc validation errors in StandardScalar #20368 StandardScalar
- TSNE
- DOC Ensures that TfidfTransformer passes numpydoc validation #20379 TfidfVectorizer
- TheilSenRegressor
- TransformedTargetRegressor
- TruncatedSVD
- TweedieRegressor
- VarianceThreshold
- VotingClassifier
- DOC Ensures that VotingRegressor passes numpydoc validation #20450 VotingRegressor