Skip to content

Commit 6c381f0

Browse files
DOC fix grammatical errors in AdaBoost docstrings (scikit-learn#34355)
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
1 parent e504dc6 commit 6c381f0

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

sklearn/ensemble/_weight_boosting.py

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -640,8 +640,8 @@ def decision_function(self, X):
640640
-------
641641
score : ndarray of shape of (n_samples, k)
642642
The decision function of the input samples. The order of
643-
outputs is the same as that of the :term:`classes_` attribute.
644-
Binary classification is a special cases with ``k == 1``,
643+
outputs is the same as in the :term:`classes_` attribute.
644+
Binary classification is a special case with ``k == 1``,
645645
otherwise ``k==n_classes``. For binary classification,
646646
values closer to -1 or 1 mean more like the first or second
647647
class in ``classes_``, respectively.
@@ -686,8 +686,8 @@ def staged_decision_function(self, X):
686686
------
687687
score : generator of ndarray of shape (n_samples, k)
688688
The decision function of the input samples. The order of
689-
outputs is the same of that of the :term:`classes_` attribute.
690-
Binary classification is a special cases with ``k == 1``,
689+
outputs is the same as in the :term:`classes_` attribute.
690+
Binary classification is a special case with ``k == 1``,
691691
otherwise ``k==n_classes``. For binary classification,
692692
values closer to -1 or 1 mean more like the first or second
693693
class in ``classes_``, respectively.
@@ -757,7 +757,7 @@ def predict_proba(self, X):
757757
-------
758758
p : ndarray of shape (n_samples, n_classes)
759759
The class probabilities of the input samples. The order of
760-
outputs is the same of that of the :term:`classes_` attribute.
760+
outputs is the same as in the :term:`classes_` attribute.
761761
"""
762762
check_is_fitted(self)
763763
n_classes = self.n_classes_
@@ -790,7 +790,7 @@ def staged_predict_proba(self, X):
790790
------
791791
p : generator of ndarray of shape (n_samples,)
792792
The class probabilities of the input samples. The order of
793-
outputs is the same of that of the :term:`classes_` attribute.
793+
outputs is the same as in the :term:`classes_` attribute.
794794
"""
795795

796796
n_classes = self.n_classes_
@@ -815,21 +815,21 @@ def predict_log_proba(self, X):
815815
-------
816816
p : ndarray of shape (n_samples, n_classes)
817817
The class probabilities of the input samples. The order of
818-
outputs is the same of that of the :term:`classes_` attribute.
818+
outputs is the same as in the :term:`classes_` attribute.
819819
"""
820820
return np.log(self.predict_proba(X))
821821

822822

823823
class AdaBoostRegressor(_RoutingNotSupportedMixin, RegressorMixin, BaseWeightBoosting):
824824
"""An AdaBoost regressor.
825825
826-
An AdaBoost [1] regressor is a meta-estimator that begins by fitting a
826+
An AdaBoost [1]_ regressor is a meta-estimator that begins by fitting a
827827
regressor on the original dataset and then fits additional copies of the
828828
regressor on the same dataset but where the weights of instances are
829829
adjusted according to the error of the current prediction. As such,
830830
subsequent regressors focus more on difficult cases.
831831
832-
This class implements the algorithm known as AdaBoost.R2 [2].
832+
This class implements the algorithm known as AdaBoost.R2 [2]_.
833833
834834
Read more in the :ref:`User Guide <adaboost>`.
835835
@@ -917,7 +917,8 @@ class AdaBoostRegressor(_RoutingNotSupportedMixin, RegressorMixin, BaseWeightBoo
917917
.. [1] Y. Freund, R. Schapire, "A Decision-Theoretic Generalization of
918918
on-Line Learning and an Application to Boosting", 1995.
919919
920-
.. [2] H. Drucker, "Improving Regressors using Boosting Techniques", 1997.
920+
.. [2] `H. Drucker, "Improving Regressors using Boosting Techniques", 1997.
921+
<https://dl.acm.org/doi/10.5555/645526.657132>`_
921922
922923
Examples
923924
--------

0 commit comments

Comments
 (0)