3.2.4.3.1. sklearn.ensemble
.RandomForestClassifier¶

class
sklearn.ensemble.
RandomForestClassifier
(n_estimators=10, criterion='gini', max_depth=None, min_samples_split=2, min_samples_leaf=1, min_weight_fraction_leaf=0.0, max_features='auto', max_leaf_nodes=None, bootstrap=True, oob_score=False, n_jobs=1, random_state=None, verbose=0, warm_start=False, class_weight=None)[source]¶ A random forest classifier.
A random forest is a meta estimator that fits a number of decision tree classifiers on various subsamples of the dataset and use averaging to improve the predictive accuracy and control overfitting.
Parameters: n_estimators : integer, optional (default=10)
The number of trees in the forest.
criterion : string, optional (default=”gini”)
The function to measure the quality of a split. Supported criteria are “gini” for the Gini impurity and “entropy” for the information gain. Note: this parameter is treespecific.
max_features : int, float, string or None, optional (default=”auto”)
The number of features to consider when looking for the best split:
 If int, then consider max_features features at each split.
 If float, then max_features is a percentage and int(max_features * n_features) features are considered at each split.
 If “auto”, then max_features=sqrt(n_features).
 If “sqrt”, then max_features=sqrt(n_features).
 If “log2”, then max_features=log2(n_features).
 If None, then max_features=n_features.
Note: the search for a split does not stop until at least one valid partition of the node samples is found, even if it requires to effectively inspect more than
max_features
features. Note: this parameter is treespecific.max_depth : integer or None, optional (default=None)
The maximum depth of the tree. If None, then nodes are expanded until all leaves are pure or until all leaves contain less than min_samples_split samples. Ignored if
max_leaf_nodes
is not None. Note: this parameter is treespecific.min_samples_split : integer, optional (default=2)
The minimum number of samples required to split an internal node. Note: this parameter is treespecific.
min_samples_leaf : integer, optional (default=1)
The minimum number of samples in newly created leaves. A split is discarded if after the split, one of the leaves would contain less then
min_samples_leaf
samples. Note: this parameter is treespecific.min_weight_fraction_leaf : float, optional (default=0.)
The minimum weighted fraction of the input samples required to be at a leaf node. Note: this parameter is treespecific.
max_leaf_nodes : int or None, optional (default=None)
Grow trees with
max_leaf_nodes
in bestfirst fashion. Best nodes are defined as relative reduction in impurity. If None then unlimited number of leaf nodes. If not None thenmax_depth
will be ignored. Note: this parameter is treespecific.bootstrap : boolean, optional (default=True)
Whether bootstrap samples are used when building trees.
oob_score : bool
Whether to use outofbag samples to estimate the generalization error.
n_jobs : integer, optional (default=1)
The number of jobs to run in parallel for both fit and predict. If 1, then the number of jobs is set to the number of cores.
random_state : int, RandomState instance or None, optional (default=None)
If int, random_state is the seed used by the random number generator; If RandomState instance, random_state is the random number generator; If None, the random number generator is the RandomState instance used by np.random.
verbose : int, optional (default=0)
Controls the verbosity of the tree building process.
warm_start : bool, optional (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 forest.class_weight : dict, list of dicts, “auto”, “subsample” or None, optional
Weights associated with classes in the form
{class_label: weight}
. If not given, all classes are supposed to have weight one. For multioutput problems, a list of dicts can be provided in the same order as the columns of y.The “auto” mode uses the values of y to automatically adjust weights inversely proportional to class frequencies in the input data.
The “subsample” mode is the same as “auto” except that weights are computed based on the bootstrap sample for every tree grown.
For multioutput, the weights of each column of y will be multiplied.
Note that these weights will be multiplied with sample_weight (passed through the fit method) if sample_weight is specified.
Attributes: estimators_ : list of DecisionTreeClassifier
The collection of fitted subestimators.
classes_ : array of shape = [n_classes] or a list of such arrays
The classes labels (single output problem), or a list of arrays of class labels (multioutput problem).
n_classes_ : int or list
The number of classes (single output problem), or a list containing the number of classes for each output (multioutput problem).
feature_importances_ : array of shape = [n_features]
The feature importances (the higher, the more important the feature).
oob_score_ : float
Score of the training dataset obtained using an outofbag estimate.
oob_decision_function_ : array of shape = [n_samples, n_classes]
Decision function computed with outofbag 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.
See also
DecisionTreeClassifier
,ExtraTreesClassifier
References
[R28]  Breiman, “Random Forests”, Machine Learning, 45(1), 532, 2001.
Methods
apply
(X)Apply trees in the forest to X, return leaf indices. fit
(X, y[, sample_weight])Build a forest of trees from the training set (X, y). fit_transform
(X[, y])Fit to data, then transform it. get_params
([deep])Get parameters for this estimator. predict
(X)Predict class for X. predict_log_proba
(X)Predict class logprobabilities for X. predict_proba
(X)Predict class probabilities for X. score
(X, y[, sample_weight])Returns the mean accuracy on the given test data and labels. set_params
(**params)Set the parameters of this estimator. transform
(X[, threshold])Reduce X to its most important features. 
__init__
(n_estimators=10, criterion='gini', max_depth=None, min_samples_split=2, min_samples_leaf=1, min_weight_fraction_leaf=0.0, max_features='auto', max_leaf_nodes=None, bootstrap=True, oob_score=False, n_jobs=1, random_state=None, verbose=0, warm_start=False, class_weight=None)[source]¶

apply
(X)[source]¶ Apply trees in the forest to X, return leaf indices.
Parameters: X : arraylike or sparse matrix, shape = [n_samples, n_features]
The input samples. Internally, it will be converted to
dtype=np.float32
and if a sparse matrix is provided to a sparsecsr_matrix
.Returns: X_leaves : array_like, shape = [n_samples, n_estimators]
For each datapoint x in X and for each tree in the forest, return the index of the leaf x ends up in.

feature_importances_
¶  Return the feature importances (the higher, the more important the
 feature).
Returns: feature_importances_ : array, shape = [n_features]

fit
(X, y, sample_weight=None)[source]¶ Build a forest of trees from the training set (X, y).
Parameters: X : arraylike or sparse matrix of shape = [n_samples, n_features]
The training input samples. Internally, it will be converted to
dtype=np.float32
and if a sparse matrix is provided to a sparsecsc_matrix
.y : arraylike, shape = [n_samples] or [n_samples, n_outputs]
The target values (class labels in classification, real numbers in regression).
sample_weight : arraylike, shape = [n_samples] or None
Sample weights. If None, then samples are equally weighted. Splits that would create child nodes with net zero or negative weight are ignored while searching for a split in each node. In the case of classification, splits are also ignored if they would result in any single class carrying a negative weight in either child node.
Returns: self : object
Returns self.

fit_transform
(X, y=None, **fit_params)[source]¶ Fit to data, then transform it.
Fits transformer to X and y with optional parameters fit_params and returns a transformed version of X.
Parameters: X : numpy array of shape [n_samples, n_features]
Training set.
y : numpy array of shape [n_samples]
Target values.
Returns: X_new : numpy array of shape [n_samples, n_features_new]
Transformed array.

get_params
(deep=True)[source]¶ Get parameters for this estimator.
Parameters: deep: boolean, optional :
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
(X)[source]¶ Predict class for X.
The predicted class of an input sample is computed as the majority prediction of the trees in the forest.
Parameters: X : arraylike or sparse matrix of shape = [n_samples, n_features]
The input samples. Internally, it will be converted to
dtype=np.float32
and if a sparse matrix is provided to a sparsecsr_matrix
.Returns: y : array of shape = [n_samples] or [n_samples, n_outputs]
The predicted classes.

predict_log_proba
(X)[source]¶ Predict class logprobabilities for X.
The predicted class logprobabilities of an input sample is computed as the log of the mean predicted class probabilities of the trees in the forest.
Parameters: X : arraylike or sparse matrix of shape = [n_samples, n_features]
The input samples. Internally, it will be converted to
dtype=np.float32
and if a sparse matrix is provided to a sparsecsr_matrix
.Returns: p : array of shape = [n_samples, n_classes], or a list of n_outputs
such arrays if n_outputs > 1. The class probabilities of the input samples. The order of the classes corresponds to that in the attribute classes_.

predict_proba
(X)[source]¶ Predict class probabilities for X.
The predicted class probabilities of an input sample is computed as the mean predicted class probabilities of the trees in the forest.
Parameters: X : arraylike or sparse matrix of shape = [n_samples, n_features]
The input samples. Internally, it will be converted to
dtype=np.float32
and if a sparse matrix is provided to a sparsecsr_matrix
.Returns: p : array of shape = [n_samples, n_classes], or a list of n_outputs
such arrays if n_outputs > 1. The class probabilities of the input samples. The order of the classes corresponds to that in the attribute classes_.

score
(X, y, sample_weight=None)[source]¶ Returns the mean accuracy on the given test data and labels.
In multilabel 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 : arraylike, shape = (n_samples, n_features)
Test samples.
y : arraylike, shape = (n_samples) or (n_samples, n_outputs)
True labels for X.
sample_weight : arraylike, shape = [n_samples], optional
Sample weights.
Returns: score : float
Mean accuracy of self.predict(X) wrt. y.

set_params
(**params)[source]¶ Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as pipelines). The former have parameters of the form
<component>__<parameter>
so that it’s possible to update each component of a nested object.Returns: self :

transform
(X, threshold=None)[source]¶ Reduce X to its most important features.
Uses
coef_
orfeature_importances_
to determine the most important features. For models with acoef_
for each class, the absolute sum over the classes is used.Parameters: X : array or scipy sparse matrix of shape [n_samples, n_features]
The input samples.
threshold : string, float or None, optional (default=None)
The threshold value to use for feature selection. Features whose importance is greater or equal are kept while the others are discarded. If “median” (resp. “mean”), then the threshold value is the median (resp. the mean) of the feature importances. A scaling factor (e.g., “1.25*mean”) may also be used. If None and if available, the object attribute
threshold
is used. Otherwise, “mean” is used by default.Returns: X_r : array of shape [n_samples, n_selected_features]
The input samples with only the selected features.