Class/Object

org.apache.spark.ml.classification

RandomForestClassifier

Related Docs: object RandomForestClassifier | package classification

Permalink

class RandomForestClassifier extends ProbabilisticClassifier[Vector, RandomForestClassifier, RandomForestClassificationModel] with RandomForestClassifierParams with DefaultParamsWritable

Random Forest learning algorithm 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
DefaultParamsWritable, MLWritable, RandomForestClassifierParams, TreeClassifierParams, RandomForestParams, HasNumTrees, HasFeatureSubsetStrategy, TreeEnsembleParams, DecisionTreeParams, HasSeed, HasCheckpointInterval, ProbabilisticClassifier[Vector, RandomForestClassifier, RandomForestClassificationModel], ProbabilisticClassifierParams, HasThresholds, HasProbabilityCol, Classifier[Vector, RandomForestClassifier, RandomForestClassificationModel], ClassifierParams, HasRawPredictionCol, 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. DefaultParamsWritable
  3. MLWritable
  4. RandomForestClassifierParams
  5. TreeClassifierParams
  6. RandomForestParams
  7. HasNumTrees
  8. HasFeatureSubsetStrategy
  9. TreeEnsembleParams
  10. DecisionTreeParams
  11. HasSeed
  12. HasCheckpointInterval
  13. ProbabilisticClassifier
  14. ProbabilisticClassifierParams
  15. HasThresholds
  16. HasProbabilityCol
  17. Classifier
  18. ClassifierParams
  19. HasRawPredictionCol
  20. Predictor
  21. PredictorParams
  22. HasPredictionCol
  23. HasFeaturesCol
  24. HasLabelCol
  25. Estimator
  26. PipelineStage
  27. Logging
  28. Params
  29. Serializable
  30. Serializable
  31. Identifiable
  32. AnyRef
  33. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RandomForestClassifier()

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

    Permalink
    Annotations
    @Since( "1.4.0" )

Value Members

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

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

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

    Permalink

    An alias for getOrDefault().

    An alias for getOrDefault().

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

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

    Permalink
    Definition Classes
    Any
  6. final val cacheNodeIds: BooleanParam

    Permalink

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

    If false, the algorithm will pass trees to executors to match instances with nodes. If true, the algorithm will cache node IDs for each instance. Caching can speed up training of deeper trees. Users can set how often should the cache be checkpointed or disable it by setting checkpointInterval. (default = false)

    Definition Classes
    DecisionTreeParams
  7. final val checkpointInterval: IntParam

    Permalink

    Param for set checkpoint interval (>= 1) or disable checkpoint (-1).

    Param for set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations.

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

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

    Permalink

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

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

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

    to

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

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

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

    Permalink

    Default implementation of copy with extra params.

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

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

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

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

    Permalink

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

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

    Definition Classes
    Params
  16. def explainParams(): String

    Permalink

    Explains all params of this instance.

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

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

    Permalink

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

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

    dataset

    DataFrame with columns for labels (org.apache.spark.sql.types.NumericType) and features (Vector). Labels are cast to DoubleType.

    numClasses

    Number of classes label can take. Labels must be integers in the range [0, numClasses).

    Attributes
    protected
    Definition Classes
    Classifier
    Exceptions thrown

    SparkException if any label is not an integer >= 0

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

    Permalink

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

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

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

    Permalink

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  20. 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
  21. 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)

  22. final val featuresCol: Param[String]

    Permalink

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  23. def finalize(): Unit

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

    Permalink

    Fits a model to the input data.

    Fits a model to the input data.

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

    Permalink

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

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

    dataset

    input dataset

    paramMaps

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

    returns

    fitted models, matching the input parameter maps

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

    Permalink

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

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

    dataset

    input dataset

    paramMap

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

    returns

    fitted model

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

    Permalink

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

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

    dataset

    input dataset

    firstParamPair

    the first param pair, overrides embedded params

    otherParamPairs

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

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. 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
  29. final def getCacheNodeIds: Boolean

    Permalink

    Definition Classes
    DecisionTreeParams
  30. final def getCheckpointInterval: Int

    Permalink

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

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

    Permalink

    Definition Classes
    HasFeatureSubsetStrategy
  34. final def getFeaturesCol: String

    Permalink

    Definition Classes
    HasFeaturesCol
  35. final def getImpurity: String

    Permalink

    Definition Classes
    TreeClassifierParams
  36. final def getLabelCol: String

    Permalink

    Definition Classes
    HasLabelCol
  37. final def getMaxBins: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  38. final def getMaxDepth: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  39. final def getMaxMemoryInMB: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  40. final def getMinInfoGain: Double

    Permalink

    Definition Classes
    DecisionTreeParams
  41. final def getMinInstancesPerNode: Int

    Permalink

    Definition Classes
    DecisionTreeParams
  42. def getNumClasses(dataset: Dataset[_], maxNumClasses: Int = 100): Int

    Permalink

    Get the number of classes.

    Get the number of classes. This looks in column metadata first, and if that is missing, then this assumes classes are indexed 0,1,...,numClasses-1 and computes numClasses by finding the maximum label value.

    Label validation (ensuring all labels are integers >= 0) needs to be handled elsewhere, such as in extractLabeledPoints().

    dataset

    Dataset which contains a column labelCol

    maxNumClasses

    Maximum number of classes allowed when inferred from data. If numClasses is specified in the metadata, then maxNumClasses is ignored.

    returns

    number of classes

    Attributes
    protected
    Definition Classes
    Classifier
    Exceptions thrown

    IllegalArgumentException if metadata does not specify numClasses, and the actual numClasses exceeds maxNumClasses

  43. final def getNumTrees: Int

    Permalink

    Definition Classes
    HasNumTrees
  44. 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
  45. def getParam(paramName: String): Param[Any]

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  46. final def getPredictionCol: String

    Permalink

    Definition Classes
    HasPredictionCol
  47. final def getProbabilityCol: String

    Permalink

    Definition Classes
    HasProbabilityCol
  48. final def getRawPredictionCol: String

    Permalink

    Definition Classes
    HasRawPredictionCol
  49. final def getSeed: Long

    Permalink

    Definition Classes
    HasSeed
  50. final def getSubsamplingRate: Double

    Permalink

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

    Permalink

    Definition Classes
    HasThresholds
  52. 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
  53. 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
  54. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  55. 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
  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. 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
  75. 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
  76. 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
  77. 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
  78. 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
  79. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  82. final val numTrees: IntParam

    Permalink

    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
    HasNumTrees
  83. 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
  84. final val predictionCol: Param[String]

    Permalink

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  85. 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
  86. 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
  87. 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( ... )
  88. final val seed: LongParam

    Permalink

    Param for random seed.

    Param for random seed.

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

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

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

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  92. def setCacheNodeIds(value: Boolean): RandomForestClassifier.this.type

    Permalink

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  93. def setCheckpointInterval(value: Int): RandomForestClassifier.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
    RandomForestClassifier → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  94. final def setDefault(paramPairs: ParamPair[_]*): RandomForestClassifier.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
  95. final def setDefault[T](param: Param[T], value: T): RandomForestClassifier.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
  96. def setFeatureSubsetStrategy(value: String): RandomForestClassifier.this.type

    Permalink

    Definition Classes
    RandomForestClassifier → HasFeatureSubsetStrategy
    Annotations
    @Since( "1.4.0" )
  97. def setFeaturesCol(value: String): RandomForestClassifier

    Permalink

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

    Permalink

    Definition Classes
    RandomForestClassifier → TreeClassifierParams
    Annotations
    @Since( "1.4.0" )
  99. def setLabelCol(value: String): RandomForestClassifier

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

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

    Permalink

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  105. def setNumTrees(value: Int): RandomForestClassifier.this.type

    Permalink

    Definition Classes
    RandomForestClassifier → HasNumTrees
    Annotations
    @Since( "1.4.0" )
  106. def setPredictionCol(value: String): RandomForestClassifier

    Permalink

    Definition Classes
    Predictor
  107. def setProbabilityCol(value: String): RandomForestClassifier

    Permalink

    Definition Classes
    ProbabilisticClassifier
  108. def setRawPredictionCol(value: String): RandomForestClassifier

    Permalink

    Definition Classes
    Classifier
  109. def setSeed(value: Long): RandomForestClassifier.this.type

    Permalink

    Definition Classes
    RandomForestClassifier → DecisionTreeParams
    Annotations
    @Since( "1.4.0" )
  110. def setSubsamplingRate(value: Double): RandomForestClassifier.this.type

    Permalink

    Definition Classes
    RandomForestClassifier → TreeEnsembleParams
    Annotations
    @Since( "1.4.0" )
  111. def setThresholds(value: Array[Double]): RandomForestClassifier

    Permalink

    Definition Classes
    ProbabilisticClassifier
  112. 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
  113. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  114. 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
  115. def toString(): String

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

    Permalink

    Train a model using the given dataset and parameters.

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

    dataset

    Training dataset

    returns

    Fitted model

    Attributes
    protected
    Definition Classes
    RandomForestClassifierPredictor
  117. 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
    PredictorPipelineStage
  118. 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()
  119. 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
    RandomForestClassifierIdentifiable
    Annotations
    @Since( "1.4.0" )
  120. 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
  121. final def wait(): Unit

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

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

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

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DefaultParamsWritableMLWritable

Deprecated Value Members

  1. 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 DefaultParamsWritable

Inherited from MLWritable

Inherited from RandomForestClassifierParams

Inherited from TreeClassifierParams

Inherited from RandomForestParams

Inherited from HasNumTrees

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