Package org.apache.spark.ml.regression

Class RandomForestRegressionModel

Object
org.apache.spark.ml.PipelineStage
org.apache.spark.ml.Transformer
org.apache.spark.ml.Model<M>
org.apache.spark.ml.PredictionModel<FeaturesType,M>
org.apache.spark.ml.regression.RegressionModel<Vector,RandomForestRegressionModel>
org.apache.spark.ml.regression.RandomForestRegressionModel
All Implemented Interfaces:
Serializable, org.apache.spark.internal.Logging, Params, HasCheckpointInterval, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasSeed, HasWeightCol, org.apache.spark.ml.PredictorParams, org.apache.spark.ml.tree.DecisionTreeParams, org.apache.spark.ml.tree.HasVarianceImpurity, org.apache.spark.ml.tree.RandomForestParams, org.apache.spark.ml.tree.RandomForestRegressorParams, org.apache.spark.ml.tree.TreeEnsembleModel<DecisionTreeRegressionModel>, org.apache.spark.ml.tree.TreeEnsembleParams, org.apache.spark.ml.tree.TreeEnsembleRegressorParams, org.apache.spark.ml.tree.TreeRegressorParams, Identifiable, MLWritable
public class RandomForestRegressionModel extends RegressionModel<Vector,RandomForestRegressionModel> implements org.apache.spark.ml.tree.RandomForestRegressorParams, org.apache.spark.ml.tree.TreeEnsembleModel<DecisionTreeRegressionModel>, MLWritable, Serializable
Random Forest model for regression. It supports both continuous and categorical features.

param: _trees Decision trees in the ensemble. param: numFeatures Number of features used by this model

See Also:

  • Method Details

    • read

      public static MLReader<RandomForestRegressionModel> read()

    • load

      public static RandomForestRegressionModel load(String path)

    • totalNumNodes

      public int totalNumNodes()
      Specified by:
      totalNumNodes in interface org.apache.spark.ml.tree.TreeEnsembleModel<DecisionTreeRegressionModel>

    • impurity

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

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

    • numFeatures

      public int numFeatures()
      Description copied from class: PredictionModel
      Returns the number of features the model was trained on. If unknown, returns -1
      Overrides:
      numFeatures in class PredictionModel<Vector,RandomForestRegressionModel>

    • trees

      public DecisionTreeRegressionModel[] trees()
      Specified by:
      trees in interface org.apache.spark.ml.tree.TreeEnsembleModel<DecisionTreeRegressionModel>

    • treeWeights

      public double[] treeWeights()
      Specified by:
      treeWeights in interface org.apache.spark.ml.tree.TreeEnsembleModel<DecisionTreeRegressionModel>

    • transformSchema

      public StructType transformSchema(StructType schema)
      Description copied from class: PipelineStage
      Check transform validity and derive the output schema from the input schema.

      We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

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

      Overrides:
      transformSchema in class PredictionModel<Vector,RandomForestRegressionModel>
      Parameters:
      schema - (undocumented)
      Returns:
      (undocumented)

    • transform

      public Dataset<Row> transform(Dataset<?> dataset)
      Description copied from class: PredictionModel
      Transforms dataset by reading from PredictionModel.featuresCol(), calling predict, and storing the predictions as a new column PredictionModel.predictionCol().

      Overrides:
      transform in class PredictionModel<Vector,RandomForestRegressionModel>
      Parameters:
      dataset - input dataset
      Returns:
      transformed dataset with PredictionModel.predictionCol() of type Double

    • predict

      public double predict(Vector features)
      Description copied from class: PredictionModel
      Predict label for the given features. This method is used to implement transform() and output PredictionModel.predictionCol().
      Specified by:
      predict in class PredictionModel<Vector,RandomForestRegressionModel>
      Parameters:
      features - (undocumented)
      Returns:
      (undocumented)

    • copy

      public RandomForestRegressionModel 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 Model<RandomForestRegressionModel>
      Parameters:
      extra - (undocumented)
      Returns:
      (undocumented)

    • toString

      public String toString()
      Specified by:
      toString in interface Identifiable
      Specified by:
      toString in interface org.apache.spark.ml.tree.TreeEnsembleModel<DecisionTreeRegressionModel>
      Overrides:
      toString in class Object

    • featureImportances

      public Vector featureImportances()

    • write

      public MLWriter write()
      Description copied from interface: MLWritable
      Returns an MLWriter instance for this ML instance.
      Specified by:
      write in interface MLWritable
      Returns:
      (undocumented)