org.apache.spark.ml.tree

Interface DecisionTreeParams

All Superinterfaces:

HasCheckpointInterval, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasSeed, Identifiable, Params, PredictorParams, java.io.Serializable

All Known Subinterfaces:

DecisionTreeClassifierParams, DecisionTreeRegressorParams, GBTClassifierParams, GBTParams, GBTRegressorParams, RandomForestClassifierParams, RandomForestParams, RandomForestRegressorParams, TreeEnsembleParams

All Known Implementing Classes:

DecisionTreeClassificationModel, DecisionTreeClassifier, DecisionTreeRegressionModel, DecisionTreeRegressor, GBTClassificationModel, GBTClassifier, GBTRegressionModel, GBTRegressor, RandomForestClassificationModel, RandomForestClassifier, RandomForestRegressionModel, RandomForestRegressor

public interface DecisionTreeParams
extends PredictorParams, HasCheckpointInterval, HasSeed

Parameters for Decision Tree-based algorithms.

Note: Marked as private and DeveloperApi since this may be made public in the future.

Method Summary

Modifier and Type	Method and Description
BooleanParam	cacheNodeIds() If false, the algorithm will pass trees to executors to match instances with nodes.
boolean	getCacheNodeIds()
int	getMaxBins()
int	getMaxDepth()
int	getMaxMemoryInMB()
double	getMinInfoGain()
int	getMinInstancesPerNode()
Strategy	getOldStrategy(scala.collection.immutable.Map<Object,Object> categoricalFeatures, int numClasses, scala.Enumeration.Value oldAlgo, Impurity oldImpurity, double subsamplingRate) (private[ml]) Create a Strategy instance to use with the old API.
IntParam	maxBins() Maximum number of bins used for discretizing continuous features and for choosing how to split on features at each node.
IntParam	maxDepth() Maximum depth of the tree (nonnegative).
IntParam	maxMemoryInMB() Maximum memory in MB allocated to histogram aggregation.
DoubleParam	minInfoGain() Minimum information gain for a split to be considered at a tree node.
IntParam	minInstancesPerNode() Minimum number of instances each child must have after split.
DecisionTreeParams	setCacheNodeIds(boolean value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DecisionTreeParams	setCheckpointInterval(int value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DecisionTreeParams	setMaxBins(int value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DecisionTreeParams	setMaxDepth(int value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DecisionTreeParams	setMaxMemoryInMB(int value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DecisionTreeParams	setMinInfoGain(double value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DecisionTreeParams	setMinInstancesPerNode(int value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DecisionTreeParams	setSeed(long value) Deprecated. This method is deprecated and will be removed in 3.0.0.

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, copy, 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, uid

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

Method Detail

cacheNodeIds

BooleanParam cacheNodeIds()

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. (default = false)

Returns:

(undocumented)

getCacheNodeIds

boolean getCacheNodeIds()

getMaxBins

int getMaxBins()

getMaxDepth

int getMaxDepth()

getMaxMemoryInMB

int getMaxMemoryInMB()

getMinInfoGain

double getMinInfoGain()

getMinInstancesPerNode

int getMinInstancesPerNode()

getOldStrategy

Strategy getOldStrategy(scala.collection.immutable.Map<Object,Object> categoricalFeatures,
                        int numClasses,
                        scala.Enumeration.Value oldAlgo,
                        Impurity oldImpurity,
                        double subsamplingRate)

(private[ml]) Create a Strategy instance to use with the old API.

maxBins

IntParam maxBins()

Maximum number of bins used for discretizing continuous features and for choosing how to split on features at each node. More bins give higher granularity. Must be at least 2 and at least number of categories in any categorical feature. (default = 32)

Returns:

(undocumented)

maxDepth

IntParam maxDepth()

Maximum depth of the tree (nonnegative). E.g., depth 0 means 1 leaf node; depth 1 means 1 internal node + 2 leaf nodes. (default = 5)

Returns:

(undocumented)

maxMemoryInMB

IntParam maxMemoryInMB()

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. (default = 256 MB)

Returns:

(undocumented)

minInfoGain

DoubleParam minInfoGain()

Minimum information gain for a split to be considered at a tree node. Should be at least 0.0. (default = 0.0)

Returns:

(undocumented)

minInstancesPerNode

IntParam minInstancesPerNode()

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. Must be at least 1. (default = 1)

Returns:

(undocumented)

setCacheNodeIds

DecisionTreeParams setCacheNodeIds(boolean value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setCheckpointInterval

DecisionTreeParams setCheckpointInterval(int value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMaxBins

DecisionTreeParams setMaxBins(int value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMaxDepth

DecisionTreeParams setMaxDepth(int value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMaxMemoryInMB

DecisionTreeParams setMaxMemoryInMB(int value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMinInfoGain

DecisionTreeParams setMinInfoGain(double value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setMinInstancesPerNode

DecisionTreeParams setMinInstancesPerNode(int value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)

setSeed

DecisionTreeParams setSeed(long value)

Deprecated. This method is deprecated and will be removed in 3.0.0.

Parameters:

value - (undocumented)

Returns:

(undocumented)