GBTRegressionModel (Spark 3.5.5 JavaDoc) (original) (raw)

Modifier and Type

Method and Description

[BooleanParam](../../../../../org/apache/spark/ml/param/BooleanParam.html "class in org.apache.spark.ml.param")

[cacheNodeIds](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#cacheNodeIds--)()

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

[IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param")

[checkpointInterval](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#checkpointInterval--)()

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

[GBTRegressionModel](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html "class in org.apache.spark.ml.regression")

[copy](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#copy-org.apache.spark.ml.param.ParamMap-)([ParamMap](../../../../../org/apache/spark/ml/param/ParamMap.html "class in org.apache.spark.ml.param") extra)

Creates a copy of this instance with the same UID and some extra params.

double[]

[evaluateEachIteration](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#evaluateEachIteration-org.apache.spark.sql.Dataset-java.lang.String-)([Dataset](../../../../../org/apache/spark/sql/Dataset.html "class in org.apache.spark.sql")<?> dataset, String loss)

Method to compute error or loss for every iteration of gradient boosting.

[Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg")

[featureImportances](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#featureImportances--)()

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String>

[featureSubsetStrategy](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#featureSubsetStrategy--)()

The number of features to consider for splits at each tree node.

int

[getNumTrees](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#getNumTrees--)()

Number of trees in ensemble

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String>

[impurity](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#impurity--)()

Criterion used for information gain calculation (case-insensitive).

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String>

[leafCol](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#leafCol--)()

Leaf indices column name.

static [GBTRegressionModel](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html "class in org.apache.spark.ml.regression")

[load](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#load-java.lang.String-)(String path)

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String>

[lossType](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#lossType--)()

Loss function which GBT tries to minimize.

[IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param")

[maxBins](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#maxBins--)()

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

[IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param")

[maxDepth](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#maxDepth--)()

Maximum depth of the tree (nonnegative).

[IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param")

[maxIter](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#maxIter--)()

Param for maximum number of iterations (>= 0).

[IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param")

[maxMemoryInMB](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#maxMemoryInMB--)()

Maximum memory in MB allocated to histogram aggregation.

[DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param")

[minInfoGain](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#minInfoGain--)()

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

[IntParam](../../../../../org/apache/spark/ml/param/IntParam.html "class in org.apache.spark.ml.param")

[minInstancesPerNode](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#minInstancesPerNode--)()

Minimum number of instances each child must have after split.

[DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param")

[minWeightFractionPerNode](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#minWeightFractionPerNode--)()

Minimum fraction of the weighted sample count that each child must have after split.

int

[numFeatures](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#numFeatures--)()

Returns the number of features the model was trained on.

double

[predict](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#predict-org.apache.spark.ml.linalg.Vector-)([Vector](../../../../../org/apache/spark/ml/linalg/Vector.html "interface in org.apache.spark.ml.linalg") features)

Predict label for the given features.

static [MLReader](../../../../../org/apache/spark/ml/util/MLReader.html "class in org.apache.spark.ml.util")<[GBTRegressionModel](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html "class in org.apache.spark.ml.regression")>

[read](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#read--)()

[LongParam](../../../../../org/apache/spark/ml/param/LongParam.html "class in org.apache.spark.ml.param")

[seed](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#seed--)()

Param for random seed.

[DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param")

[stepSize](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#stepSize--)()

Param for Step size (a.k.a.

[DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param")

[subsamplingRate](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#subsamplingRate--)()

Fraction of the training data used for learning each decision tree, in range (0, 1].

String

[toString](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#toString--)()

Summary of the model

int

[totalNumNodes](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#totalNumNodes--)()

Total number of nodes, summed over all trees in the ensemble.

[Dataset](../../../../../org/apache/spark/sql/Dataset.html "class in org.apache.spark.sql")<[Row](../../../../../org/apache/spark/sql/Row.html "interface in org.apache.spark.sql")>

[transform](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#transform-org.apache.spark.sql.Dataset-)([Dataset](../../../../../org/apache/spark/sql/Dataset.html "class in org.apache.spark.sql")<?> dataset)

Transforms dataset by reading from featuresCol, calling predict, and storing the predictions as a new column predictionCol.

[StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types")

[transformSchema](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#transformSchema-org.apache.spark.sql.types.StructType-)([StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") schema)

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

[DecisionTreeRegressionModel](../../../../../org/apache/spark/ml/regression/DecisionTreeRegressionModel.html "class in org.apache.spark.ml.regression")[]

[trees](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#trees--)()

Trees in this ensemble.

double[]

[treeWeights](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#treeWeights--)()

Weights for each tree, zippable with trees

String

[uid](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#uid--)()

An immutable unique ID for the object and its derivatives.

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String>

[validationIndicatorCol](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#validationIndicatorCol--)()

Param for name of the column that indicates whether each row is for training or for validation.

[DoubleParam](../../../../../org/apache/spark/ml/param/DoubleParam.html "class in org.apache.spark.ml.param")

[validationTol](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#validationTol--)()

Threshold for stopping early when fit with validation is used.

[Param](../../../../../org/apache/spark/ml/param/Param.html "class in org.apache.spark.ml.param")<String>

[weightCol](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#weightCol--)()

Param for weight column name.

[MLWriter](../../../../../org/apache/spark/ml/util/MLWriter.html "class in org.apache.spark.ml.util")

[write](../../../../../org/apache/spark/ml/regression/GBTRegressionModel.html#write--)()

Returns an MLWriter instance for this ML instance.