8000 DOC Ensures that SequentialFeatureSelector passes numpydoc validation… · scikit-learn/scikit-learn@66f6fb3 · GitHub
[go: up one dir, main page]

Skip to content

Commit 66f6fb3

Browse files
authored
DOC Ensures that SequentialFeatureSelector passes numpydoc validation (#21035)
1 parent dd738a3 commit 66f6fb3

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

maint_tools/test_docstrings.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@
5151
"SGDOneClassSVM",
5252
"SGDRegressor",
5353
"SelfTrainingClassifier",
54-
"SequentialFeatureSelector",
5554
"SimpleImputer",
5655
"SparseRandomProjection",
5756
"SpectralBiclustering",

sklearn/feature_selection/_sequential.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ class SequentialFeatureSelector(SelectorMixin, MetaEstimatorMixin, BaseEstimator
9797
9898
See Also
9999
--------
100+
GenericUnivariateSelect : Univariate feature selector with configurable
101+
strategy.
100102
RFE : Recursive feature elimination based on importance weights.
101103
RFECV : Recursive feature elimination based on importance weights, with
102104
automatic selection of the number of features.
@@ -139,19 +141,22 @@ def __init__(
139141
self.n_jobs = n_jobs
140142

141143
def fit(self, X, y=None):
142-
"""Learn the features to select.
144+
"""Learn the features to select from X.
143145
144146
Parameters
145147
----------
146148
X : array-like of shape (n_samples, n_features)
147-
Training vectors.
149+
Training vectors, where `n_samples` is the number of samples and
150+
`n_features` is the number of predictors.
151+
148152
y : array-like of shape (n_samples,), default=None
149153
Target values. This parameter may be ignored for
150154
unsupervised learning.
151155
152156
Returns
153157
-------
154158
self : object
159+
Returns the instance itself.
155160
"""
156161
tags = self._get_tags()
157162
X = self._validate_data(

0 commit comments

Comments
 (0)
0