RandomForestClassifier¶

class pyspark.ml.classification.RandomForestClassifier(*, featuresCol: str = 'features', labelCol: str = 'label', predictionCol: str = 'prediction', probabilityCol: str = 'probability', rawPredictionCol: str = 'rawPrediction', maxDepth: int = 5, maxBins: int = 32, minInstancesPerNode: int = 1, minInfoGain: float = 0.0, maxMemoryInMB: int = 256, cacheNodeIds: bool = False, checkpointInterval: int = 10, impurity: str = 'gini', numTrees: int = 20, featureSubsetStrategy: str = 'auto', seed: Optional[int] = None, subsamplingRate: float = 1.0, leafCol: str = '', minWeightFractionPerNode: float = 0.0, weightCol: Optional[str] = None, bootstrap: Optional[bool] = True)¶

Random Forest learning algorithm for classification. It supports both binary and multiclass labels, as well as both continuous and categorical features.

Examples

>>> import numpy
>>> from numpy import allclose
>>> from pyspark.ml.linalg import Vectors
>>> from pyspark.ml.feature import StringIndexer
>>> df = spark.createDataFrame([
...     (1.0, Vectors.dense(1.0)),
...     (0.0, Vectors.sparse(1, [], []))], ["label", "features"])
>>> stringIndexer = StringIndexer(inputCol="label", outputCol="indexed")
>>> si_model = stringIndexer.fit(df)
>>> td = si_model.transform(df)
>>> rf = RandomForestClassifier(numTrees=3, maxDepth=2, labelCol="indexed", seed=42,
...     leafCol="leafId")
>>> rf.getMinWeightFractionPerNode()
0.0
>>> model = rf.fit(td)
>>> model.getLabelCol()
'indexed'
>>> model.setFeaturesCol("features")
RandomForestClassificationModel...
>>> model.setRawPredictionCol("newRawPrediction")
RandomForestClassificationModel...
>>> model.getBootstrap()
True
>>> model.getRawPredictionCol()
'newRawPrediction'
>>> model.featureImportances
SparseVector(1, {0: 1.0})
>>> allclose(model.treeWeights, [1.0, 1.0, 1.0])
True
>>> test0 = spark.createDataFrame([(Vectors.dense(-1.0),)], ["features"])
>>> model.predict(test0.head().features)
0.0
>>> model.predictRaw(test0.head().features)
DenseVector([2.0, 0.0])
>>> model.predictProbability(test0.head().features)
DenseVector([1.0, 0.0])
>>> result = model.transform(test0).head()
>>> result.prediction
0.0
>>> numpy.argmax(result.probability)
0
>>> numpy.argmax(result.newRawPrediction)
0
>>> result.leafId
DenseVector([0.0, 0.0, 0.0])
>>> test1 = spark.createDataFrame([(Vectors.sparse(1, [0], [1.0]),)], ["features"])
>>> model.transform(test1).head().prediction
1.0
>>> model.trees
[DecisionTreeClassificationModel...depth=..., DecisionTreeClassificationModel...]
>>> rfc_path = temp_path + "/rfc"
>>> rf.save(rfc_path)
>>> rf2 = RandomForestClassifier.load(rfc_path)
>>> rf2.getNumTrees()
3
>>> model_path = temp_path + "/rfc_model"
>>> model.save(model_path)
>>> model2 = RandomForestClassificationModel.load(model_path)
>>> model.featureImportances == model2.featureImportances
True
>>> model.transform(test0).take(1) == model2.transform(test0).take(1)
True

Methods

`clear`(param)	Clears a param from the param map if it has been explicitly set.
`copy`([extra])	Creates a copy of this instance with the same uid and some extra params.
`explainParam`(param)	Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.
`explainParams`()	Returns the documentation of all params with their optionally default values and user-supplied values.
`extractParamMap`([extra])	Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values < user-supplied values < extra.
`fit`(dataset[, params])	Fits a model to the input dataset with optional parameters.
`fitMultiple`(dataset, paramMaps)	Fits a model to the input dataset for each param map in paramMaps.
`getBootstrap`()	Gets the value of bootstrap or its default value.
`getCacheNodeIds`()	Gets the value of cacheNodeIds or its default value.
`getCheckpointInterval`()	Gets the value of checkpointInterval or its default value.
`getFeatureSubsetStrategy`()	Gets the value of featureSubsetStrategy or its default value.
`getFeaturesCol`()	Gets the value of featuresCol or its default value.
`getImpurity`()	Gets the value of impurity or its default value.
`getLabelCol`()	Gets the value of labelCol or its default value.
`getLeafCol`()	Gets the value of leafCol or its default value.
`getMaxBins`()	Gets the value of maxBins or its default value.
`getMaxDepth`()	Gets the value of maxDepth or its default value.
`getMaxMemoryInMB`()	Gets the value of maxMemoryInMB or its default value.
`getMinInfoGain`()	Gets the value of minInfoGain or its default value.
`getMinInstancesPerNode`()	Gets the value of minInstancesPerNode or its default value.
`getMinWeightFractionPerNode`()	Gets the value of minWeightFractionPerNode or its default value.
`getNumTrees`()	Gets the value of numTrees or its default value.
`getOrDefault`(param)	Gets the value of a param in the user-supplied param map or its default value.
`getParam`(paramName)	Gets a param by its name.
`getPredictionCol`()	Gets the value of predictionCol or its default value.
`getProbabilityCol`()	Gets the value of probabilityCol or its default value.
`getRawPredictionCol`()	Gets the value of rawPredictionCol or its default value.
`getSeed`()	Gets the value of seed or its default value.
`getSubsamplingRate`()	Gets the value of subsamplingRate or its default value.
`getThresholds`()	Gets the value of thresholds or its default value.
`getWeightCol`()	Gets the value of weightCol or its default value.
`hasDefault`(param)	Checks whether a param has a default value.
`hasParam`(paramName)	Tests whether this instance contains a param with a given (string) name.
`isDefined`(param)	Checks whether a param is explicitly set by user or has a default value.
`isSet`(param)	Checks whether a param is explicitly set by user.
`load`(path)	Reads an ML instance from the input path, a shortcut of read().load(path).
`read`()	Returns an MLReader instance for this class.
`save`(path)	Save this ML instance to the given path, a shortcut of ‘write().save(path)’.
`set`(param, value)	Sets a parameter in the embedded param map.
`setBootstrap`(value)	Sets the value of `bootstrap`.
`setCacheNodeIds`(value)	Sets the value of `cacheNodeIds`.
`setCheckpointInterval`(value)	Sets the value of `checkpointInterval`.
`setFeatureSubsetStrategy`(value)	Sets the value of `featureSubsetStrategy`.
`setFeaturesCol`(value)	Sets the value of `featuresCol`.
`setImpurity`(value)	Sets the value of `impurity`.
`setLabelCol`(value)	Sets the value of `labelCol`.
`setLeafCol`(value)	Sets the value of `leafCol`.
`setMaxBins`(value)	Sets the value of `maxBins`.
`setMaxDepth`(value)	Sets the value of `maxDepth`.
`setMaxMemoryInMB`(value)	Sets the value of `maxMemoryInMB`.
`setMinInfoGain`(value)	Sets the value of `minInfoGain`.
`setMinInstancesPerNode`(value)	Sets the value of `minInstancesPerNode`.
`setMinWeightFractionPerNode`(value)	Sets the value of `minWeightFractionPerNode`.
`setNumTrees`(value)	Sets the value of `numTrees`.
`setParams`(self[, featuresCol, labelCol, …])	Sets params for linear classification.
`setPredictionCol`(value)	Sets the value of `predictionCol`.
`setProbabilityCol`(value)	Sets the value of `probabilityCol`.
`setRawPredictionCol`(value)	Sets the value of `rawPredictionCol`.
`setSeed`(value)	Sets the value of `seed`.
`setSubsamplingRate`(value)	Sets the value of `subsamplingRate`.
`setThresholds`(value)	Sets the value of `thresholds`.
`setWeightCol`(value)	Sets the value of `weightCol`.
`write`()	Returns an MLWriter instance for this ML instance.

Attributes

`bootstrap`
`cacheNodeIds`
`checkpointInterval`
`featureSubsetStrategy`
`featuresCol`
`impurity`
`labelCol`
`leafCol`
`maxBins`
`maxDepth`
`maxMemoryInMB`
`minInfoGain`
`minInstancesPerNode`
`minWeightFractionPerNode`
`numTrees`
`params`	Returns all params ordered by name.
`predictionCol`
`probabilityCol`
`rawPredictionCol`
`seed`
`subsamplingRate`
`supportedFeatureSubsetStrategies`
`supportedImpurities`
`thresholds`
`weightCol`

Methods Documentation

clear(param: pyspark.ml.param.Param) → None¶: Clears a param from the param map if it has been explicitly set.

copy(extra: Optional[ParamMap] = None) → JP¶

Creates a copy of this instance with the same uid and some extra params. This implementation first calls Params.copy and then make a copy of the companion Java pipeline component with extra params. So both the Python wrapper and the Java pipeline component get copied.

Parameters

extradict, optional: Extra parameters to copy to the new instance

Returns

JavaParams: Copy of this instance

explainParam(param: Union[str, pyspark.ml.param.Param]) → str¶: Explains a single param and returns its name, doc, and optional default value and user-supplied value in a string.

explainParams() → str¶: Returns the documentation of all params with their optionally default values and user-supplied values.

extractParamMap(extra: Optional[ParamMap] = None) → ParamMap¶

Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values < user-supplied values < extra.

Parameters

extradict, optional: extra param values

Returns

dict: merged param map

fit(dataset: pyspark.sql.dataframe.DataFrame, params: Union[ParamMap, List[ParamMap], Tuple[ParamMap], None] = None) → Union[M, List[M]]¶

Fits a model to the input dataset with optional parameters.

Parameters

datasetpyspark.sql.DataFrame: input dataset.
paramsdict or list or tuple, optional: an optional param map that overrides embedded params. If a list/tuple of param maps is given, this calls fit on each param map and returns a list of models.

Returns

Transformer or a list of Transformer: fitted model(s)

fitMultiple(dataset: pyspark.sql.dataframe.DataFrame, paramMaps: Sequence[ParamMap]) → Iterator[Tuple[int, M]]¶

Fits a model to the input dataset for each param map in paramMaps.

Parameters

datasetpyspark.sql.DataFrame: input dataset.
paramMapscollections.abc.Sequence: A Sequence of param maps.

Returns

_FitMultipleIterator: A thread safe iterable which contains one model for each param map. Each call to next(modelIterator) will return (index, model) where model was fit using paramMaps[index]. index values may not be sequential.

getBootstrap() → bool¶: Gets the value of bootstrap or its default value.

getCacheNodeIds() → bool¶: Gets the value of cacheNodeIds or its default value.

getCheckpointInterval() → int¶: Gets the value of checkpointInterval or its default value.

getFeatureSubsetStrategy() → str¶: Gets the value of featureSubsetStrategy or its default value.

getFeaturesCol() → str¶: Gets the value of featuresCol or its default value.

getImpurity() → str¶: Gets the value of impurity or its default value.

getLabelCol() → str¶: Gets the value of labelCol or its default value.

getLeafCol() → str¶: Gets the value of leafCol or its default value.

getMaxBins() → int¶: Gets the value of maxBins or its default value.

getMaxDepth() → int¶: Gets the value of maxDepth or its default value.

getMaxMemoryInMB() → int¶: Gets the value of maxMemoryInMB or its default value.

getMinInfoGain() → float¶: Gets the value of minInfoGain or its default value.

getMinInstancesPerNode() → int¶: Gets the value of minInstancesPerNode or its default value.

getMinWeightFractionPerNode() → float¶: Gets the value of minWeightFractionPerNode or its default value.

getNumTrees() → int¶: Gets the value of numTrees or its default value.

getOrDefault(param: Union[str, pyspark.ml.param.Param[T]]) → Union[Any, T]¶: Gets the value of a param in the user-supplied param map or its default value. Raises an error if neither is set.

getParam(paramName: str) → pyspark.ml.param.Param ¶: Gets a param by its name.

getPredictionCol() → str¶: Gets the value of predictionCol or its default value.

getProbabilityCol() → str¶: Gets the value of probabilityCol or its default value.

getRawPredictionCol() → str¶: Gets the value of rawPredictionCol or its default value.

getSeed() → int¶: Gets the value of seed or its default value.

getSubsamplingRate() → float¶: Gets the value of subsamplingRate or its default value.

getThresholds() → List[float]¶: Gets the value of thresholds or its default value.

getWeightCol() → str¶: Gets the value of weightCol or its default value.

hasDefault(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param has a default value.

hasParam(paramName: str) → bool¶: Tests whether this instance contains a param with a given (string) name.

isDefined(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param is explicitly set by user or has a default value.

isSet(param: Union[str, pyspark.ml.param.Param[Any]]) → bool¶: Checks whether a param is explicitly set by user.

classmethod load(path: str) → RL¶: Reads an ML instance from the input path, a shortcut of read().load(path).

classmethod read() → pyspark.ml.util.JavaMLReader[RL]¶: Returns an MLReader instance for this class.

save(path: str) → None¶: Save this ML instance to the given path, a shortcut of ‘write().save(path)’.

set(param: pyspark.ml.param.Param, value: Any) → None¶: Sets a parameter in the embedded param map.

setBootstrap(value: bool) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of bootstrap.

setCacheNodeIds(value: bool) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of cacheNodeIds.

setCheckpointInterval(value: int) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of checkpointInterval.

setFeatureSubsetStrategy(value: str) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of featureSubsetStrategy.

setFeaturesCol(value: str) → P¶: Sets the value of featuresCol.

setImpurity(value: str) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of impurity.

setLabelCol(value: str) → P¶: Sets the value of labelCol.

setLeafCol(value: str) → P¶: Sets the value of leafCol.

setMaxBins(value: int) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of maxBins.

setMaxDepth(value: int) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of maxDepth.

setMaxMemoryInMB(value: int) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of maxMemoryInMB.

setMinInfoGain(value: float) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of minInfoGain.

setMinInstancesPerNode(value: int) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of minInstancesPerNode.

setMinWeightFractionPerNode(value: float) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of minWeightFractionPerNode.

setNumTrees(value: int) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of numTrees.

setParams(self, featuresCol='features', labelCol='label', predictionCol='prediction', probabilityCol='probability', rawPredictionCol='rawPrediction', maxDepth=5, maxBins=32, minInstancesPerNode=1, minInfoGain=0.0, maxMemoryInMB=256, cacheNodeIds=False, checkpointInterval=10, seed=None, impurity='gini', numTrees=20, featureSubsetStrategy='auto', subsamplingRate=1.0, leafCol='', minWeightFractionPerNode=0.0, weightCol=None, bootstrap=True)¶: Sets params for linear classification.

setPredictionCol(value: str) → P¶: Sets the value of predictionCol.

setProbabilityCol(value: str) → P¶: Sets the value of probabilityCol.

setRawPredictionCol(value: str) → P¶: Sets the value of rawPredictionCol.

setSeed(value: int) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of seed.

setSubsamplingRate(value: float) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of subsamplingRate.

setThresholds(value: List[float]) → P¶: Sets the value of thresholds.

setWeightCol(value: str) → pyspark.ml.classification.RandomForestClassifier ¶: Sets the value of weightCol.

write() → pyspark.ml.util.JavaMLWriter¶: Returns an MLWriter instance for this ML instance.

Attributes Documentation

bootstrap = Param(parent='undefined', name='bootstrap', doc='Whether bootstrap samples are used when building trees.')¶

cacheNodeIds = Param(parent='undefined', name='cacheNodeIds', doc='If false, the algorithm will pass trees to executors to match instances with nodes. If true, the algorithm will cache node IDs for each instance. Caching can speed up training of deeper trees. Users can set how often should the cache be checkpointed or disable it by setting checkpointInterval.')¶

checkpointInterval = Param(parent='undefined', name='checkpointInterval', doc='set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations. Note: this setting will be ignored if the checkpoint directory is not set in the SparkContext.')¶

featureSubsetStrategy = Param(parent='undefined', name='featureSubsetStrategy', doc="The number of features to consider for splits at each tree node. Supported options: 'auto' (choose automatically for task: If numTrees == 1, set to 'all'. If numTrees > 1 (forest), set to 'sqrt' for classification and to 'onethird' for regression), 'all' (use all features), 'onethird' (use 1/3 of the features), 'sqrt' (use sqrt(number of features)), 'log2' (use log2(number of features)), 'n' (when n is in the range (0, 1.0], use n * number of features. When n is in the range (1, number of features), use n features). default = 'auto'")¶

featuresCol = Param(parent='undefined', name='featuresCol', doc='features column name.')¶

impurity = Param(parent='undefined', name='impurity', doc='Criterion used for information gain calculation (case-insensitive). Supported options: entropy, gini')¶

labelCol = Param(parent='undefined', name='labelCol', doc='label column name.')¶

leafCol = Param(parent='undefined', name='leafCol', doc='Leaf indices column name. Predicted leaf index of each instance in each tree by preorder.')¶

maxBins = Param(parent='undefined', name='maxBins', doc='Max number of bins for discretizing continuous features. Must be >=2 and >= number of categories for any categorical feature.')¶

maxDepth = Param(parent='undefined', name='maxDepth', doc='Maximum depth of the tree. (>= 0) E.g., depth 0 means 1 leaf node; depth 1 means 1 internal node + 2 leaf nodes. Must be in range [0, 30].')¶

maxMemoryInMB = Param(parent='undefined', name='maxMemoryInMB', doc='Maximum memory in MB allocated to histogram aggregation. If too small, then 1 node will be split per iteration, and its aggregates may exceed this size.')¶

minInfoGain = Param(parent='undefined', name='minInfoGain', doc='Minimum information gain for a split to be considered at a tree node.')¶

minInstancesPerNode = Param(parent='undefined', name='minInstancesPerNode', doc='Minimum number of instances each child must have after split. If a split causes the left or right child to have fewer than minInstancesPerNode, the split will be discarded as invalid. Should be >= 1.')¶

minWeightFractionPerNode = Param(parent='undefined', name='minWeightFractionPerNode', doc='Minimum fraction of the weighted sample count that each child must have after split. If a split causes the fraction of the total weight in the left or right child to be less than minWeightFractionPerNode, the split will be discarded as invalid. Should be in interval [0.0, 0.5).')¶

numTrees = Param(parent='undefined', name='numTrees', doc='Number of trees to train (>= 1).')¶

params¶: Returns all params ordered by name. The default implementation uses dir() to get all attributes of type Param.

predictionCol = Param(parent='undefined', name='predictionCol', doc='prediction column name.')¶

probabilityCol = Param(parent='undefined', name='probabilityCol', doc='Column name for predicted class conditional probabilities. Note: Not all models output well-calibrated probability estimates! These probabilities should be treated as confidences, not precise probabilities.')¶

rawPredictionCol = Param(parent='undefined', name='rawPredictionCol', doc='raw prediction (a.k.a. confidence) column name.')¶

seed = Param(parent='undefined', name='seed', doc='random seed.')¶

subsamplingRate = Param(parent='undefined', name='subsamplingRate', doc='Fraction of the training data used for learning each decision tree, in range (0, 1].')¶

supportedFeatureSubsetStrategies = ['auto', 'all', 'onethird', 'sqrt', 'log2']¶

supportedImpurities = ['entropy', 'gini']¶

thresholds = Param(parent='undefined', name='thresholds', doc="Thresholds in multi-class classification to adjust the probability of predicting each class. Array must have length equal to the number of classes, with values > 0, excepting that at most one value may be 0. The class with largest value p/t is predicted, where p is the original probability of that class and t is the class's threshold.")¶

weightCol = Param(parent='undefined', name='weightCol', doc='weight column name. If this is not set or empty, we treat all instance weights as 1.0.')¶

GBTClassificationModel

RandomForestClassificationModel