Class/Object

org.apache.spark.ml.regression

DecisionTreeRegressor

Related Docs: object DecisionTreeRegressor | package regression

Permalink

class DecisionTreeRegressor extends Predictor[Vector, DecisionTreeRegressor, DecisionTreeRegressionModel] with DecisionTreeRegressorParams with DefaultParamsWritable

Decision tree learning algorithm for regression. It supports both continuous and categorical features.

Annotations
@Since( "1.4.0" )
Source
DecisionTreeRegressor.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DecisionTreeRegressor
  2. DefaultParamsWritable
  3. MLWritable
  4. DecisionTreeRegressorParams
  5. HasVarianceCol
  6. TreeRegressorParams
  7. DecisionTreeParams
  8. HasSeed
  9. HasCheckpointInterval
  10. Predictor
  11. PredictorParams
  12. HasPredictionCol
  13. HasFeaturesCol
  14. HasLabelCol
  15. Estimator
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DecisionTreeRegressor()

    Permalink
    Annotations
    @Since( "1.4.0" )
  2. new DecisionTreeRegressor(uid: String)

    Permalink
    Annotations
    @Since( "1.4.0" )

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final val cacheNodeIds: BooleanParam

    Permalink

    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
  7. final val checkpointInterval: IntParam

    Permalink

    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
  8. final def clear(param: Param[_]): DecisionTreeRegressor.this.type

    Permalink

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def copy(extra: ParamMap): DecisionTreeRegressor

    Permalink

    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
    DecisionTreeRegressorPredictorEstimatorPipelineStageParams
    Annotations
    @Since( "1.4.0" )
  11. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Permalink

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

    Attributes
    protected
    Definition Classes
    Params
  12. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes
    protected
    Definition Classes
    Params
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String

    Permalink

    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
  16. def explainParams(): String

    Permalink

    Explains all params of this instance.

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

    Definition Classes
    Params
  17. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]

    Permalink

    Extract labelCol and featuresCol from the given dataset, and put it in an RDD with strong types.

    Extract labelCol and featuresCol from the given dataset, and put it in an RDD with strong types.

    Attributes
    protected
    Definition Classes
    Predictor
  18. final def extractParamMap(): ParamMap

    Permalink

    extractParamMap with no extra values.

    extractParamMap with no extra values.

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

    Permalink

    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
  20. final val featuresCol: Param[String]

    Permalink

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def fit(dataset: Dataset[_]): DecisionTreeRegressionModel

    Permalink

    Fits a model to the input data.

    Fits a model to the input data.

    Definition Classes
    PredictorEstimator
  23. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[DecisionTreeRegressionModel]

    Permalink

    Fits multiple models to the input data with multiple sets of parameters.

    Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training.

    dataset

    input dataset

    paramMaps

    An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted models, matching the input parameter maps

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], paramMap: ParamMap): DecisionTreeRegressionModel

    Permalink

    Fits a single model to the input data with provided parameter map.

    Fits a single model to the input data with provided parameter map.

    dataset

    input dataset

    paramMap

    Parameter map. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  25. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DecisionTreeRegressionModel

    Permalink

    Fits a single model to the input data with optional parameters.

    Fits a single model to the input data with optional parameters.

    dataset

    input dataset

    firstParamPair

    the first param pair, overrides embedded params

    otherParamPairs

    other param pairs. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  26. final def get[T](param: Param[T]): Option[T]

    Permalink

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  27. final def getCacheNodeIds: Boolean

    Permalink

    Definition Classes
    DecisionTreeParams
  28. final def getCheckpointInterval: Int

    Permalink

    Definition Classes
    HasCheckpointInterval
  29. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def getDefault[T](param: Param[T]): Option[T]

    Permalink

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  31. final def getFeaturesCol: String

    Permalink

    Definition Classes
    HasFeaturesCol
  32. final def getImpurity: String

    Permalink

    Definition Classes
    TreeRegressorParams
  33. final def getLabelCol: String

    Permalink

    Definition Classes
    HasLabelCol
  34. final def getMaxBins: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  35. final def getMaxDepth: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  36. final def getMaxMemoryInMB: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  37. final def getMinInfoGain: Double

    Permalink

    Definition Classes
    DecisionTreeParams
  38. final def getMinInstancesPerNode: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  39. final def getOrDefault[T](param: Param[T]): T

    Permalink

    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
  40. def getParam(paramName: String): Param[Any]

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  41. final def getPredictionCol: String

    Permalink

    Definition Classes
    HasPredictionCol
  42. final def getSeed: Long

    Permalink

    Definition Classes
    HasSeed
  43. final def getVarianceCol: String

    Permalink

    Definition Classes
    HasVarianceCol
  44. final def hasDefault[T](param: Param[T]): Boolean

    Permalink

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

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

    Permalink

    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
  46. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  47. final val impurity: Param[String]

    Permalink

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

    Criterion used for information gain calculation (case-insensitive). Supported: "variance". (default = variance)

    Definition Classes
    TreeRegressorParams
  48. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean = false): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  49. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. final def isDefined(param: Param[_]): Boolean

    Permalink

    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
  51. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  52. final def isSet(param: Param[_]): Boolean

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  53. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. final val labelCol: Param[String]

    Permalink

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  55. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. final val maxBins: IntParam

    Permalink

    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
  68. final val maxDepth: IntParam

    Permalink

    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
  69. final val maxMemoryInMB: IntParam

    Permalink

    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
  70. final val minInfoGain: DoubleParam

    Permalink

    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
  71. final val minInstancesPerNode: IntParam

    Permalink

    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
  72. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  73. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  74. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  75. lazy val params: Array[Param[_]]

    Permalink

    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.

  76. final val predictionCol: Param[String]

    Permalink

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  77. def save(path: String): Unit

    Permalink

    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( ... )
  78. final val seed: LongParam

    Permalink

    Param for random seed.

    Param for random seed.

    Definition Classes
    HasSeed
  79. final def set(paramPair: ParamPair[_]): DecisionTreeRegressor.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  80. final def set(param: String, value: Any): DecisionTreeRegressor.this.type

    Permalink

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  81. final def set[T](param: Param[T], value: T): DecisionTreeRegressor.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  82. def setCacheNodeIds(value: Boolean): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  83. def setCheckpointInterval(value: Int): DecisionTreeRegressor.this.type

    Permalink

    Specifies how often to checkpoint the cached node IDs.

    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 org.apache.spark.SparkContext. Must be at least 1. (default = 10)

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  84. final def setDefault(paramPairs: ParamPair[_]*): DecisionTreeRegressor.this.type

    Permalink

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

    Attributes
    protected
    Definition Classes
    Params
  85. final def setDefault[T](param: Param[T], value: T): DecisionTreeRegressor.this.type

    Permalink

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes
    protected
    Definition Classes
    Params
  86. def setFeaturesCol(value: String): DecisionTreeRegressor

    Permalink

    Definition Classes
    Predictor
  87. def setImpurity(value: String): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → TreeRegressorParams
    Annotations
    @Since( "1.4.0" )
  88. def setLabelCol(value: String): DecisionTreeRegressor

    Permalink

    Definition Classes
    Predictor
  89. def setMaxBins(value: Int): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  90. def setMaxDepth(value: Int): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  91. def setMaxMemoryInMB(value: Int): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  92. def setMinInfoGain(value: Double): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  93. def setMinInstancesPerNode(value: Int): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  94. def setPredictionCol(value: String): DecisionTreeRegressor

    Permalink

    Definition Classes
    Predictor
  95. def setSeed(value: Long): DecisionTreeRegressor.this.type

    Permalink

    Definition Classes
    DecisionTreeRegressor → DecisionTreeParams
    Annotations
    @Since( "1.6.0" )
  96. def setVarianceCol(value: String): DecisionTreeRegressor.this.type

    Permalink

    Annotations
    @Since( "2.0.0" )
  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  98. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  99. def train(dataset: Dataset[_]): DecisionTreeRegressionModel

    Permalink

    Train a model using the given dataset and parameters.

    Train a model using the given dataset and parameters. Developers can implement this instead of fit() to avoid dealing with schema validation and copying parameters into the model.

    dataset

    Training dataset

    returns

    Fitted model

    Attributes
    protected
    Definition Classes
    DecisionTreeRegressorPredictor
  100. def transformSchema(schema: StructType): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    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
    PredictorPipelineStage
  101. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema and parameters, optionally with logging.

    This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  102. val uid: String

    Permalink

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    DecisionTreeRegressorIdentifiable
    Annotations
    @Since( "1.4.0" )
  103. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink

    Validates and transforms the input schema with the provided param map.

    Validates and transforms the input schema with the provided param map.

    schema

    input schema

    fitting

    whether this is in fitting

    featuresDataType

    SQL DataType for FeaturesType. E.g., VectorUDT for vector features.

    returns

    output schema

    Attributes
    protected
    Definition Classes
    DecisionTreeRegressorParams → PredictorParams
  104. final val varianceCol: Param[String]

    Permalink

    Param for Column name for the biased sample variance of prediction.

    Param for Column name for the biased sample variance of prediction.

    Definition Classes
    HasVarianceCol
  105. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. def write: MLWriter

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DefaultParamsWritableMLWritable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from DecisionTreeRegressorParams

Inherited from HasVarianceCol

Inherited from TreeRegressorParams

Inherited from DecisionTreeParams

Inherited from HasSeed

Inherited from HasCheckpointInterval

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

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

Members

Parameter setters

Parameter getters

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

(expert-only) Parameter setters

(expert-only) Parameter getters