org.apache.spark.ml.classification

Class RandomForestClassifier

java.lang.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, Params, Identifiable

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

:: Experimental :: 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(java.lang.String uid)

Method Summary

Methods

Modifier and Type	Method and Description
protected static <T> T	$(Param<T> param)
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.
protected static <T extends Params> T	copyValues(T to, ParamMap extra)
protected static <T extends Params> ParamMap	copyValues$default$2()
protected static <T extends Params> T	defaultCopy(ParamMap extra)
static java.lang.String	explainParam(Param<?> param)
static java.lang.String	explainParams()
protected static RDD<LabeledPoint>	extractLabeledPoints(Dataset<?> dataset)
protected static RDD<LabeledPoint>	extractLabeledPoints(Dataset<?> dataset, int numClasses)
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static Param<java.lang.String>	featuresCol()
Param<java.lang.String>	featuresCol() Param for features column name.
static Param<java.lang.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 java.lang.String	getFeaturesCol()
java.lang.String	getFeaturesCol()
static java.lang.String	getFeatureSubsetStrategy()
static java.lang.String	getImpurity()
static java.lang.String	getLabelCol()
java.lang.String	getLabelCol()
static int	getMaxBins()
static int	getMaxDepth()
static int	getMaxMemoryInMB()
static double	getMinInfoGain()
static int	getMinInstancesPerNode()
protected static int	getNumClasses(Dataset<?> dataset, int maxNumClasses)
protected static int	getNumClasses$default$2()
static int	getNumTrees()
static <T> T	getOrDefault(Param<T> param)
static Param<java.lang.Object>	getParam(java.lang.String paramName)
static java.lang.String	getPredictionCol()
java.lang.String	getPredictionCol()
static java.lang.String	getProbabilityCol()
static java.lang.String	getRawPredictionCol()
java.lang.String	getRawPredictionCol()
static long	getSeed()
static double	getSubsamplingRate()
static double[]	getThresholds()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(java.lang.String paramName)
static Param<java.lang.String>	impurity()
protected static void	initializeLogIfNecessary(boolean isInterpreter)
static boolean	isDefined(Param<?> param)
static boolean	isSet(Param<?> param)
protected static boolean	isTraceEnabled()
static Param<java.lang.String>	labelCol()
Param<java.lang.String>	labelCol() Param for label column name.
static RandomForestClassifier	load(java.lang.String path)
protected static org.slf4j.Logger	log()
protected static void	logDebug(scala.Function0<java.lang.String> msg)
protected static void	logDebug(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logError(scala.Function0<java.lang.String> msg)
protected static void	logError(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logInfo(scala.Function0<java.lang.String> msg)
protected static void	logInfo(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static java.lang.String	logName()
protected static void	logTrace(scala.Function0<java.lang.String> msg)
protected static void	logTrace(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
protected static void	logWarning(scala.Function0<java.lang.String> msg)
protected static void	logWarning(scala.Function0<java.lang.String> msg, java.lang.Throwable throwable)
static IntParam	maxBins()
static IntParam	maxDepth()
static IntParam	maxMemoryInMB()
static DoubleParam	minInfoGain()
static IntParam	minInstancesPerNode()
static IntParam	numTrees()
static Param<?>[]	params()
static Param<java.lang.String>	predictionCol()
Param<java.lang.String>	predictionCol() Param for prediction column name.
static Param<java.lang.String>	probabilityCol()
static Param<java.lang.String>	rawPredictionCol()
Param<java.lang.String>	rawPredictionCol() Param for raw prediction (a.k.a.
static void	save(java.lang.String path)
static LongParam	seed()
static <T> Params	set(Param<T> param, T value)
protected static Params	set(ParamPair<?> paramPair)
protected static Params	set(java.lang.String param, java.lang.Object value)
RandomForestClassifier	setCacheNodeIds(boolean value)
RandomForestClassifier	setCheckpointInterval(int value)
protected static <T> Params	setDefault(Param<T> param, T value)
protected static Params	setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)
static Learner	setFeaturesCol(java.lang.String value)
RandomForestClassifier	setFeatureSubsetStrategy(java.lang.String value)
RandomForestClassifier	setImpurity(java.lang.String value)
static Learner	setLabelCol(java.lang.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(java.lang.String value)
static E	setProbabilityCol(java.lang.String value)
static E	setRawPredictionCol(java.lang.String value)
RandomForestClassifier	setSeed(long value)
RandomForestClassifier	setSubsamplingRate(double value)
static E	setThresholds(double[] value)
static DoubleParam	subsamplingRate()
static java.lang.String[]	supportedFeatureSubsetStrategies() Accessor for supported featureSubsetStrategy settings: auto, all, onethird, sqrt, log2
static java.lang.String[]	supportedImpurities() Accessor for supported impurity settings: entropy, gini
static DoubleArrayParam	thresholds()
static java.lang.String	toString()
protected RandomForestClassificationModel	train(Dataset<?> dataset) Train a model using the given dataset and parameters.
static StructType	transformSchema(StructType schema)
protected static StructType	transformSchema(StructType schema, boolean logging)
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
protected static StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType)
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 void	validateParams()
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

extractLabeledPoints, getNumClasses, setRawPredictionCol

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

extractLabeledPoints, fit, setFeaturesCol, setLabelCol, setPredictionCol, transformSchema

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

fit, fit, fit, fit

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

transformSchema

Methods inherited from class java.lang.Object

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

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, validateParams

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

toString

Constructor Detail

RandomForestClassifier

public RandomForestClassifier(java.lang.String uid)

RandomForestClassifier

public RandomForestClassifier()

Method Detail

supportedImpurities

public static final java.lang.String[] supportedImpurities()

Accessor for supported impurity settings: entropy, gini

supportedFeatureSubsetStrategies

public static final java.lang.String[] supportedFeatureSubsetStrategies()

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

load

public static RandomForestClassifier load(java.lang.String path)

toString

public static java.lang.String toString()

params

public static Param<?>[] params()

validateParams

public static void validateParams()

explainParam

public static java.lang.String explainParam(Param<?> param)

explainParams

public static java.lang.String explainParams()

isSet

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

isDefined

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

hasParam

public static boolean hasParam(java.lang.String paramName)

getParam

public static Param<java.lang.Object> getParam(java.lang.String paramName)

set

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

set

protected static final Params set(java.lang.String param,
         java.lang.Object value)

set

protected static final Params set(ParamPair<?> paramPair)

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)

$

protected static final <T> T $(Param<T> param)

setDefault

protected static final <T> Params setDefault(Param<T> param,
                    T value)

setDefault

protected static final Params setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)

getDefault

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

hasDefault

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

defaultCopy

protected static final <T extends Params> T defaultCopy(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

copyValues

protected static <T extends Params> T copyValues(T to,
                              ParamMap extra)

copyValues$default$2

protected static <T extends Params> ParamMap copyValues$default$2()

logName

protected static java.lang.String logName()

log

protected static org.slf4j.Logger log()

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg)

logError

protected static void logError(scala.Function0<java.lang.String> msg)

logInfo

protected static void logInfo(scala.Function0<java.lang.String> msg,
           java.lang.Throwable throwable)

logDebug

protected static void logDebug(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logTrace

protected static void logTrace(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

logWarning

protected static void logWarning(scala.Function0<java.lang.String> msg,
              java.lang.Throwable throwable)

logError

protected static void logError(scala.Function0<java.lang.String> msg,
            java.lang.Throwable throwable)

isTraceEnabled

protected static boolean isTraceEnabled()

initializeLogIfNecessary

protected static void initializeLogIfNecessary(boolean isInterpreter)

transformSchema

protected static StructType transformSchema(StructType schema,
                         boolean logging)

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<java.lang.String> labelCol()

getLabelCol

public static final java.lang.String getLabelCol()

featuresCol

public static final Param<java.lang.String> featuresCol()

getFeaturesCol

public static final java.lang.String getFeaturesCol()

predictionCol

public static final Param<java.lang.String> predictionCol()

getPredictionCol

public static final java.lang.String getPredictionCol()

setLabelCol

public static Learner setLabelCol(java.lang.String value)

setFeaturesCol

public static Learner setFeaturesCol(java.lang.String value)

setPredictionCol

public static Learner setPredictionCol(java.lang.String value)

fit

public static M fit(Dataset<?> dataset)

transformSchema

public static StructType transformSchema(StructType schema)

extractLabeledPoints

protected static RDD<LabeledPoint> extractLabeledPoints(Dataset<?> dataset)

rawPredictionCol

public static final Param<java.lang.String> rawPredictionCol()

getRawPredictionCol

public static final java.lang.String getRawPredictionCol()

setRawPredictionCol

public static E setRawPredictionCol(java.lang.String value)

extractLabeledPoints

protected static RDD<LabeledPoint> extractLabeledPoints(Dataset<?> dataset,
                                     int numClasses)

getNumClasses

protected static int getNumClasses(Dataset<?> dataset,
                int maxNumClasses)

getNumClasses$default$2

protected static int getNumClasses$default$2()

probabilityCol

public static final Param<java.lang.String> probabilityCol()

getProbabilityCol

public static final java.lang.String getProbabilityCol()

thresholds

public static final DoubleArrayParam thresholds()

getThresholds

public static double[] getThresholds()

validateAndTransformSchema

protected static StructType validateAndTransformSchema(StructType schema,
                                    boolean fitting,
                                    DataType featuresDataType)

setProbabilityCol

public static E setProbabilityCol(java.lang.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<java.lang.String> featureSubsetStrategy()

getFeatureSubsetStrategy

public static final java.lang.String getFeatureSubsetStrategy()

numTrees

public static final IntParam numTrees()

getNumTrees

public static final int getNumTrees()

impurity

public static final Param<java.lang.String> impurity()

getImpurity

public static final java.lang.String getImpurity()

save

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

Throws:

java.io.IOException

write

public static MLWriter write()

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

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)

setImpurity

public RandomForestClassifier setImpurity(java.lang.String value)

setSubsamplingRate

public RandomForestClassifier setSubsamplingRate(double value)

setSeed

public RandomForestClassifier setSeed(long value)

setNumTrees

public RandomForestClassifier setNumTrees(int value)

setFeatureSubsetStrategy

public RandomForestClassifier setFeatureSubsetStrategy(java.lang.String value)

train

protected RandomForestClassificationModel train(Dataset<?> dataset)

Description copied from class: Predictor

Train a model using the given dataset and parameters. Developers can implement this instead of fit() to avoid dealing with schema validation and copying parameters into the model.

Specified by:

train in class Predictor<Vector,RandomForestClassifier,RandomForestClassificationModel>

Parameters:

dataset - Training dataset

Returns:

Fitted model

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.

Specified by:

copy in interface Params

Specified by:

copy in class Predictor<Vector,RandomForestClassifier,RandomForestClassificationModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

validateAndTransformSchema

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

rawPredictionCol

public Param<java.lang.String> rawPredictionCol()

Param for raw prediction (a.k.a. confidence) column name.

Returns:

(undocumented)

getRawPredictionCol

public java.lang.String getRawPredictionCol()

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

labelCol

public Param<java.lang.String> labelCol()

Param for label column name.

Returns:

(undocumented)

getLabelCol

public java.lang.String getLabelCol()

featuresCol

public Param<java.lang.String> featuresCol()

Param for features column name.

Returns:

(undocumented)

getFeaturesCol

public java.lang.String getFeaturesCol()

predictionCol

public Param<java.lang.String> predictionCol()

Param for prediction column name.

Returns:

(undocumented)

getPredictionCol

public java.lang.String getPredictionCol()