From 57224dcabce1cc4edaf6800eb1c8a377dfcba371 Mon Sep 17 00:00:00 2001 From: Julio Batista Silva Date: Sat, 26 Jun 2021 18:23:12 -0300 Subject: [PATCH 1/6] Remove BaggingClassifier from the docstring ignore list. Addresses #20308 --- 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 5944020883ab5..b7eb98259a984 100644 --- a/maint_tools/test_docstrings.py +++ b/maint_tools/test_docstrings.py @@ -14,7 +14,6 @@ "AdditiveChi2Sampler", "AffinityPropagation", "AgglomerativeClustering", - "BaggingClassifier", "BaggingRegressor", "BayesianGaussianMixture", "BayesianRidge", From f6dbfcb231c21b250ee421f17bafa436c308e38d Mon Sep 17 00:00:00 2001 From: Julio Batista Silva Date: Sat, 26 Jun 2021 18:25:08 -0300 Subject: [PATCH 2/6] Make summary fit in a single line. Addresses #20308 _bagging.py --- sklearn/ensemble/_bagging.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/sklearn/ensemble/_bagging.py b/sklearn/ensemble/_bagging.py index 7c911143f5b68..2fa10b8155f06 100644 --- a/sklearn/ensemble/_bagging.py +++ b/sklearn/ensemble/_bagging.py @@ -235,8 +235,7 @@ def __init__( self.verbose = verbose def fit(self, X, y, sample_weight=None): - """Build a Bagging ensemble of estimators from the training - set (X, y). + """Build a Bagging ensemble of estimators from the training set (X, y). Parameters ---------- From 31184c8be3de46efdf9aa32b113a760e6103a946 Mon Sep 17 00:00:00 2001 From: Julio Batista Silva Date: Sat, 26 Jun 2021 18:26:50 -0300 Subject: [PATCH 3/6] Fix sections order. Addresses #20308 _bagging.py --- sklearn/ensemble/_bagging.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/sklearn/ensemble/_bagging.py b/sklearn/ensemble/_bagging.py index 2fa10b8155f06..a60367ff66be7 100644 --- a/sklearn/ensemble/_bagging.py +++ b/sklearn/ensemble/_bagging.py @@ -604,19 +604,6 @@ class BaggingClassifier(ClassifierMixin, BaseBagging): `oob_decision_function_` might contain NaN. This attribute exists only when ``oob_score`` is True. - Examples - -------- - >>> from sklearn.svm import SVC - >>> from sklearn.ensemble import BaggingClassifier - >>> from sklearn.datasets import make_classification - >>> X, y = make_classification(n_samples=100, n_features=4, - ... n_informative=2, n_redundant=0, - ... random_state=0, shuffle=False) - >>> clf = BaggingClassifier(base_estimator=SVC(), - ... n_estimators=10, random_state=0).fit(X, y) - >>> clf.predict([[0, 0, 0, 0]]) - array([1]) - References ---------- @@ -632,6 +619,19 @@ class BaggingClassifier(ClassifierMixin, BaseBagging): .. [4] G. Louppe and P. Geurts, "Ensembles on Random Patches", Machine Learning and Knowledge Discovery in Databases, 346-361, 2012. + + Examples + -------- + >>> from sklearn.svm import SVC + >>> from sklearn.ensemble import BaggingClassifier + >>> from sklearn.datasets import make_classification + >>> X, y = make_classification(n_samples=100, n_features=4, + ... n_informative=2, n_redundant=0, + ... random_state=0, shuffle=False) + >>> clf = BaggingClassifier(base_estimator=SVC(), + ... n_estimators=10, random_state=0).fit(X, y) + >>> clf.predict([[0, 0, 0, 0]]) + array([1]) """ def __init__( From 6894a1c798a6603f3d1907f73966a3ff1ce59414 Mon Sep 17 00:00:00 2001 From: Julio Batista Silva Date: Sat, 26 Jun 2021 18:27:39 -0300 Subject: [PATCH 4/6] Remove double line break. Addresses #20308 _bagging.py --- sklearn/ensemble/_bagging.py | 1 - 1 file changed, 1 deletion(-) diff --git a/sklearn/ensemble/_bagging.py b/sklearn/ensemble/_bagging.py index a60367ff66be7..9cd7ba9aed8ee 100644 --- a/sklearn/ensemble/_bagging.py +++ b/sklearn/ensemble/_bagging.py @@ -865,7 +865,6 @@ def decision_function(self, X): to the classes in sorted order, as they appear in the attribute ``classes_``. Regression and binary classification are special cases with ``k == 1``, otherwise ``k==n_classes``. - """ check_is_fitted(self) From 5ba6a8e828f6842c790591347ab4ee7a444a5355 Mon Sep 17 00:00:00 2001 From: Julio Batista Silva Date: Sat, 26 Jun 2021 18:28:02 -0300 Subject: [PATCH 5/6] Add See Also section. Addresses #20308 _bagging.py --- sklearn/ensemble/_bagging.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sklearn/ensemble/_bagging.py b/sklearn/ensemble/_bagging.py index 9cd7ba9aed8ee..fe27213de988a 100644 --- a/sklearn/ensemble/_bagging.py +++ b/sklearn/ensemble/_bagging.py @@ -604,6 +604,10 @@ class BaggingClassifier(ClassifierMixin, BaseBagging): `oob_decision_function_` might contain NaN. This attribute exists only when ``oob_score`` is True. + See Also + -------- + BaggingRegressor : A Bagging regressor. + References ---------- From 871ebf9724c02c0f54cb93477dac78f9f09d464d Mon Sep 17 00:00:00 2001 From: Julio Batista Silva Date: Sat, 26 Jun 2021 18:28:43 -0300 Subject: [PATCH 6/6] Add descriptions to the Return sections. Addresses #20308 _bagging.py --- sklearn/ensemble/_bagging.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/sklearn/ensemble/_bagging.py b/sklearn/ensemble/_bagging.py index fe27213de988a..bebfe8a4850f3 100644 --- a/sklearn/ensemble/_bagging.py +++ b/sklearn/ensemble/_bagging.py @@ -255,6 +255,7 @@ def fit(self, X, y, sample_weight=None): Returns ------- self : object + Fitted estimator. """ return self._fit(X, y, self.max_samples, sample_weight=sample_weight) @@ -290,6 +291,7 @@ def _fit(self, X, y, max_samples=None, max_depth=None, sample_weight=None): Returns ------- self : object + Fitted estimator. """ random_state = check_random_state(self.random_state)