Packages

class DecisionTreeClassificationModel extends ProbabilisticClassificationModel[Vector, DecisionTreeClassificationModel] with DecisionTreeModel with DecisionTreeClassifierParams with MLWritable with Serializable

Decision tree model (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.

Annotations
@Since( "1.4.0" )
Source
DecisionTreeClassifier.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DecisionTreeClassificationModel
  2. MLWritable
  3. DecisionTreeClassifierParams
  4. TreeClassifierParams
  5. DecisionTreeParams
  6. HasWeightCol
  7. HasSeed
  8. HasCheckpointInterval
  9. DecisionTreeModel
  10. ProbabilisticClassificationModel
  11. ProbabilisticClassifierParams
  12. HasThresholds
  13. HasProbabilityCol
  14. ClassificationModel
  15. ClassifierParams
  16. HasRawPredictionCol
  17. PredictionModel
  18. PredictorParams
  19. HasPredictionCol
  20. HasFeaturesCol
  21. HasLabelCol
  22. Model
  23. Transformer
  24. PipelineStage
  25. Logging
  26. Params
  27. Serializable
  28. Serializable
  29. Identifiable
  30. AnyRef
  31. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

  1. final val checkpointInterval: IntParam

    Param for set checkpoint interval (>= 1) or disable checkpoint (-1).

    Param for set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations. Note: this setting will be ignored if the checkpoint directory is not set in the SparkContext.

    Definition Classes
    HasCheckpointInterval
  2. final val featuresCol: Param[String]

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  3. final val impurity: Param[String]

    Criterion used for information gain calculation (case-insensitive).

    Criterion used for information gain calculation (case-insensitive). This impurity type is used in DecisionTreeClassifier and RandomForestClassifier, Supported: "entropy" and "gini". (default = gini)

    Definition Classes
    TreeClassifierParams
  4. final val labelCol: Param[String]

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  5. final val leafCol: Param[String]

    Leaf indices column name.

    Leaf indices column name. Predicted leaf index of each instance in each tree by preorder. (default = "")

    Definition Classes
    DecisionTreeParams
    Annotations
    @Since( "3.0.0" )
  6. final val maxBins: IntParam

    Maximum number of bins used for discretizing continuous features and for choosing how to split on features at each node.

    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)

    Definition Classes
    DecisionTreeParams
  7. final val maxDepth: IntParam

    Maximum depth of the tree (nonnegative).

    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)

    Definition Classes
    DecisionTreeParams
  8. final val minInfoGain: DoubleParam

    Minimum information gain for a split to be considered at a tree node.

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

    Definition Classes
    DecisionTreeParams
  9. final val minInstancesPerNode: IntParam

    Minimum number of instances each child must have after split.

    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)

    Definition Classes
    DecisionTreeParams
  10. final val minWeightFractionPerNode: DoubleParam

    Minimum fraction of the weighted sample count that each child must have after split.

    Minimum fraction of the weighted sample count that each child must have after split. If a split causes the fraction of the total weight in the left or right child to be less than minWeightFractionPerNode, the split will be discarded as invalid. Should be in the interval [0.0, 0.5). (default = 0.0)

    Definition Classes
    DecisionTreeParams
  11. final val predictionCol: Param[String]

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  12. final val probabilityCol: Param[String]

    Param for Column name for predicted class conditional probabilities.

    Param for Column name for predicted class conditional probabilities. Note: Not all models output well-calibrated probability estimates! These probabilities should be treated as confidences, not precise probabilities.

    Definition Classes
    HasProbabilityCol
  13. final val rawPredictionCol: Param[String]

    Param for raw prediction (a.k.a.

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

    Definition Classes
    HasRawPredictionCol
  14. final val seed: LongParam

    Param for random seed.

    Param for random seed.

    Definition Classes
    HasSeed
  15. val thresholds: DoubleArrayParam

    Param for Thresholds in multi-class classification to adjust the probability of predicting each class.

    Param for Thresholds in multi-class classification to adjust the probability of predicting each class. Array must have length equal to the number of classes, with values > 0 excepting that at most one value may be 0. The class with largest value p/t is predicted, where p is the original probability of that class and t is the class's threshold.

    Definition Classes
    HasThresholds
  16. final val weightCol: Param[String]

    Param for weight column name.

    Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.

    Definition Classes
    HasWeightCol

Members

  1. final def clear(param: Param[_]): DecisionTreeClassificationModel.this.type

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  2. def copy(extra: ParamMap): DecisionTreeClassificationModel

    Creates a copy of this instance with the same UID and some extra 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().

    Definition Classes
    DecisionTreeClassificationModelModelTransformerPipelineStageParams
    Annotations
    @Since( "1.4.0" )
  3. lazy val depth: Int

    Depth of the tree.

    Depth of the tree. E.g.: Depth 0 means 1 leaf node. Depth 1 means 1 internal node and 2 leaf nodes.

    Definition Classes
    DecisionTreeModel
  4. def explainParam(param: Param[_]): String

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes
    Params
  5. def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes
    Params
  6. final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  7. final def extractParamMap(extra: ParamMap): ParamMap

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes
    Params
  8. lazy val featureImportances: Vector

    Estimate of the importance of each feature.

    Estimate of the importance of each feature.

    This generalizes the idea of "Gini" importance to other losses, following the explanation of Gini importance from "Random Forests" documentation by Leo Breiman and Adele Cutler, and following the implementation from scikit-learn.

    This feature importance is calculated as follows:

    • importance(feature j) = sum (over nodes which split on feature j) of the gain, where gain is scaled by the number of instances passing through node
    • Normalize importances for tree to sum to 1.
    Annotations
    @Since( "2.0.0" )
    Note

    Feature importance for single decision trees can have high variance due to correlated predictor variables. Consider using a RandomForestClassifier to determine feature importance instead.

  9. final def get[T](param: Param[T]): Option[T]

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  10. final def getDefault[T](param: Param[T]): Option[T]

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  11. final def getOrDefault[T](param: Param[T]): T

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

    Definition Classes
    Params
  12. def getParam(paramName: String): Param[Any]

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  13. final def hasDefault[T](param: Param[T]): Boolean

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

    Definition Classes
    Params
  14. def hasParam(paramName: String): Boolean

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes
    Params
  15. def hasParent: Boolean

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes
    Model
  16. final def isDefined(param: Param[_]): Boolean

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

    Definition Classes
    Params
  17. final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  18. val numClasses: Int

    Number of classes (values which the label can take).

    Number of classes (values which the label can take).

    Definition Classes
    DecisionTreeClassificationModelClassificationModel
    Annotations
    @Since( "1.5.0" )
  19. val numFeatures: Int

    Returns the number of features the model was trained on.

    Returns the number of features the model was trained on. If unknown, returns -1

    Definition Classes
    DecisionTreeClassificationModelPredictionModel
    Annotations
    @Since( "1.6.0" )
  20. def numNodes: Int

    Number of nodes in tree, including leaf nodes.

    Number of nodes in tree, including leaf nodes.

    Definition Classes
    DecisionTreeModel
  21. lazy val params: Array[Param[_]]

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Definition Classes
    Params
    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

  22. var parent: Estimator[DecisionTreeClassificationModel]

    The parent estimator that produced this model.

    The parent estimator that produced this model.

    Definition Classes
    Model
    Note

    For ensembles' component Models, this value can be null.

  23. def predict(features: Vector): Double

    Predict label for the given features.

    Predict label for the given features. This method is used to implement transform() and output predictionCol.

    This default implementation for classification predicts the index of the maximum value from predictRaw().

    Definition Classes
    DecisionTreeClassificationModelClassificationModelPredictionModel
  24. def predictLeaf(features: Vector): Double

    returns

    The index of the leaf corresponding to the feature vector. Leaves are indexed in pre-order from 0.

    Definition Classes
    DecisionTreeModel
  25. def predictProbability(features: Vector): Vector

    Predict the probability of each class given the features.

    Predict the probability of each class given the features. These predictions are also called class conditional probabilities.

    This internal method is used to implement transform() and output probabilityCol.

    returns

    Estimated class conditional probabilities

    Definition Classes
    ProbabilisticClassificationModel
    Annotations
    @Since( "3.0.0" )
  26. def predictRaw(features: Vector): Vector

    Raw prediction for each possible label.

    Raw prediction for each possible label. The meaning of a "raw" prediction may vary between algorithms, but it intuitively gives a measure of confidence in each possible label (where larger = more confident). This internal method is used to implement transform() and output rawPredictionCol.

    returns

    vector where element i is the raw prediction for label i. This raw prediction may be any real number, where a larger value indicates greater confidence for that label.

    Definition Classes
    DecisionTreeClassificationModelClassificationModel
    Annotations
    @Since( "3.0.0" )
  27. val rootNode: Node

    Root of the decision tree

    Root of the decision tree

    Definition Classes
    DecisionTreeClassificationModel → DecisionTreeModel
    Annotations
    @Since( "1.4.0" )
  28. def save(path: String): Unit

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  29. final def set[T](param: Param[T], value: T): DecisionTreeClassificationModel.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  30. def setParent(parent: Estimator[DecisionTreeClassificationModel]): DecisionTreeClassificationModel

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes
    Model
  31. def toDebugString: String

    Full description of model

    Full description of model

    Definition Classes
    DecisionTreeModel
  32. def toString(): String

    Summary of the model

    Summary of the model

    Definition Classes
    DecisionTreeClassificationModel → DecisionTreeModel → Identifiable → AnyRef → Any
    Annotations
    @Since( "1.4.0" )
  33. def transform(dataset: Dataset[_]): DataFrame

    Transforms dataset by reading from featuresCol, and appending new columns as specified by parameters:

    Transforms dataset by reading from featuresCol, and appending new columns as specified by parameters:

    dataset

    input dataset

    returns

    transformed dataset

    Definition Classes
    DecisionTreeClassificationModelProbabilisticClassificationModelClassificationModelPredictionModelTransformer
  34. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Transforms the dataset with provided parameter map as additional parameters.

    Transforms the dataset with provided parameter map as additional parameters.

    dataset

    input dataset

    paramMap

    additional parameters, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  35. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Transforms the dataset with optional parameters

    Transforms the dataset with optional parameters

    dataset

    input dataset

    firstParamPair

    the first param pair, overwrite embedded params

    otherParamPairs

    other param pairs, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  36. final def transformImpl(dataset: Dataset[_]): DataFrame
    Definition Classes
    ClassificationModelPredictionModel
  37. def transformSchema(schema: StructType): StructType

    Check transform validity and derive the output schema from the input schema.

    Check transform validity and derive the output schema from the input schema.

    We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

    Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

    Definition Classes
    DecisionTreeClassificationModelProbabilisticClassificationModelClassificationModelPredictionModelPipelineStage
    Annotations
    @Since( "3.0.0" )
  38. val uid: String

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    DecisionTreeClassificationModelIdentifiable
    Annotations
    @Since( "1.4.0" )
  39. def write: MLWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DecisionTreeClassificationModelMLWritable
    Annotations
    @Since( "2.0.0" )

Parameter setters

  1. def setFeaturesCol(value: String): DecisionTreeClassificationModel

    Definition Classes
    PredictionModel
  2. final def setLeafCol(value: String): DecisionTreeClassificationModel.this.type

    Definition Classes
    DecisionTreeParams
    Annotations
    @Since( "3.0.0" )
  3. def setPredictionCol(value: String): DecisionTreeClassificationModel

    Definition Classes
    PredictionModel
  4. def setProbabilityCol(value: String): DecisionTreeClassificationModel

  5. def setRawPredictionCol(value: String): DecisionTreeClassificationModel

    Definition Classes
    ClassificationModel
  6. def setThresholds(value: Array[Double]): DecisionTreeClassificationModel

Parameter getters

  1. final def getCheckpointInterval: Int

    Definition Classes
    HasCheckpointInterval
  2. final def getFeaturesCol: String

    Definition Classes
    HasFeaturesCol
  3. final def getImpurity: String

    Definition Classes
    TreeClassifierParams
  4. final def getLabelCol: String

    Definition Classes
    HasLabelCol
  5. final def getLeafCol: String

    Definition Classes
    DecisionTreeParams
    Annotations
    @Since( "3.0.0" )
  6. final def getMaxBins: Int

    Definition Classes
    DecisionTreeParams
  7. final def getMaxDepth: Int

    Definition Classes
    DecisionTreeParams
  8. final def getMinInfoGain: Double

    Definition Classes
    DecisionTreeParams
  9. final def getMinInstancesPerNode: Int

    Definition Classes
    DecisionTreeParams
  10. final def getMinWeightFractionPerNode: Double

    Definition Classes
    DecisionTreeParams
  11. final def getPredictionCol: String

    Definition Classes
    HasPredictionCol
  12. final def getProbabilityCol: String

    Definition Classes
    HasProbabilityCol
  13. final def getRawPredictionCol: String

    Definition Classes
    HasRawPredictionCol
  14. final def getSeed: Long

    Definition Classes
    HasSeed
  15. def getThresholds: Array[Double]

    Definition Classes
    HasThresholds
  16. final def getWeightCol: String

    Definition Classes
    HasWeightCol

(expert-only) Parameters

A list of advanced, expert-only (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

  1. final val cacheNodeIds: BooleanParam

    If false, the algorithm will pass trees to executors to match instances with nodes.

    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)

    Definition Classes
    DecisionTreeParams
  2. final val maxMemoryInMB: IntParam

    Maximum memory in MB allocated to histogram aggregation.

    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)

    Definition Classes
    DecisionTreeParams

(expert-only) Parameter getters

  1. final def getCacheNodeIds: Boolean

    Definition Classes
    DecisionTreeParams
  2. final def getMaxMemoryInMB: Int

    Definition Classes
    DecisionTreeParams