Class/Object

org.apache.spark.ml.classification

GBTClassificationModel

Related Docs: object GBTClassificationModel | package classification

Permalink

class GBTClassificationModel extends ProbabilisticClassificationModel[Vector, GBTClassificationModel] with GBTClassifierParams with TreeEnsembleModel[DecisionTreeRegressionModel] with MLWritable with Serializable

Gradient-Boosted Trees (GBTs) (http://en.wikipedia.org/wiki/Gradient_boosting) model for classification. It supports binary labels, as well as both continuous and categorical features.

Annotations
@Since( "1.6.0" )
Source
GBTClassifier.scala
Note

Multiclass labels are not currently supported.

Linear Supertypes
MLWritable, TreeEnsembleModel[DecisionTreeRegressionModel], GBTClassifierParams, TreeClassifierParams, GBTParams, HasStepSize, HasMaxIter, TreeEnsembleParams, DecisionTreeParams, HasSeed, HasCheckpointInterval, ProbabilisticClassificationModel[Vector, GBTClassificationModel], ProbabilisticClassifierParams, HasThresholds, HasProbabilityCol, ClassificationModel[Vector, GBTClassificationModel], ClassifierParams, HasRawPredictionCol, PredictionModel[Vector, GBTClassificationModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Model[GBTClassificationModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. GBTClassificationModel
  2. MLWritable
  3. TreeEnsembleModel
  4. GBTClassifierParams
  5. TreeClassifierParams
  6. GBTParams
  7. HasStepSize
  8. HasMaxIter
  9. TreeEnsembleParams
  10. DecisionTreeParams
  11. HasSeed
  12. HasCheckpointInterval
  13. ProbabilisticClassificationModel
  14. ProbabilisticClassifierParams
  15. HasThresholds
  16. HasProbabilityCol
  17. ClassificationModel
  18. ClassifierParams
  19. HasRawPredictionCol
  20. PredictionModel
  21. PredictorParams
  22. HasPredictionCol
  23. HasFeaturesCol
  24. HasLabelCol
  25. Model
  26. Transformer
  27. PipelineStage
  28. Logging
  29. Params
  30. Serializable
  31. Serializable
  32. Identifiable
  33. AnyRef
  34. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GBTClassificationModel(uid: String, _trees: Array[DecisionTreeRegressionModel], _treeWeights: Array[Double])

    Permalink

    Construct a GBTClassificationModel

    Construct a GBTClassificationModel

    _trees

    Decision trees in the ensemble.

    _treeWeights

    Weights for the decision trees in the ensemble.

    Annotations
    @Since( "1.6.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[_]): GBTClassificationModel.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): GBTClassificationModel

    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
    GBTClassificationModelModelTransformerPipelineStageParams
    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. final def extractParamMap(): ParamMap

    Permalink

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  18. 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
  19. lazy val featureImportances: Vector

    Permalink

    Estimate of the importance of each feature.

    Estimate of the importance of each feature.

    Each feature's importance is the average of its importance across all trees in the ensemble The importance vector is normalized to sum to 1. This method is suggested by Hastie et al. (Hastie, Tibshirani, Friedman. "The Elements of Statistical Learning, 2nd Edition." 2001.) and follows the implementation from scikit-learn.

    See DecisionTreeClassificationModel.featureImportances

    Annotations
    @Since( "2.0.0" )
  20. final val featureSubsetStrategy: Param[String]

    Permalink

    The number of features to consider for splits at each tree node.

    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 > 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.
    Definition Classes
    TreeEnsembleParams
    See also

    Breiman manual for random forests

    Breiman (2001)

  21. final val featuresCol: Param[String]

    Permalink

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  22. def featuresDataType: DataType

    Permalink

    Returns the SQL DataType corresponding to the FeaturesType type parameter.

    Returns the SQL DataType corresponding to the FeaturesType type parameter.

    This is used by validateAndTransformSchema(). This workaround is needed since SQL has different APIs for Scala and Java.

    The default value is VectorUDT, but it may be overridden if FeaturesType is not Vector.

    Attributes
    protected
    Definition Classes
    PredictionModel
  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. 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
  25. final def getCacheNodeIds: Boolean

    Permalink

    Definition Classes
    DecisionTreeParams
  26. final def getCheckpointInterval: Int

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. 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
  29. final def getFeatureSubsetStrategy: String

    Permalink

    Definition Classes
    TreeEnsembleParams
  30. final def getFeaturesCol: String

    Permalink

    Definition Classes
    HasFeaturesCol
  31. final def getImpurity: String

    Permalink

    Definition Classes
    TreeClassifierParams
  32. final def getLabelCol: String

    Permalink

    Definition Classes
    HasLabelCol
  33. def getLossType: String

    Permalink

    Definition Classes
    GBTClassifierParams
  34. final def getMaxBins: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  35. final def getMaxDepth: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  36. final def getMaxIter: Int

    Permalink

    Definition Classes
    HasMaxIter
  37. final def getMaxMemoryInMB: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  38. final def getMinInfoGain: Double

    Permalink

    Definition Classes
    DecisionTreeParams
  39. final def getMinInstancesPerNode: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  40. val getNumTrees: Int

    Permalink

    Number of trees in ensemble

    Number of trees in ensemble

    Annotations
    @Since( "2.0.0" )
  41. 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
  42. def getParam(paramName: String): Param[Any]

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  43. final def getPredictionCol: String

    Permalink

    Definition Classes
    HasPredictionCol
  44. final def getProbabilityCol: String

    Permalink

    Definition Classes
    HasProbabilityCol
  45. final def getRawPredictionCol: String

    Permalink

    Definition Classes
    HasRawPredictionCol
  46. final def getSeed: Long

    Permalink

    Definition Classes
    HasSeed
  47. final def getStepSize: Double

    Permalink

    Definition Classes
    HasStepSize
  48. final def getSubsamplingRate: Double

    Permalink

    Definition Classes
    TreeEnsembleParams
  49. def getThresholds: Array[Double]

    Permalink

    Definition Classes
    HasThresholds
  50. 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
  51. 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
  52. def hasParent: Boolean

    Permalink

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes
    Model
  53. def hashCode(): Int

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

    Permalink

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

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

    Definition Classes
    TreeClassifierParams
  55. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean = false): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. 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
  58. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  60. def isTraceEnabled(): Boolean

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

    Permalink

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  62. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. val lossType: Param[String]

    Permalink

    Loss function which GBT tries to minimize.

    Loss function which GBT tries to minimize. (case-insensitive) Supported: "logistic" (default = logistic)

    Definition Classes
    GBTClassifierParams
  75. 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 >= 2 and >= number of categories in any categorical feature. (default = 32)

    Definition Classes
    DecisionTreeParams
  76. final val maxDepth: IntParam

    Permalink

    Maximum depth of the tree (>= 0).

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

    Definition Classes
    DecisionTreeParams
  77. final val maxIter: IntParam

    Permalink

    Param for maximum number of iterations (>= 0).

    Param for maximum number of iterations (>= 0).

    Definition Classes
    HasMaxIter
  78. 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
  79. 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 >= 0.0. (default = 0.0)

    Definition Classes
    DecisionTreeParams
  80. 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. Should be >= 1. (default = 1)

    Definition Classes
    DecisionTreeParams
  81. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  84. val numClasses: Int

    Permalink

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

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

    Definition Classes
    GBTClassificationModelClassificationModel
    Annotations
    @Since( "2.2.0" )
  85. val numFeatures: Int

    Permalink

    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
    GBTClassificationModelPredictionModel
    Annotations
    @Since( "1.6.0" )
  86. val numTrees: Int

    Permalink

    Number of trees in ensemble

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

  88. var parent: Estimator[GBTClassificationModel]

    Permalink

    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.

  89. def predict(features: Vector): Double

    Permalink

    Predict label for the given features.

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

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

    Attributes
    protected
    Definition Classes
    GBTClassificationModelClassificationModelPredictionModel
  90. def predictProbability(features: Vector): Vector

    Permalink

    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

    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel
  91. def predictRaw(features: Vector): Vector

    Permalink

    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.

    Attributes
    protected
    Definition Classes
    GBTClassificationModelClassificationModel
  92. final val predictionCol: Param[String]

    Permalink

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  93. def probability2prediction(probability: Vector): Double

    Permalink

    Given a vector of class conditional probabilities, select the predicted label.

    Given a vector of class conditional probabilities, select the predicted label. This supports thresholds which favor particular labels.

    returns

    predicted label

    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel
  94. final val probabilityCol: Param[String]

    Permalink

    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
  95. def raw2prediction(rawPrediction: Vector): Double

    Permalink

    Given a vector of raw predictions, select the predicted label.

    Given a vector of raw predictions, select the predicted label. This may be overridden to support thresholds which favor particular labels.

    returns

    predicted label

    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModelClassificationModel
  96. def raw2probability(rawPrediction: Vector): Vector

    Permalink

    Non-in-place version of raw2probabilityInPlace()

    Non-in-place version of raw2probabilityInPlace()

    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel
  97. def raw2probabilityInPlace(rawPrediction: Vector): Vector

    Permalink

    Estimate the probability of each class given the raw prediction, doing the computation in-place.

    Estimate the probability of each class given the raw prediction, doing the computation in-place. These predictions are also called class conditional probabilities.

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

    returns

    Estimated class conditional probabilities (modified input vector)

    Attributes
    protected
    Definition Classes
    GBTClassificationModelProbabilisticClassificationModel
  98. final val rawPredictionCol: Param[String]

    Permalink

    Param for raw prediction (a.k.a.

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

    Definition Classes
    HasRawPredictionCol
  99. 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( ... )
  100. final val seed: LongParam

    Permalink

    Param for random seed.

    Param for random seed.

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

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  102. final def set(param: String, value: Any): GBTClassificationModel.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
  103. final def set[T](param: Param[T], value: T): GBTClassificationModel.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  104. final def setDefault(paramPairs: ParamPair[_]*): GBTClassificationModel.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
  105. final def setDefault[T](param: Param[T], value: T): GBTClassificationModel.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
  106. def setFeaturesCol(value: String): GBTClassificationModel

    Permalink

    Definition Classes
    PredictionModel
  107. def setParent(parent: Estimator[GBTClassificationModel]): GBTClassificationModel

    Permalink

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes
    Model
  108. def setPredictionCol(value: String): GBTClassificationModel

    Permalink

    Definition Classes
    PredictionModel
  109. def setProbabilityCol(value: String): GBTClassificationModel

    Permalink

  110. def setRawPredictionCol(value: String): GBTClassificationModel

    Permalink

    Definition Classes
    ClassificationModel
  111. def setThresholds(value: Array[Double]): GBTClassificationModel

    Permalink

  112. final val stepSize: DoubleParam

    Permalink

    Param for Step size (a.k.a.

    Param for Step size (a.k.a. learning rate) in interval (0, 1] for shrinking the contribution of each estimator. (default = 0.1)

    Definition Classes
    GBTParams → HasStepSize
  113. final val subsamplingRate: DoubleParam

    Permalink

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

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

    Definition Classes
    TreeEnsembleParams
  114. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  115. final val thresholds: DoubleArrayParam

    Permalink

    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
  116. def toDebugString: String

    Permalink

    Full description of model

    Full description of model

    Definition Classes
    TreeEnsembleModel
  117. def toString(): String

    Permalink

    Summary of the model

    Summary of the model

    Definition Classes
    GBTClassificationModel → TreeEnsembleModel → Identifiable → AnyRef → Any
    Annotations
    @Since( "1.4.0" )
  118. lazy val totalNumNodes: Int

    Permalink

    Total number of nodes, summed over all trees in the ensemble.

    Total number of nodes, summed over all trees in the ensemble.

    Definition Classes
    TreeEnsembleModel
  119. def transform(dataset: Dataset[_]): DataFrame

    Permalink

    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
    ProbabilisticClassificationModelClassificationModelPredictionModelTransformer
  120. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink

    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" )
  121. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink

    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()
  122. def transformImpl(dataset: Dataset[_]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    GBTClassificationModelPredictionModel
  123. 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
    PredictionModelPipelineStage
  124. 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()
  125. def treeWeights: Array[Double]

    Permalink

    Weights for each tree, zippable with trees

    Weights for each tree, zippable with trees

    Definition Classes
    GBTClassificationModel → TreeEnsembleModel
    Annotations
    @Since( "1.4.0" )
  126. def trees: Array[DecisionTreeRegressionModel]

    Permalink

    Trees in this ensemble.

    Trees in this ensemble. Warning: These have null parent Estimators.

    Definition Classes
    GBTClassificationModel → TreeEnsembleModel
    Annotations
    @Since( "1.4.0" )
  127. 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
    GBTClassificationModelIdentifiable
    Annotations
    @Since( "1.6.0" )
  128. 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
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams
  129. final def wait(): Unit

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

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

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

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    GBTClassificationModelMLWritable
    Annotations
    @Since( "2.0.0" )

Deprecated Value Members

  1. def setCacheNodeIds(value: Boolean): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  2. def setCheckpointInterval(value: Int): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  3. def setFeatureSubsetStrategy(value: String): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    TreeEnsembleParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  4. def setImpurity(value: String): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    TreeClassifierParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  5. def setMaxBins(value: Int): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  6. def setMaxDepth(value: Int): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  7. def setMaxIter(value: Int): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    GBTParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  8. def setMaxMemoryInMB(value: Int): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  9. def setMinInfoGain(value: Double): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  10. def setMinInstancesPerNode(value: Int): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  11. def setSeed(value: Long): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  12. def setStepSize(value: Double): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    GBTParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

  13. def setSubsamplingRate(value: Double): GBTClassificationModel.this.type

    Permalink

    Definition Classes
    TreeEnsembleParams
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1.0) This method is deprecated and will be removed in 3.0.0.

Inherited from MLWritable

Inherited from TreeEnsembleModel[DecisionTreeRegressionModel]

Inherited from GBTClassifierParams

Inherited from TreeClassifierParams

Inherited from GBTParams

Inherited from HasStepSize

Inherited from HasMaxIter

Inherited from TreeEnsembleParams

Inherited from DecisionTreeParams

Inherited from HasSeed

Inherited from HasCheckpointInterval

Inherited from ProbabilisticClassifierParams

Inherited from HasThresholds

Inherited from HasProbabilityCol

Inherited from ClassifierParams

Inherited from HasRawPredictionCol

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Model[GBTClassificationModel]

Inherited from Transformer

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