org.apache.spark.ml.classification

Class RandomForestClassifier

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<M>

org.apache.spark.ml.Predictor<FeaturesType,E,M>

org.apache.spark.ml.classification.Classifier<FeaturesType,E,M>

org.apache.spark.ml.classification.ProbabilisticClassifier<Vector,RandomForestClassifier,RandomForestClassificationModel>

org.apache.spark.ml.classification.RandomForestClassifier

All Implemented Interfaces:

java.io.Serializable, Logging, Params, DefaultParamsWritable, Identifiable, MLWritable

public class RandomForestClassifier
extends ProbabilisticClassifier<Vector,RandomForestClassifier,RandomForestClassificationModel>
implements DefaultParamsWritable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RandomForestClassifier()
RandomForestClassifier(String uid)

Method Summary

Modifier and Type	Method and Description
static BooleanParam	cacheNodeIds()
static IntParam	checkpointInterval()
static Params	clear(Param<?> param)
RandomForestClassifier	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
static String	explainParam(Param<?> param)
static String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static Param<String>	featuresCol()
static Param<String>	featureSubsetStrategy()
static M	fit(Dataset<?> dataset)
static M	fit(Dataset<?> dataset, ParamMap paramMap)
static scala.collection.Seq<M>	fit(Dataset<?> dataset, ParamMap[] paramMaps)
static M	fit(Dataset<?> dataset, ParamPair<?> firstParamPair, ParamPair<?>... otherParamPairs)
static M	fit(Dataset<?> dataset, ParamPair<?> firstParamPair, scala.collection.Seq<ParamPair<?>> otherParamPairs)
static <T> scala.Option<T>	get(Param<T> param)
static boolean	getCacheNodeIds()
static int	getCheckpointInterval()
static <T> scala.Option<T>	getDefault(Param<T> param)
static String	getFeaturesCol()
static String	getFeatureSubsetStrategy()
static String	getImpurity()
static String	getLabelCol()
static int	getMaxBins()
static int	getMaxDepth()
static int	getMaxMemoryInMB()
static double	getMinInfoGain()
static int	getMinInstancesPerNode()
static int	getNumTrees()
static <T> T	getOrDefault(Param<T> param)
static Param<Object>	getParam(String paramName)
static String	getPredictionCol()
static String	getProbabilityCol()
static String	getRawPredictionCol()
static long	getSeed()
static double	getSubsamplingRate()
static double[]	getThresholds()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(String paramName)
static Param<String>	impurity()
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
static Param<String>	labelCol()
static RandomForestClassifier	load(String path)
static IntParam	maxBins()
static IntParam	maxDepth()
static IntParam	maxMemoryInMB()
static DoubleParam	minInfoGain()
static IntParam	minInstancesPerNode()
static IntParam	numTrees()
static Param<?>[]	params()
static Param<String>	predictionCol()
static Param<String>	probabilityCol()
static Param<String>	rawPredictionCol()
static void	save(String path)
static LongParam	seed()
static <T> Params	set(Param<T> param, T value)
RandomForestClassifier	setCacheNodeIds(boolean value)
RandomForestClassifier	setCheckpointInterval(int value) Specifies how often to checkpoint the cached node IDs.
static Learner	setFeaturesCol(String value)
RandomForestClassifier	setFeatureSubsetStrategy(String value)
RandomForestClassifier	setImpurity(String value)
static Learner	setLabelCol(String value)
RandomForestClassifier	setMaxBins(int value)
RandomForestClassifier	setMaxDepth(int value)
RandomForestClassifier	setMaxMemoryInMB(int value)
RandomForestClassifier	setMinInfoGain(double value)
RandomForestClassifier	setMinInstancesPerNode(int value)
RandomForestClassifier	setNumTrees(int value)
static Learner	setPredictionCol(String value)
static E	setProbabilityCol(String value)
static E	setRawPredictionCol(String value)
RandomForestClassifier	setSeed(long value)
RandomForestClassifier	setSubsamplingRate(double value)
static E	setThresholds(double[] value)
static DoubleParam	subsamplingRate()
static String[]	supportedFeatureSubsetStrategies() Accessor for supported featureSubsetStrategy settings: auto, all, onethird, sqrt, log2
static String[]	supportedImpurities() Accessor for supported impurity settings: entropy, gini
static DoubleArrayParam	thresholds()
static String	toString()
static StructType	transformSchema(StructType schema)
String	uid() An immutable unique ID for the object and its derivatives.
StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType)
StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType) Validates and transforms the input schema with the provided param map.
static MLWriter	write()

Methods inherited from class org.apache.spark.ml.classification.ProbabilisticClassifier

setProbabilityCol, setThresholds

Methods inherited from class org.apache.spark.ml.classification.Classifier

setRawPredictionCol

Methods inherited from class org.apache.spark.ml.Predictor

fit, setFeaturesCol, setLabelCol, setPredictionCol, transformSchema

Methods inherited from class org.apache.spark.ml.Estimator

fit, fit, fit, fit

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.util.DefaultParamsWritable

write

Methods inherited from interface org.apache.spark.ml.util.MLWritable

save

Methods inherited from interface org.apache.spark.ml.param.shared.HasRawPredictionCol

getRawPredictionCol, rawPredictionCol

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString

Methods inherited from interface org.apache.spark.ml.param.shared.HasProbabilityCol

getProbabilityCol, probabilityCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasThresholds

getThresholds, thresholds

Methods inherited from interface org.apache.spark.ml.param.shared.HasLabelCol

getLabelCol, labelCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasFeaturesCol

featuresCol, getFeaturesCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasPredictionCol

getPredictionCol, predictionCol

Methods inherited from interface org.apache.spark.internal.Logging

initializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

RandomForestClassifier

public RandomForestClassifier(String uid)

RandomForestClassifier

public RandomForestClassifier()

Method Detail

supportedImpurities

public static final String[] supportedImpurities()

Accessor for supported impurity settings: entropy, gini

supportedFeatureSubsetStrategies

public static final String[] supportedFeatureSubsetStrategies()

Accessor for supported featureSubsetStrategy settings: auto, all, onethird, sqrt, log2

load

public static RandomForestClassifier load(String path)

toString

public static String toString()

params

public static Param<?>[] params()

explainParam

public static String explainParam(Param<?> param)

explainParams

public static String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(String paramName)

getParam

public static Param<Object> getParam(String paramName)

set

public static final <T> Params set(Param<T> param,
                                   T value)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

fit

public static M fit(Dataset<?> dataset,
                    ParamPair<?> firstParamPair,
                    scala.collection.Seq<ParamPair<?>> otherParamPairs)

fit

public static M fit(Dataset<?> dataset,
                    ParamMap paramMap)

fit

public static scala.collection.Seq<M> fit(Dataset<?> dataset,
                                          ParamMap[] paramMaps)

fit

public static M fit(Dataset<?> dataset,
                    ParamPair<?> firstParamPair,
                    ParamPair<?>... otherParamPairs)

labelCol

public static final Param<String> labelCol()

getLabelCol

public static final String getLabelCol()

featuresCol

public static final Param<String> featuresCol()

getFeaturesCol

public static final String getFeaturesCol()

predictionCol

public static final Param<String> predictionCol()

getPredictionCol

public static final String getPredictionCol()

setLabelCol

public static Learner setLabelCol(String value)

setFeaturesCol

public static Learner setFeaturesCol(String value)

setPredictionCol

public static Learner setPredictionCol(String value)

fit

public static M fit(Dataset<?> dataset)

transformSchema

public static StructType transformSchema(StructType schema)

rawPredictionCol

public static final Param<String> rawPredictionCol()

getRawPredictionCol

public static final String getRawPredictionCol()

setRawPredictionCol

public static E setRawPredictionCol(String value)

probabilityCol

public static final Param<String> probabilityCol()

getProbabilityCol

public static final String getProbabilityCol()

thresholds

public static final DoubleArrayParam thresholds()

getThresholds

public static double[] getThresholds()

setProbabilityCol

public static E setProbabilityCol(String value)

setThresholds

public static E setThresholds(double[] value)

checkpointInterval

public static final IntParam checkpointInterval()

getCheckpointInterval

public static final int getCheckpointInterval()

seed

public static final LongParam seed()

getSeed

public static final long getSeed()

maxDepth

public static final IntParam maxDepth()

maxBins

public static final IntParam maxBins()

minInstancesPerNode

public static final IntParam minInstancesPerNode()

minInfoGain

public static final DoubleParam minInfoGain()

maxMemoryInMB

public static final IntParam maxMemoryInMB()

cacheNodeIds

public static final BooleanParam cacheNodeIds()

getMaxDepth

public static final int getMaxDepth()

getMaxBins

public static final int getMaxBins()

getMinInstancesPerNode

public static final int getMinInstancesPerNode()

getMinInfoGain

public static final double getMinInfoGain()

getMaxMemoryInMB

public static final int getMaxMemoryInMB()

getCacheNodeIds

public static final boolean getCacheNodeIds()

subsamplingRate

public static final DoubleParam subsamplingRate()

getSubsamplingRate

public static final double getSubsamplingRate()

featureSubsetStrategy

public static final Param<String> featureSubsetStrategy()

getFeatureSubsetStrategy

public static final String getFeatureSubsetStrategy()

numTrees

public static final IntParam numTrees()

getNumTrees

public static final int getNumTrees()

impurity

public static final Param<String> impurity()

getImpurity

public static final String getImpurity()

save

public static void save(String path)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public static MLWriter write()

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

setMaxDepth

public RandomForestClassifier setMaxDepth(int value)

setMaxBins

public RandomForestClassifier setMaxBins(int value)

setMinInstancesPerNode

public RandomForestClassifier setMinInstancesPerNode(int value)

setMinInfoGain

public RandomForestClassifier setMinInfoGain(double value)

setMaxMemoryInMB

public RandomForestClassifier setMaxMemoryInMB(int value)

setCacheNodeIds

public RandomForestClassifier setCacheNodeIds(boolean value)

setCheckpointInterval

public RandomForestClassifier setCheckpointInterval(int value)

Specifies how often to checkpoint the cached node IDs. E.g. 10 means that the cache will get checkpointed every 10 iterations. This is only used if cacheNodeIds is true and if the checkpoint directory is set in SparkContext. Must be at least 1. (default = 10)

Parameters:

value - (undocumented)

Returns:

(undocumented)

setImpurity

public RandomForestClassifier setImpurity(String value)

setSubsamplingRate

public RandomForestClassifier setSubsamplingRate(double value)

setSeed

public RandomForestClassifier setSeed(long value)

setNumTrees

public RandomForestClassifier setNumTrees(int value)

setFeatureSubsetStrategy

public RandomForestClassifier setFeatureSubsetStrategy(String value)

copy

public RandomForestClassifier copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

Specified by:

copy in interface Params

Specified by:

copy in class Predictor<Vector,RandomForestClassifier,RandomForestClassificationModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema,
                                             boolean fitting,
                                             DataType featuresDataType)

validateAndTransformSchema

public StructType validateAndTransformSchema(StructType schema,
                                             boolean fitting,
                                             DataType featuresDataType)

Validates and transforms the input schema with the provided param map.

Parameters:

schema - input schema

fitting - whether this is in fitting

featuresDataType - SQL DataType for FeaturesType. E.g., VectorUDT for vector features.

Returns:

output schema