org.apache.spark.ml.classification

Class DecisionTreeClassificationModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

org.apache.spark.ml.Model<M>

org.apache.spark.ml.PredictionModel<FeaturesType,M>

org.apache.spark.ml.classification.ClassificationModel<FeaturesType,M>

org.apache.spark.ml.classification.ProbabilisticClassificationModel<Vector,DecisionTreeClassificationModel>

org.apache.spark.ml.classification.DecisionTreeClassificationModel

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public final class DecisionTreeClassificationModel
extends ProbabilisticClassificationModel<Vector,DecisionTreeClassificationModel>
implements scala.Serializable

:: Experimental :: Decision tree model for classification. It supports both binary and multiclass labels, as well as both continuous and categorical features.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
DecisionTreeClassificationModel	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
Param<String>	featuresCol() Param for features column name.
static DecisionTreeClassificationModel	fromOld(DecisionTreeModel oldModel, DecisionTreeClassifier parent, scala.collection.immutable.Map<Object,Object> categoricalFeatures, int numFeatures) (private[ml]) Convert a model from the old API
String	getFeaturesCol()
String	getLabelCol()
String	getPredictionCol()
String	getRawPredictionCol()
Param<String>	labelCol() Param for label column name.
int	numClasses() Number of classes (values which the label can take).
int	numFeatures() Returns the number of features the model was trained on.
Param<String>	predictionCol() Param for prediction column name.
Param<String>	rawPredictionCol() Param for raw prediction (a.k.a.
Node	rootNode()
String	toString()
String	uid() An immutable unique ID for the object and its derivatives.
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.

Methods inherited from class org.apache.spark.ml.classification.ProbabilisticClassificationModel

normalizeToProbabilitiesInPlace, setProbabilityCol, setThresholds, transform

Methods inherited from class org.apache.spark.ml.classification.ClassificationModel

setRawPredictionCol

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

setFeaturesCol, setPredictionCol, transformSchema

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

hasParent, parent, setParent

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

transform, transform, transform

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, 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.Logging

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

Method Detail

fromOld

public static DecisionTreeClassificationModel fromOld(DecisionTreeModel oldModel,
                                      DecisionTreeClassifier parent,
                                      scala.collection.immutable.Map<Object,Object> categoricalFeatures,
                                      int numFeatures)

(private[ml]) Convert a model from the old API

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)

rootNode

public Node rootNode()

numFeatures

public int numFeatures()

Description copied from class: PredictionModel

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

Overrides:

numFeatures in class PredictionModel<Vector,DecisionTreeClassificationModel>

numClasses

public int numClasses()

Description copied from class: ClassificationModel

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

Specified by:

numClasses in class ClassificationModel<Vector,DecisionTreeClassificationModel>

copy

public DecisionTreeClassificationModel 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 Model<DecisionTreeClassificationModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

toString

public String toString()

Specified by:

toString in interface Identifiable

Overrides:

toString in class Object

validateAndTransformSchema

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

rawPredictionCol

public Param<String> rawPredictionCol()

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

Returns:

(undocumented)

getRawPredictionCol

public 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<String> labelCol()

Param for label column name.

Returns:

(undocumented)

getLabelCol

public String getLabelCol()

featuresCol

public Param<String> featuresCol()

Param for features column name.

Returns:

(undocumented)

getFeaturesCol

public String getFeaturesCol()

predictionCol

public Param<String> predictionCol()

Param for prediction column name.

Returns:

(undocumented)

getPredictionCol

public String getPredictionCol()