Class/Object

org.apache.spark.ml.classification

RandomForestClassificationModel

Related Docs: object RandomForestClassificationModel | package classification

Permalink

class RandomForestClassificationModel extends ProbabilisticClassificationModel[Vector, RandomForestClassificationModel] with RandomForestClassificationModelParams with TreeEnsembleModel[DecisionTreeClassificationModel] with MLWritable with Serializable

Random Forest model for classification. It supports both binary and multiclass labels, as well as both continuous and categorical features.

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

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.

    Definition Classes
    HasCheckpointInterval
  8. final def clear(param: Param[_]): RandomForestClassificationModel.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): RandomForestClassificationModel

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

    Annotations
    @Since( "1.5.0" )
    See also

    DecisionTreeClassificationModel.featureImportances

  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
    HasFeatureSubsetStrategy
    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
    HasFeatureSubsetStrategy
  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. final def getMaxBins: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  34. final def getMaxDepth: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  35. final def getMaxMemoryInMB: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  36. final def getMinInfoGain: Double

    Permalink

    Definition Classes
    DecisionTreeParams
  37. final def getMinInstancesPerNode: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  38. val getNumTrees: Int

    Permalink

    Number of trees in ensemble

    Number of trees in ensemble

    Definition Classes
    TreeEnsembleModel
  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 getProbabilityCol: String

    Permalink

    Definition Classes
    HasProbabilityCol
  43. final def getRawPredictionCol: String

    Permalink

    Definition Classes
    HasRawPredictionCol
  44. final def getSeed: Long

    Permalink

    Definition Classes
    HasSeed
  45. final def getSubsamplingRate: Double

    Permalink

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

    Permalink

    Definition Classes
    HasThresholds
  47. 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
  48. 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
  49. def hasParent: Boolean

    Permalink

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes
    Model
  50. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  51. 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
  52. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

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

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

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  56. def isTraceEnabled(): Boolean

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

    Permalink

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  58. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. 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
  71. 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
  72. 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
  73. 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. (default = 0.0)

    Definition Classes
    DecisionTreeParams
  74. 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
  75. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  78. val numClasses: Int

    Permalink

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

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

    Definition Classes
    RandomForestClassificationModelClassificationModel
    Annotations
    @Since( "1.5.0" )
  79. 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
    RandomForestClassificationModelPredictionModel
    Annotations
    @Since( "1.6.0" )
  80. 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.

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

    Definition Classes
    Params
  81. var parent: Estimator[RandomForestClassificationModel]

    Permalink

    The parent estimator that produced this model.

    The parent estimator that produced this model. Note: For ensembles' component Models, this value can be null.

    Definition Classes
    Model
  82. 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
    ClassificationModelPredictionModel
  83. 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
  84. 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
    RandomForestClassificationModelClassificationModel
  85. final val predictionCol: Param[String]

    Permalink

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  86. 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
  87. 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
  88. 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
  89. def raw2probability(rawPrediction: Vector): Vector

    Permalink

    Non-in-place version of raw2probabilityInPlace()

    Non-in-place version of raw2probabilityInPlace()

    Attributes
    protected
    Definition Classes
    ProbabilisticClassificationModel
  90. 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
    RandomForestClassificationModelProbabilisticClassificationModel
  91. 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
  92. 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( ... )
  93. final val seed: LongParam

    Permalink

    Param for random seed.

    Param for random seed.

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

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

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

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  97. def setCacheNodeIds(value: Boolean): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
  98. def setCheckpointInterval(value: Int): RandomForestClassificationModel.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 >= 1. (default = 10)

    Definition Classes
    DecisionTreeParams
  99. final def setDefault(paramPairs: ParamPair[_]*): RandomForestClassificationModel.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
  100. final def setDefault[T](param: Param[T], value: T): RandomForestClassificationModel.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
  101. def setFeatureSubsetStrategy(value: String): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    HasFeatureSubsetStrategy
  102. def setFeaturesCol(value: String): RandomForestClassificationModel

    Permalink

    Definition Classes
    PredictionModel
  103. def setImpurity(value: String): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    TreeClassifierParams
  104. def setMaxBins(value: Int): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
  105. def setMaxDepth(value: Int): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
  106. def setMaxMemoryInMB(value: Int): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
  107. def setMinInfoGain(value: Double): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
  108. def setMinInstancesPerNode(value: Int): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
  109. def setParent(parent: Estimator[RandomForestClassificationModel]): RandomForestClassificationModel

    Permalink

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes
    Model
  110. def setPredictionCol(value: String): RandomForestClassificationModel

    Permalink

    Definition Classes
    PredictionModel
  111. def setProbabilityCol(value: String): RandomForestClassificationModel

    Permalink

  112. def setRawPredictionCol(value: String): RandomForestClassificationModel

    Permalink

    Definition Classes
    ClassificationModel
  113. def setSeed(value: Long): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    DecisionTreeParams
  114. def setSubsamplingRate(value: Double): RandomForestClassificationModel.this.type

    Permalink

    Definition Classes
    TreeEnsembleParams
  115. def setThresholds(value: Array[Double]): RandomForestClassificationModel

    Permalink

  116. 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
  117. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  118. 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. The class with largest value p/t is predicted, where p is the original probability of that class and t is the class' threshold.

    Definition Classes
    HasThresholds
  119. def toDebugString: String

    Permalink

    Full description of model

    Full description of model

    Definition Classes
    TreeEnsembleModel
  120. def toString(): String

    Permalink

    Summary of the model

    Summary of the model

    Definition Classes
    RandomForestClassificationModel → TreeEnsembleModel → Identifiable → AnyRef → Any
    Annotations
    @Since( "1.4.0" )
  121. 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
  122. 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
  123. 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" )
  124. 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()
  125. def transformImpl(dataset: Dataset[_]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    RandomForestClassificationModelPredictionModel
  126. def transformSchema(schema: StructType): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

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

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

    Definition Classes
    PredictionModelPipelineStage
  127. 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()
  128. def treeWeights: Array[Double]

    Permalink

    Weights for each tree, zippable with trees

    Weights for each tree, zippable with trees

    Definition Classes
    RandomForestClassificationModel → TreeEnsembleModel
    Annotations
    @Since( "1.4.0" )
  129. def trees: Array[DecisionTreeClassificationModel]

    Permalink

    Trees in this ensemble.

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

    Definition Classes
    RandomForestClassificationModel → TreeEnsembleModel
    Annotations
    @Since( "1.4.0" )
  130. 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
    RandomForestClassificationModelIdentifiable
    Annotations
    @Since( "1.5.0" )
  131. 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., org.apache.spark.mllib.linalg.VectorUDT for vector features.

    returns

    output schema

    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams
  132. final def wait(): Unit

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

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

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

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    RandomForestClassificationModelMLWritable
    Annotations
    @Since( "2.0.0" )

Deprecated Value Members

  1. val numTrees: Int

    Permalink

    Number of trees in ensemble

    Number of trees in ensemble

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use getNumTrees instead. This method will be removed in 2.1.0.

  2. def validateParams(): Unit

    Permalink

    Validates parameter values stored internally.

    Validates parameter values stored internally. Raise an exception if any parameter value is invalid.

    This only needs to check for interactions between parameters. Parameter value checks which do not depend on other parameters are handled by Param.validate(). This method does not handle input/output column parameters; those are checked during schema validation.

    Definition Classes
    Params
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Will be removed in 2.1.0. Checks should be merged into transformSchema.

Inherited from MLWritable

Inherited from TreeEnsembleModel[DecisionTreeClassificationModel]

Inherited from RandomForestClassificationModelParams

Inherited from TreeClassifierParams

Inherited from HasFeatureSubsetStrategy

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