package sklearn

You can search for identifiers within the package.

in-package search v0.2.0

sklearn
- Sklearn

Legend:
Library
Module
Module type
Parameter
Class
Class type

type tag = [

| `BaggingClassifier

]

type t =
  [ `BaggingClassifier
  | `BaseBagging
  | `BaseEnsemble
  | `BaseEstimator
  | `ClassifierMixin
  | `MetaEstimatorMixin
  | `Object ]
    Obj.t

val of_pyobject : Py.Object.t -> t

val to_pyobject : [> tag ] Obj.t -> Py.Object.t

val as_bagging : t -> [ `BaseBagging ] Obj.t

val as_meta_estimator : t -> [ `MetaEstimatorMixin ] Obj.t

val as_classifier : t -> [ `ClassifierMixin ] Obj.t

val as_ensemble : t -> [ `BaseEnsemble ] Obj.t

val as_estimator : t -> [ `BaseEstimator ] Obj.t

val create : 
  ?base_estimator:[> `BaseEstimator ] Np.Obj.t ->
  ?n_estimators:int ->
  ?max_samples:[ `I of int | `F of float ] ->
  ?max_features:[ `I of int | `F of float ] ->
  ?bootstrap:bool ->
  ?bootstrap_features:bool ->
  ?oob_score:bool ->
  ?warm_start:bool ->
  ?n_jobs:int ->
  ?random_state:int ->
  ?verbose:int ->
  unit ->
  t

A Bagging classifier.

A Bagging classifier is an ensemble meta-estimator that fits base classifiers each on random subsets of the original dataset and then aggregate their individual predictions (either by voting or by averaging) to form a final prediction. Such a meta-estimator can typically be used as a way to reduce the variance of a black-box estimator (e.g., a decision tree), by introducing randomization into its construction procedure and then making an ensemble out of it.

This algorithm encompasses several works from the literature. When random subsets of the dataset are drawn as random subsets of the samples, then this algorithm is known as Pasting 1_. If samples are drawn with replacement, then the method is known as Bagging 2_. When random subsets of the dataset are drawn as random subsets of the features, then the method is known as Random Subspaces 3_. Finally, when base estimators are built on subsets of both samples and features, then the method is known as Random Patches 4_.

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

.. versionadded:: 0.15

Parameters ---------- base_estimator : object, default=None The base estimator to fit on random subsets of the dataset. If None, then the base estimator is a decision tree.

n_estimators : int, default=10 The number of base estimators in the ensemble.

max_samples : int or float, default=1.0 The number of samples to draw from X to train each base estimator (with replacement by default, see `bootstrap` for more details).

If int, then draw `max_samples` samples.
If float, then draw `max_samples * X.shape0` samples.

max_features : int or float, default=1.0 The number of features to draw from X to train each base estimator ( without replacement by default, see `bootstrap_features` for more details).

If int, then draw `max_features` features.
If float, then draw `max_features * X.shape1` features.

bootstrap : bool, default=True Whether samples are drawn with replacement. If False, sampling without replacement is performed.

bootstrap_features : bool, default=False Whether features are drawn with replacement.

oob_score : bool, default=False Whether to use out-of-bag samples to estimate the generalization error.

warm_start : bool, default=False When set to True, reuse the solution of the previous call to fit and add more estimators to the ensemble, otherwise, just fit a whole new ensemble. See :term:`the Glossary <warm_start>`.

.. versionadded:: 0.17 *warm_start* constructor parameter.

n_jobs : int, default=None The number of jobs to run in parallel for both :meth:`fit` and :meth:`predict`. ``None`` means 1 unless in a :obj:`joblib.parallel_backend` context. ``-1`` means using all processors. See :term:`Glossary <n_jobs>` for more details.

random_state : int or RandomState, default=None Controls the random resampling of the original dataset (sample wise and feature wise). If the base estimator accepts a `random_state` attribute, a different seed is generated for each instance in the ensemble. Pass an int for reproducible output across multiple function calls. See :term:`Glossary <random_state>`.

verbose : int, default=0 Controls the verbosity when fitting and predicting.

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

n_features_ : int The number of features when :meth:`fit` is performed.

estimators_ : list of estimators The collection of fitted base estimators.

estimators_samples_ : list of arrays The subset of drawn samples (i.e., the in-bag samples) for each base estimator. Each subset is defined by an array of the indices selected.

estimators_features_ : list of arrays The subset of drawn features for each base estimator.

classes_ : ndarray of shape (n_classes,) The classes labels.

n_classes_ : int or list The number of classes.

oob_score_ : float Score of the training dataset obtained using an out-of-bag estimate. This attribute exists only when ``oob_score`` is True.

oob_decision_function_ : ndarray of shape (n_samples, n_classes) Decision function computed with out-of-bag estimate on the training set. If n_estimators is small it might be possible that a data point was never left out during the bootstrap. In this case, `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 ----------

.. 1 L. Breiman, 'Pasting small votes for classification in large databases and on-line', Machine Learning, 36(1), 85-103, 1999.

.. 2 L. Breiman, 'Bagging predictors', Machine Learning, 24(2), 123-140, 1996.

.. 3 T. Ho, 'The random subspace method for constructing decision forests', Pattern Analysis and Machine Intelligence, 20(8), 832-844, 1998.

.. 4 G. Louppe and P. Geurts, 'Ensembles on Random Patches', Machine Learning and Knowledge Discovery in Databases, 346-361, 2012.

val get_item : index:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return the index'th estimator in the ensemble.

val iter : [> tag ] Obj.t -> Dict.t Stdlib.Seq.t

Return iterator over estimators in the ensemble.

val fit : 
  ?sample_weight:[> `ArrayLike ] Np.Obj.t ->
  x:[> `ArrayLike ] Np.Obj.t ->
  y:[> `ArrayLike ] Np.Obj.t ->
  [> tag ] Obj.t ->
  t

Build a Bagging ensemble of estimators from the training set (X, y).

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples. Sparse matrices are accepted only if they are supported by the base estimator.

y : array-like of shape (n_samples,) The target values (class labels in classification, real numbers in regression).

sample_weight : array-like of shape (n_samples,), default=None Sample weights. If None, then samples are equally weighted. Note that this is supported only if the base estimator supports sample weighting.

Returns ------- self : object

val get_params : ?deep:bool -> [> tag ] Obj.t -> Dict.t

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.

val predict : 
  x:[> `ArrayLike ] Np.Obj.t ->
  [> tag ] Obj.t ->
  [> `ArrayLike ] Np.Obj.t

Predict class for X.

The predicted class of an input sample is computed as the class with the highest mean predicted probability. If base estimators do not implement a ``predict_proba`` method, then it resorts to voting.

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples. Sparse matrices are accepted only if they are supported by the base estimator.

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

val predict_log_proba : 
  x:[> `ArrayLike ] Np.Obj.t ->
  [> tag ] Obj.t ->
  [> `ArrayLike ] Np.Obj.t

Predict class log-probabilities for X.

The predicted class log-probabilities of an input sample is computed as the log of the mean predicted class probabilities of the base estimators in the ensemble.

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples. Sparse matrices are accepted only if they are supported by the base estimator.

Returns ------- p : ndarray of shape (n_samples, n_classes) The class log-probabilities of the input samples. The order of the classes corresponds to that in the attribute :term:`classes_`.

val predict_proba : 
  x:[> `ArrayLike ] Np.Obj.t ->
  [> tag ] Obj.t ->
  [> `ArrayLike ] Np.Obj.t

Predict class probabilities for X.

The predicted class probabilities of an input sample is computed as the mean predicted class probabilities of the base estimators in the ensemble. If base estimators do not implement a ``predict_proba`` method, then it resorts to voting and the predicted class probabilities of an input sample represents the proportion of estimators predicting each class.

Parameters ---------- X : array-like, sparse matrix of shape (n_samples, n_features) The training input samples. Sparse matrices are accepted only if they are supported by the base estimator.

Returns ------- p : ndarray of shape (n_samples, n_classes) The class probabilities of the input samples. The order of the classes corresponds to that in the attribute :term:`classes_`.

val score : 
  ?sample_weight:[> `ArrayLike ] Np.Obj.t ->
  x:[> `ArrayLike ] Np.Obj.t ->
  y:[> `ArrayLike ] Np.Obj.t ->
  [> tag ] Obj.t ->
  float

Return the mean accuracy on the given test data and labels.

In multi-label classification, this is the subset accuracy which is a harsh metric since you require for each sample that each label set be correctly predicted.

Parameters ---------- X : array-like of shape (n_samples, n_features) Test samples.

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

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

Returns ------- score : float Mean accuracy of self.predict(X) wrt. y.

val set_params : ?params:(string * Py.Object.t) list -> [> tag ] Obj.t -> t

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.

val base_estimator_ : t -> [ `BaseEstimator | `Object ] Np.Obj.t

Attribute base_estimator_: get value or raise Not_found if None.

val base_estimator_opt : t -> [ `BaseEstimator | `Object ] Np.Obj.t option

Attribute base_estimator_: get value as an option.

val n_features_ : t -> int

Attribute n_features_: get value or raise Not_found if None.

val n_features_opt : t -> int option

Attribute n_features_: get value as an option.

val estimators_ : t -> [ `BaseEstimator | `Object ] Np.Obj.t list

Attribute estimators_: get value or raise Not_found if None.

val estimators_opt : t -> [ `BaseEstimator | `Object ] Np.Obj.t list option

Attribute estimators_: get value as an option.

val estimators_samples_ : t -> Np.Numpy.Ndarray.List.t

Attribute estimators_samples_: get value or raise Not_found if None.

val estimators_samples_opt : t -> Np.Numpy.Ndarray.List.t option

Attribute estimators_samples_: get value as an option.

val estimators_features_ : t -> Np.Numpy.Ndarray.List.t

Attribute estimators_features_: get value or raise Not_found if None.

val estimators_features_opt : t -> Np.Numpy.Ndarray.List.t option

Attribute estimators_features_: get value as an option.

val classes_ : t -> [> `ArrayLike ] Np.Obj.t

Attribute classes_: get value or raise Not_found if None.

val classes_opt : t -> [> `ArrayLike ] Np.Obj.t option

Attribute classes_: get value as an option.

val n_classes_ : t -> Py.Object.t

Attribute n_classes_: get value or raise Not_found if None.

val n_classes_opt : t -> Py.Object.t option

Attribute n_classes_: get value as an option.

val oob_score_ : t -> float

Attribute oob_score_: get value or raise Not_found if None.

val oob_score_opt : t -> float option

Attribute oob_score_: get value as an option.

val oob_decision_function_ : t -> [> `ArrayLike ] Np.Obj.t

Attribute oob_decision_function_: get value or raise Not_found if None.

val oob_decision_function_opt : t -> [> `ArrayLike ] Np.Obj.t option

Attribute oob_decision_function_: get value as an option.

val to_string : t -> string

Print the object to a human-readable representation.

val show : t -> string

Print the object to a human-readable representation.

val pp : Stdlib.Format.formatter -> t -> unit

Pretty-print the object to a formatter.