Package org.apache.spark.ml.classification

Class RandomForestClassifier

Object
org.apache.spark.ml.PipelineStage
org.apache.spark.ml.Estimator<M>
org.apache.spark.ml.Predictor<FeaturesType,E,M>
org.apache.spark.ml.classification.Classifier<FeaturesType,E,M>
org.apache.spark.ml.classification.ProbabilisticClassifier<Vector,RandomForestClassifier,RandomForestClassificationModel>
org.apache.spark.ml.classification.RandomForestClassifier
All Implemented Interfaces:
Serializable, org.apache.spark.internal.Logging, org.apache.spark.ml.classification.ClassifierParams, org.apache.spark.ml.classification.ProbabilisticClassifierParams, Params, HasCheckpointInterval, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasProbabilityCol, HasRawPredictionCol, HasSeed, HasThresholds, HasWeightCol, org.apache.spark.ml.PredictorParams, org.apache.spark.ml.tree.DecisionTreeParams, org.apache.spark.ml.tree.RandomForestClassifierParams, org.apache.spark.ml.tree.RandomForestParams, org.apache.spark.ml.tree.TreeClassifierParams, org.apache.spark.ml.tree.TreeEnsembleClassifierParams, org.apache.spark.ml.tree.TreeEnsembleParams, DefaultParamsWritable, Identifiable, MLWritable
public class RandomForestClassifier extends ProbabilisticClassifier<Vector,RandomForestClassifier,RandomForestClassificationModel> implements org.apache.spark.ml.tree.RandomForestClassifierParams, DefaultParamsWritable
Random Forest learning algorithm for classification. It supports both binary and multiclass labels, as well as both continuous and categorical features.
See Also:

  • Constructor Details

    • RandomForestClassifier

      public RandomForestClassifier(String uid)

    • RandomForestClassifier

      public RandomForestClassifier()

  • Method Details

    • supportedImpurities

      public static final String[] supportedImpurities()
      Accessor for supported impurity settings: entropy, gini

    • supportedFeatureSubsetStrategies

      public static final String[] supportedFeatureSubsetStrategies()
      Accessor for supported featureSubsetStrategy settings: auto, all, onethird, sqrt, log2

    • load

      public static RandomForestClassifier load(String path)

    • read

      public static MLReader<T> read()

    • impurity

      public final Param<String> impurity()
      Specified by:
      impurity in interface org.apache.spark.ml.tree.TreeClassifierParams

    • numTrees

      public final IntParam numTrees()
      Specified by:
      numTrees in interface org.apache.spark.ml.tree.RandomForestParams

    • bootstrap

      public final BooleanParam bootstrap()
      Specified by:
      bootstrap in interface org.apache.spark.ml.tree.RandomForestParams

    • subsamplingRate

      public final DoubleParam subsamplingRate()
      Specified by:
      subsamplingRate in interface org.apache.spark.ml.tree.TreeEnsembleParams

    • featureSubsetStrategy

      public final Param<String> featureSubsetStrategy()
      Specified by:
      featureSubsetStrategy in interface org.apache.spark.ml.tree.TreeEnsembleParams

    • leafCol

      public final Param<String> leafCol()
      Specified by:
      leafCol in interface org.apache.spark.ml.tree.DecisionTreeParams

    • maxDepth

      public final IntParam maxDepth()
      Specified by:
      maxDepth in interface org.apache.spark.ml.tree.DecisionTreeParams

    • maxBins

      public final IntParam maxBins()
      Specified by:
      maxBins in interface org.apache.spark.ml.tree.DecisionTreeParams

    • minInstancesPerNode

      public final IntParam minInstancesPerNode()
      Specified by:
      minInstancesPerNode in interface org.apache.spark.ml.tree.DecisionTreeParams

    • minWeightFractionPerNode

      public final DoubleParam minWeightFractionPerNode()
      Specified by:
      minWeightFractionPerNode in interface org.apache.spark.ml.tree.DecisionTreeParams

    • minInfoGain

      public final DoubleParam minInfoGain()
      Specified by:
      minInfoGain in interface org.apache.spark.ml.tree.DecisionTreeParams

    • maxMemoryInMB

      public final IntParam maxMemoryInMB()
      Specified by:
      maxMemoryInMB in interface org.apache.spark.ml.tree.DecisionTreeParams

    • cacheNodeIds

      public final BooleanParam cacheNodeIds()
      Specified by:
      cacheNodeIds in interface org.apache.spark.ml.tree.DecisionTreeParams

    • weightCol

      public final Param<String> weightCol()
      Description copied from interface: HasWeightCol
      Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.
      Specified by:
      weightCol in interface HasWeightCol
      Returns:
      (undocumented)

    • seed

      public final LongParam seed()
      Description copied from interface: HasSeed
      Param for random seed.
      Specified by:
      seed in interface HasSeed
      Returns:
      (undocumented)

    • checkpointInterval

      public final IntParam checkpointInterval()
      Description copied from interface: HasCheckpointInterval
      Param for set checkpoint interval (&gt;= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations. Note: this setting will be ignored if the checkpoint directory is not set in the SparkContext.
      Specified by:
      checkpointInterval in interface HasCheckpointInterval
      Returns:
      (undocumented)

    • uid

      public String uid()
      Description copied from interface: Identifiable
      An immutable unique ID for the object and its derivatives.
      Specified by:
      uid in interface Identifiable
      Returns:
      (undocumented)

    • setMaxDepth

      public RandomForestClassifier setMaxDepth(int value)

    • setMaxBins

      public RandomForestClassifier setMaxBins(int value)

    • setMinInstancesPerNode

      public RandomForestClassifier setMinInstancesPerNode(int value)

    • setMinWeightFractionPerNode

      public RandomForestClassifier setMinWeightFractionPerNode(double value)

    • setMinInfoGain

      public RandomForestClassifier setMinInfoGain(double value)

    • setMaxMemoryInMB

      public RandomForestClassifier setMaxMemoryInMB(int value)

    • setCacheNodeIds

      public RandomForestClassifier setCacheNodeIds(boolean value)

    • setCheckpointInterval

      public RandomForestClassifier setCheckpointInterval(int value)
      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 SparkContext. Must be at least 1. (default = 10)
      Parameters:
      value - (undocumented)
      Returns:
      (undocumented)

    • setImpurity

      public RandomForestClassifier setImpurity(String value)

    • setSubsamplingRate

      public RandomForestClassifier setSubsamplingRate(double value)

    • setSeed

      public RandomForestClassifier setSeed(long value)

    • setNumTrees

      public RandomForestClassifier setNumTrees(int value)

    • setBootstrap

      public RandomForestClassifier setBootstrap(boolean value)

    • setFeatureSubsetStrategy

      public RandomForestClassifier setFeatureSubsetStrategy(String value)

    • setWeightCol

      public RandomForestClassifier setWeightCol(String value)
      Sets the value of param weightCol(). If this is not set or empty, we treat all instance weights as 1.0. By default the weightCol is not set, so all instances have weight 1.0.

      Parameters:
      value - (undocumented)
      Returns:
      (undocumented)

    • copy

      public RandomForestClassifier copy(ParamMap extra)
      Description copied from interface: 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().
      Specified by:
      copy in interface Params
      Specified by:
      copy in class Predictor<Vector,RandomForestClassifier,RandomForestClassificationModel>
      Parameters:
      extra - (undocumented)
      Returns:
      (undocumented)