org.apache.spark.ml.tree

Interface TreeEnsembleParams

All Superinterfaces:

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

All Known Subinterfaces:

GBTClassifierParams, GBTParams, GBTRegressorParams, RandomForestClassifierParams, RandomForestParams, RandomForestRegressorParams

All Known Implementing Classes:

GBTClassificationModel, GBTClassifier, GBTRegressionModel, GBTRegressor, RandomForestClassificationModel, RandomForestClassifier, RandomForestRegressionModel, RandomForestRegressor

public interface TreeEnsembleParams
extends DecisionTreeParams

Parameters for Decision Tree-based ensemble algorithms.

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

Method Summary

Modifier and Type	Method and Description
Param<String>	featureSubsetStrategy() The number of features to consider for splits at each tree node.
String	getFeatureSubsetStrategy()
Strategy	getOldStrategy(scala.collection.immutable.Map<Object,Object> categoricalFeatures, int numClasses, scala.Enumeration.Value oldAlgo, Impurity oldImpurity) Create a Strategy instance to use with the old API.
double	getSubsamplingRate()
TreeEnsembleParams	setFeatureSubsetStrategy(String value) Deprecated. This method is deprecated and will be removed in 3.0.0
TreeEnsembleParams	setSubsamplingRate(double value) Deprecated. This method is deprecated and will be removed in 3.0.0.
DoubleParam	subsamplingRate() Fraction of the training data used for learning each decision tree, in range (0, 1].

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

cacheNodeIds, getCacheNodeIds, getMaxBins, getMaxDepth, getMaxMemoryInMB, getMinInfoGain, getMinInstancesPerNode, getOldStrategy, maxBins, maxDepth, maxMemoryInMB, minInfoGain, minInstancesPerNode, setCacheNodeIds, setCheckpointInterval, setMaxBins, setMaxDepth, setMaxMemoryInMB, setMinInfoGain, setMinInstancesPerNode, setSeed

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

subsamplingRate

DoubleParam subsamplingRate()

Fraction of the training data used for learning each decision tree, in range (0, 1]. (default = 1.0)

Returns:

(undocumented)

setSubsamplingRate

TreeEnsembleParams setSubsamplingRate(double value)

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

Parameters:

value - (undocumented)

Returns:

(undocumented)

getSubsamplingRate

double getSubsamplingRate()

getOldStrategy

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

Create a Strategy instance to use with the old API. NOTE: The caller should set impurity and seed.

Parameters:

categoricalFeatures - (undocumented)

numClasses - (undocumented)

oldAlgo - (undocumented)

oldImpurity - (undocumented)

Returns:

(undocumented)

featureSubsetStrategy

Param<String> featureSubsetStrategy()

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 greater than 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")

These various settings are based on the following references: - log2: tested in Breiman (2001) - sqrt: recommended by Breiman manual for random forests - The defaults of sqrt (classification) and onethird (regression) match the R randomForest package.

Returns:

(undocumented)

See Also:

Breiman (2001), Breiman manual for random forests

setFeatureSubsetStrategy

TreeEnsembleParams setFeatureSubsetStrategy(String value)

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

Parameters:

value - (undocumented)

Returns:

(undocumented)

getFeatureSubsetStrategy

String getFeatureSubsetStrategy()