package sklearn

An AdaBoost regressor.

An AdaBoost 1 regressor is a meta-estimator that begins by fitting a regressor on the original dataset and then fits additional copies of the regressor on the same dataset but where the weights of instances are adjusted according to the error of the current prediction. As such, subsequent regressors focus more on difficult cases.

This class implements the algorithm known as AdaBoost.R2 2.

Read more in the :ref:`User Guide <adaboost>`.

.. versionadded:: 0.14

Parameters ---------- base_estimator : object, default=None The base estimator from which the boosted ensemble is built. If ``None``, then the base estimator is ``DecisionTreeRegressor(max_depth=3)``.

n_estimators : int, default=50 The maximum number of estimators at which boosting is terminated. In case of perfect fit, the learning procedure is stopped early.

learning_rate : float, default=1. Learning rate shrinks the contribution of each regressor by ``learning_rate``. There is a trade-off between ``learning_rate`` and ``n_estimators``.

loss : 'linear', 'square', 'exponential', default='linear' The loss function to use when updating the weights after each boosting iteration.

random_state : int or RandomState, default=None Controls the random seed given at each `base_estimator` at each boosting iteration. Thus, it is only used when `base_estimator` exposes a `random_state`. In addition, it controls the bootstrap of the weights used to train the `base_estimator` at each boosting iteration. Pass an int for reproducible output across multiple function calls. See :term:`Glossary <random_state>`.

Attributes ---------- base_estimator_ : estimator The base estimator from which the ensemble is grown.

estimators_ : list of classifiers The collection of fitted sub-estimators.

estimator_weights_ : ndarray of floats Weights for each estimator in the boosted ensemble.

estimator_errors_ : ndarray of floats Regression error for each estimator in the boosted ensemble.

feature_importances_ : ndarray of shape (n_features,) The impurity-based feature importances if supported by the ``base_estimator`` (when based on decision trees).

Warning: impurity-based feature importances can be misleading for high cardinality features (many unique values). See :func:`sklearn.inspection.permutation_importance` as an alternative.

Examples -------- >>> from sklearn.ensemble import AdaBoostRegressor >>> from sklearn.datasets import make_regression >>> X, y = make_regression(n_features=4, n_informative=2, ... random_state=0, shuffle=False) >>> regr = AdaBoostRegressor(random_state=0, n_estimators=100) >>> regr.fit(X, y) AdaBoostRegressor(n_estimators=100, random_state=0) >>> regr.predict([0, 0, 0, 0]) array(4.7972...) >>> regr.score(X, y) 0.9771...

See also -------- AdaBoostClassifier, GradientBoostingRegressor, sklearn.tree.DecisionTreeRegressor

References ---------- .. 1 Y. Freund, R. Schapire, 'A Decision-Theoretic Generalization of on-Line Learning and an Application to Boosting', 1995.

.. 2 H. Drucker, 'Improving Regressors using Boosting Techniques', 1997.

Return the index'th estimator in the ensemble.

Return iterator over estimators in the ensemble.

Build a boosted regressor from the training set (X, y).

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples. Sparse matrix can be CSC, CSR, COO, DOK, or LIL. COO, DOK, and LIL are converted to CSR.

y : array-like of shape (n_samples,) The target values (real numbers).

sample_weight : array-like of shape (n_samples,), default=None Sample weights. If None, the sample weights are initialized to 1 / n_samples.

Returns ------- self : object

Get parameters for this estimator.

Parameters ---------- deep : bool, default=True If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns ------- params : mapping of string to any Parameter names mapped to their values.

Predict regression value for X.

The predicted regression value of an input sample is computed as the weighted median prediction of the classifiers in the ensemble.

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples. Sparse matrix can be CSC, CSR, COO, DOK, or LIL. COO, DOK, and LIL are converted to CSR.

Returns ------- y : ndarray of shape (n_samples,) The predicted regression values.

Return the coefficient of determination R^2 of the prediction.

The coefficient R^2 is defined as (1 - u/v), where u is the residual sum of squares ((y_true - y_pred) ** 2).sum() and v is the total sum of squares ((y_true - y_true.mean()) ** 2).sum(). The best possible score is 1.0 and it can be negative (because the model can be arbitrarily worse). A constant model that always predicts the expected value of y, disregarding the input features, would get a R^2 score of 0.0.

Parameters ---------- X : array-like of shape (n_samples, n_features) Test samples. For some estimators this may be a precomputed kernel matrix or a list of generic objects instead, shape = (n_samples, n_samples_fitted), where n_samples_fitted is the number of samples used in the fitting for the estimator.

y : array-like of shape (n_samples,) or (n_samples, n_outputs) True values for X.

sample_weight : array-like of shape (n_samples,), default=None Sample weights.

Returns ------- score : float R^2 of self.predict(X) wrt. y.

Notes ----- The R2 score used when calling ``score`` on a regressor uses ``multioutput='uniform_average'`` from version 0.23 to keep consistent with default value of :func:`~sklearn.metrics.r2_score`. This influences the ``score`` method of all the multioutput regressors (except for :class:`~sklearn.multioutput.MultiOutputRegressor`).

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form ``<component>__<parameter>`` so that it's possible to update each component of a nested object.

Parameters ---------- **params : dict Estimator parameters.

Returns ------- self : object Estimator instance.

Return staged predictions for X.

The predicted regression value of an input sample is computed as the weighted median prediction of the classifiers in the ensemble.

This generator method yields the ensemble prediction after each iteration of boosting and therefore allows monitoring, such as to determine the prediction on a test set after each boost.

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples.

Yields ------- y : generator of ndarray of shape (n_samples,) The predicted regression values.

Return staged scores for X, y.

This generator method yields the ensemble score after each iteration of boosting and therefore allows monitoring, such as to determine the score on a test set after each boost.

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples. Sparse matrix can be CSC, CSR, COO, DOK, or LIL. COO, DOK, and LIL are converted to CSR.

y : array-like of shape (n_samples,) Labels for X.

sample_weight : array-like of shape (n_samples,), default=None Sample weights.

Yields ------ z : float

Attribute base_estimator_: get value or raise Not_found if None.

Attribute base_estimator_: get value as an option.

Attribute estimators_: get value or raise Not_found if None.

Attribute estimators_: get value as an option.

Attribute estimator_weights_: get value or raise Not_found if None.

Attribute estimator_weights_: get value as an option.

Attribute estimator_errors_: get value or raise Not_found if None.

Attribute estimator_errors_: get value as an option.

Attribute feature_importances_: get value or raise Not_found if None.

Attribute feature_importances_: get value as an option.

Attribute Warning: get value or raise Not_found if None.

Attribute Warning: get value as an option.

Print the object to a human-readable representation.

Print the object to a human-readable representation.

Pretty-print the object to a formatter.