From 3c772769ff265b5673589c6845fd98921285b919 Mon Sep 17 00:00:00 2001 From: Aline Ribeiro de Almeida Date: Sat, 26 Jun 2021 20:53:50 +0200 Subject: [PATCH 1/7] Remove RandomForestClassifier from DOCSTRING_IGNORE_LIST --- maint_tools/test_docstrings.py | 1 - 1 file changed, 1 deletion(-) diff --git a/maint_tools/test_docstrings.py b/maint_tools/test_docstrings.py index cba5e8dfd2900..38d60b8d7a030 100644 --- a/maint_tools/test_docstrings.py +++ b/maint_tools/test_docstrings.py @@ -165,7 +165,6 @@ "RadiusNeighborsClassifier", "RadiusNeighborsRegressor", "RadiusNeighborsTransformer", - "RandomForestClassifier", "RandomForestRegressor", "RandomTreesEmbedding", "RandomizedSearchCV", From f8026ad8b745a920b3f89744854ef3c164204ddc Mon Sep 17 00:00:00 2001 From: Aline Ribeiro de Almeida Date: Sat, 26 Jun 2021 20:57:17 +0200 Subject: [PATCH 2/7] Fix numpydoc errors RT03, GL08, SA04, GL02, GL03 on RandomForestClassifier --- sklearn/ensemble/_forest.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/sklearn/ensemble/_forest.py b/sklearn/ensemble/_forest.py index 1b880d142cad6..4cffcb5c77e58 100644 --- a/sklearn/ensemble/_forest.py +++ b/sklearn/ensemble/_forest.py @@ -276,7 +276,6 @@ def decision_path(self, X): n_nodes_ptr : ndarray of shape (n_estimators + 1,) The columns from indicator[n_nodes_ptr[i]:n_nodes_ptr[i+1]] gives the indicator value for the i-th estimator. - """ X = self._validate_X_predict(X) indicators = Parallel( @@ -319,6 +318,7 @@ def fit(self, X, y, sample_weight=None): Returns ------- self : object + Fitted estimator. """ # Validate or convert input data if issparse(y): @@ -615,6 +615,12 @@ def feature_importances_(self): ) @property def n_features_(self): + """ The number of features when ``fit`` is performed. + Returns + ------- + n_features_in_ : int + The number of features when ``fit`` is performed. + """ return self.n_features_in_ @@ -1287,7 +1293,8 @@ class labels (multi-output problem). See Also -------- - DecisionTreeClassifier, ExtraTreesClassifier + sklearn.tree.DecisionTreeClassifier : A decision tree classifier. + sklearn.ensemble.ExtraTreesClassifier : An extra-trees classifier. Notes ----- From d3b340849d66395bcb403b878d31dbc3b518aaf8 Mon Sep 17 00:00:00 2001 From: Aline Ribeiro de Almeida Date: Sat, 26 Jun 2021 20:59:44 +0200 Subject: [PATCH 3/7] force decorate property to update doc for deprecated method --- sklearn/utils/deprecation.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sklearn/utils/deprecation.py b/sklearn/utils/deprecation.py index cb2bfc9054c65..2ee07154dc49b 100644 --- a/sklearn/utils/deprecation.py +++ b/sklearn/utils/deprecation.py @@ -98,10 +98,13 @@ def _decorate_property(self, prop): msg = self.extra @property + @functools.wraps(prop) def wrapped(*args, **kwargs): warnings.warn(msg, category=FutureWarning) return prop.fget(*args, **kwargs) + wrapped.__doc__ = self._update_doc(wrapped.__doc__) + return wrapped def _update_doc(self, olddoc): From 5d710cf785fa70ade4f905207eb0e0beab1b828e Mon Sep 17 00:00:00 2001 From: Aline Ribeiro de Almeida Date: Sat, 26 Jun 2021 21:47:19 +0200 Subject: [PATCH 4/7] implement suggested changes --- sklearn/ensemble/_forest.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/sklearn/ensemble/_forest.py b/sklearn/ensemble/_forest.py index 4cffcb5c77e58..85a5820e8b1f7 100644 --- a/sklearn/ensemble/_forest.py +++ b/sklearn/ensemble/_forest.py @@ -615,11 +615,12 @@ def feature_importances_(self): ) @property def n_features_(self): - """ The number of features when ``fit`` is performed. + """Number of features when fitting the estimator. + Returns ------- n_features_in_ : int - The number of features when ``fit`` is performed. + The number of features when fitting the estimator. """ return self.n_features_in_ @@ -1294,7 +1295,7 @@ class labels (multi-output problem). See Also -------- sklearn.tree.DecisionTreeClassifier : A decision tree classifier. - sklearn.ensemble.ExtraTreesClassifier : An extra-trees classifier. + sklearn.ensemble.ExtraTreesClassifier : Ensemble of extremely randomized tree classifiers. Notes ----- From 6c26a2c593b37e6118e69962c458376da2d406b8 Mon Sep 17 00:00:00 2001 From: Aline Ribeiro de Almeida Date: Sat, 26 Jun 2021 22:37:36 +0200 Subject: [PATCH 5/7] add extra line for flake8 --- sklearn/ensemble/_forest.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sklearn/ensemble/_forest.py b/sklearn/ensemble/_forest.py index 85a5820e8b1f7..8db853ac74390 100644 --- a/sklearn/ensemble/_forest.py +++ b/sklearn/ensemble/_forest.py @@ -1295,7 +1295,8 @@ class labels (multi-output problem). See Also -------- sklearn.tree.DecisionTreeClassifier : A decision tree classifier. - sklearn.ensemble.ExtraTreesClassifier : Ensemble of extremely randomized tree classifiers. + sklearn.ensemble.ExtraTreesClassifier : Ensemble of extremely randomized + tree classifiers. Notes ----- From f90833ca446c5fce6f325dde8d38e03da46bea2e Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Tue, 6 Jul 2021 11:56:06 +0200 Subject: [PATCH 6/7] modify property docstring --- sklearn/ensemble/_forest.py | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/sklearn/ensemble/_forest.py b/sklearn/ensemble/_forest.py index 8db853ac74390..166e678654da2 100644 --- a/sklearn/ensemble/_forest.py +++ b/sklearn/ensemble/_forest.py @@ -615,13 +615,7 @@ def feature_importances_(self): ) @property def n_features_(self): - """Number of features when fitting the estimator. - - Returns - ------- - n_features_in_ : int - The number of features when fitting the estimator. - """ + """int : The number of features when fitting the estimator.""" return self.n_features_in_ From 198a321e3b32c6ce58465eab60b619a6d952e512 Mon Sep 17 00:00:00 2001 From: Guillaume Lemaitre Date: Wed, 7 Jul 2021 12:04:08 +0200 Subject: [PATCH 7/7] Apply suggestions from code review --- sklearn/ensemble/_forest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sklearn/ensemble/_forest.py b/sklearn/ensemble/_forest.py index 21ea4d85f5caa..d13cc2391b8e0 100644 --- a/sklearn/ensemble/_forest.py +++ b/sklearn/ensemble/_forest.py @@ -613,7 +613,7 @@ def feature_importances_(self): ) @property def n_features_(self): - """int : The number of features when fitting the estimator.""" + """Number of features when fitting the estimator.""" return self.n_features_in_