org.apache.spark.ml.classification

RandomForestClassifier

final class RandomForestClassifier extends Predictor[Vector, RandomForestClassifier, RandomForestClassificationModel] with RandomForestParams with TreeClassifierParams

:: Experimental :: Random Forest learning algorithm for classification. It supports both binary and multiclass labels, as well as both continuous and categorical features.

Annotations
@Experimental()
Linear Supertypes
TreeClassifierParams, RandomForestParams, TreeEnsembleParams, HasSeed, DecisionTreeParams, Predictor[Vector, RandomForestClassifier, RandomForestClassificationModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Estimator[RandomForestClassificationModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. RandomForestClassifier
  2. TreeClassifierParams
  3. RandomForestParams
  4. TreeEnsembleParams
  5. HasSeed
  6. DecisionTreeParams
  7. Predictor
  8. PredictorParams
  9. HasPredictionCol
  10. HasFeaturesCol
  11. HasLabelCol
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RandomForestClassifier()

  2. new RandomForestClassifier(uid: String)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params
  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. final val cacheNodeIds: BooleanParam

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

    If false, the algorithm will pass trees to executors to match instances with nodes. If true, the algorithm will cache node IDs for each instance. Caching can speed up training of deeper trees. (default = false)

    Definition Classes
    DecisionTreeParams
  9. final val checkpointInterval: IntParam

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

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Attributes
    protected
    Definition Classes
    Params
  11. def clone(): AnyRef

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

    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. The default implementation tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance. Subclasses should override this method if the default approach is not sufficient.

    Definition Classes
    PredictorEstimatorPipelineStageParams
  13. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    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.

    to

    the target instance

    extra

    extra params to be copied

    returns

    the target instance with param values copied

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

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

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

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

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

    Definition Classes
    Params
  17. def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance.

    Definition Classes
    Params
    See also

    explainParam()

  18. def extractLabeledPoints(dataset: DataFrame): RDD[LabeledPoint]

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

    extractParamMap with no extra values.

    extractParamMap with no extra values.

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

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

    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 < user-supplied values < extra.

    Definition Classes
    Params
  21. final val featureSubsetStrategy: Param[String]

    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) (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
    RandomForestParams
    See also

    Breiman manual for random forests

    Breiman (2001)

  22. final val featuresCol: Param[String]

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def fit(dataset: DataFrame): RandomForestClassificationModel

    Fits a model to the input data.

    Fits a model to the input data.

    Definition Classes
    PredictorEstimator
  25. def fit(dataset: DataFrame, paramMaps: Array[ParamMap]): Seq[RandomForestClassificationModel]

    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
  26. def fit(dataset: DataFrame, paramMap: ParamMap): RandomForestClassificationModel

    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
  27. def fit(dataset: DataFrame, firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): RandomForestClassificationModel

    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
    @varargs()
  28. final def get[T](param: Param[T]): Option[T]

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  29. final def getCacheNodeIds: Boolean

    Definition Classes
    DecisionTreeParams
  30. final def getCheckpointInterval: Int

    Definition Classes
    DecisionTreeParams
  31. final def getClass(): Class[_]

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

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  33. final def getFeatureSubsetStrategy: String

    Definition Classes
    RandomForestParams
  34. final def getFeaturesCol: String

    Definition Classes
    HasFeaturesCol
  35. final def getImpurity: String

    Definition Classes
    TreeClassifierParams
  36. final def getLabelCol: String

    Definition Classes
    HasLabelCol
  37. final def getMaxBins: Int

    Definition Classes
    DecisionTreeParams
  38. final def getMaxDepth: Int

    Definition Classes
    DecisionTreeParams
  39. final def getMaxMemoryInMB: Int

    Definition Classes
    DecisionTreeParams
  40. final def getMinInfoGain: Double

    Definition Classes
    DecisionTreeParams
  41. final def getMinInstancesPerNode: Int

    Definition Classes
    DecisionTreeParams
  42. final def getNumTrees: Int

    Definition Classes
    RandomForestParams
  43. final def getOrDefault[T](param: Param[T]): T

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

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

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

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  45. final def getPredictionCol: String

    Definition Classes
    HasPredictionCol
  46. final def getSeed: Long

    Definition Classes
    HasSeed
  47. final def getSubsamplingRate: Double

    Definition Classes
    TreeEnsembleParams
  48. final def hasDefault[T](param: Param[T]): Boolean

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

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

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

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

    Definition Classes
    Params
  50. def hashCode(): Int

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

    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. final def isDefined(param: Param[_]): Boolean

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

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

    Definition Classes
    Params
  53. final def isInstanceOf[T0]: Boolean

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

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  55. def isTraceEnabled(): Boolean

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

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  57. def log: Logger

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

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

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  64. def logName: String

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

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

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

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

    Attributes
    protected
    Definition Classes
    Logging
  69. final val maxBins: IntParam

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

    Maximum number of bins used for discretizing continuous features and for choosing how to split on features at each node. More bins give higher granularity. Must be >= 2 and >= number of categories in any categorical feature. (default = 32)

    Definition Classes
    DecisionTreeParams
  70. final val maxDepth: IntParam

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

    Maximum memory in MB allocated to histogram aggregation.

    Maximum memory in MB allocated to histogram aggregation. (default = 256 MB)

    Definition Classes
    DecisionTreeParams
  72. final val minInfoGain: DoubleParam

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

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

    Definition Classes
    DecisionTreeParams
  73. final val minInstancesPerNode: IntParam

    Minimum number of instances each child must have after split.

    Minimum number of instances each child must have after split. If a split causes the left or right child to have fewer than minInstancesPerNode, the split will be discarded as invalid. Should be >= 1. (default = 1)

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

    Definition Classes
    AnyRef
  75. final def notify(): Unit

    Definition Classes
    AnyRef
  76. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  77. final val numTrees: IntParam

    Number of trees to train (>= 1).

    Number of trees to train (>= 1). If 1, then no bootstrapping is used. If > 1, then bootstrapping is done. TODO: Change to always do bootstrapping (simpler). SPARK-7130 (default = 20)

    Definition Classes
    RandomForestParams
  78. lazy val params: Array[Param[_]]

    Returns all params sorted by their names.

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

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

    Definition Classes
    Params
  79. final val predictionCol: Param[String]

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  80. final val seed: LongParam

    Param for random seed.

    Param for random seed.

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

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

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

    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
  83. final def set[T](param: Param[T], value: T): RandomForestClassifier.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  84. def setCacheNodeIds(value: Boolean): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
  85. def setCheckpointInterval(value: Int): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
  86. final def setDefault(paramPairs: ParamPair[_]*): RandomForestClassifier.this.type

    Sets default values for a list of params.

    Sets default values for a list of params.

    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
    Annotations
    @varargs()
  87. final def setDefault[T](param: Param[T], value: T): RandomForestClassifier.this.type

    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
  88. def setFeatureSubsetStrategy(value: String): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → RandomForestParams
  89. def setFeaturesCol(value: String): RandomForestClassifier

    Definition Classes
    Predictor
  90. def setImpurity(value: String): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → TreeClassifierParams
  91. def setLabelCol(value: String): RandomForestClassifier

    Definition Classes
    Predictor
  92. def setMaxBins(value: Int): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
  93. def setMaxDepth(value: Int): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
  94. def setMaxMemoryInMB(value: Int): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
  95. def setMinInfoGain(value: Double): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
  96. def setMinInstancesPerNode(value: Int): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
  97. def setNumTrees(value: Int): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → RandomForestParams
  98. def setPredictionCol(value: String): RandomForestClassifier

    Definition Classes
    Predictor
  99. def setSeed(value: Long): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → TreeEnsembleParams
  100. def setSubsamplingRate(value: Double): RandomForestClassifier.this.type

    Definition Classes
    RandomForestClassifier → TreeEnsembleParams
  101. final val subsamplingRate: DoubleParam

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

    Definition Classes
    AnyRef
  103. def toString(): String

    Definition Classes
    Identifiable → AnyRef → Any
  104. def train(dataset: DataFrame): RandomForestClassificationModel

    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
    RandomForestClassifierPredictor
  105. def transformSchema(schema: StructType): StructType

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema.

    Definition Classes
    PredictorPipelineStage
  106. def transformSchema(schema: StructType, logging: Boolean): StructType

    :: 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()
  107. val uid: String

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    RandomForestClassifier → Identifiable
  108. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    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
    PredictorParams
  109. def validateParams(): Unit

    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
  110. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TreeClassifierParams

Inherited from RandomForestParams

Inherited from TreeEnsembleParams

Inherited from HasSeed

Inherited from DecisionTreeParams

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