org.apache.spark.ml.classification

Class DecisionTreeClassifier

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,DecisionTreeClassifier,DecisionTreeClassificationModel>

org.apache.spark.ml.classification.DecisionTreeClassifier

All Implemented Interfaces:

java.io.Serializable, Logging, ClassifierParams, ProbabilisticClassifierParams, Params, HasCheckpointInterval, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasProbabilityCol, HasRawPredictionCol, HasSeed, HasThresholds, PredictorParams, DecisionTreeClassifierParams, DecisionTreeParams, TreeClassifierParams, DefaultParamsWritable, Identifiable, MLWritable

public class DecisionTreeClassifier
extends ProbabilisticClassifier<Vector,DecisionTreeClassifier,DecisionTreeClassificationModel>
implements DecisionTreeClassifierParams, DefaultParamsWritable

Decision tree learning algorithm (http://en.wikipedia.org/wiki/Decision_tree_learning) 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
DecisionTreeClassifier()
DecisionTreeClassifier(String uid)

Method Summary

Modifier and Type	Method and Description
DecisionTreeClassifier	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
static DecisionTreeClassifier	load(String path)
static MLReader<T>	read()
DecisionTreeClassifier	setCacheNodeIds(boolean value)
DecisionTreeClassifier	setCheckpointInterval(int value) Specifies how often to checkpoint the cached node IDs.
DecisionTreeClassifier	setImpurity(String value)
DecisionTreeClassifier	setMaxBins(int value)
DecisionTreeClassifier	setMaxDepth(int value)
DecisionTreeClassifier	setMaxMemoryInMB(int value)
DecisionTreeClassifier	setMinInfoGain(double value)
DecisionTreeClassifier	setMinInstancesPerNode(int value)
DecisionTreeClassifier	setSeed(long value)
static String[]	supportedImpurities() Accessor for supported impurities: entropy, gini
String	uid() An immutable unique ID for the object and its derivatives.

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.tree.DecisionTreeParams

cacheNodeIds, getCacheNodeIds, getMaxBins, getMaxDepth, getMaxMemoryInMB, getMinInfoGain, getMinInstancesPerNode, getOldStrategy, maxBins, maxDepth, maxMemoryInMB, minInfoGain, minInstancesPerNode

Methods inherited from interface org.apache.spark.ml.PredictorParams

validateAndTransformSchema

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.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.HasCheckpointInterval

checkpointInterval, getCheckpointInterval

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

getSeed, seed

Methods inherited from interface org.apache.spark.ml.tree.TreeClassifierParams

getImpurity, getOldImpurity, impurity

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.classification.ProbabilisticClassifierParams

validateAndTransformSchema

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

getRawPredictionCol, rawPredictionCol

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.internal.Logging

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

Constructor Detail

DecisionTreeClassifier

public DecisionTreeClassifier(String uid)

DecisionTreeClassifier

public DecisionTreeClassifier()

Method Detail

supportedImpurities

public static final String[] supportedImpurities()

Accessor for supported impurities: entropy, gini

load

public static DecisionTreeClassifier load(String path)

read

public static MLReader<T> read()

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 DecisionTreeClassifier setMaxDepth(int value)

Specified by:

setMaxDepth in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMaxBins

public DecisionTreeClassifier setMaxBins(int value)

Specified by:

setMaxBins in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMinInstancesPerNode

public DecisionTreeClassifier setMinInstancesPerNode(int value)

Specified by:

setMinInstancesPerNode in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMinInfoGain

public DecisionTreeClassifier setMinInfoGain(double value)

Specified by:

setMinInfoGain in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMaxMemoryInMB

public DecisionTreeClassifier setMaxMemoryInMB(int value)

Specified by:

setMaxMemoryInMB in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setCacheNodeIds

public DecisionTreeClassifier setCacheNodeIds(boolean value)

Specified by:

setCacheNodeIds in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setCheckpointInterval

public DecisionTreeClassifier 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)

Specified by:

setCheckpointInterval in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setImpurity

public DecisionTreeClassifier setImpurity(String value)

Specified by:

setImpurity in interface TreeClassifierParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

setSeed

public DecisionTreeClassifier setSeed(long value)

Specified by:

setSeed in interface DecisionTreeParams

Parameters:

value - (undocumented)

Returns:

(undocumented)

copy

public DecisionTreeClassifier 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,DecisionTreeClassifier,DecisionTreeClassificationModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)