GBTClassifier (Spark 3.5.5 JavaDoc) (original) (raw)
Method Summary
All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type | Method and Description |
---|---|
BooleanParam | cacheNodeIds() If false, the algorithm will pass trees to executors to match instances with nodes. |
IntParam | checkpointInterval() Param for set checkpoint interval (>= 1) or disable checkpoint (-1). |
GBTClassifier | copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params. |
Param | featureSubsetStrategy() The number of features to consider for splits at each tree node. |
Param | impurity() Criterion used for information gain calculation (case-insensitive). |
Param | leafCol() Leaf indices column name. |
static GBTClassifier | load(String path) |
Param | lossType() Loss function which GBT tries to minimize. |
IntParam | maxBins() Maximum number of bins used for discretizing continuous features and for choosing how to split on features at each node. |
IntParam | maxDepth() Maximum depth of the tree (nonnegative). |
IntParam | maxIter() Param for maximum number of iterations (>= 0). |
IntParam | maxMemoryInMB() Maximum memory in MB allocated to histogram aggregation. |
DoubleParam | minInfoGain() Minimum information gain for a split to be considered at a tree node. |
IntParam | minInstancesPerNode() Minimum number of instances each child must have after split. |
DoubleParam | minWeightFractionPerNode() Minimum fraction of the weighted sample count that each child must have after split. |
static MLReader | read() |
LongParam | seed() Param for random seed. |
GBTClassifier | setCacheNodeIds(boolean value) |
GBTClassifier | setCheckpointInterval(int value) Specifies how often to checkpoint the cached node IDs. |
GBTClassifier | setFeatureSubsetStrategy(String value) |
GBTClassifier | setImpurity(String value) The impurity setting is ignored for GBT models. |
GBTClassifier | setLossType(String value) |
GBTClassifier | setMaxBins(int value) |
GBTClassifier | setMaxDepth(int value) |
GBTClassifier | setMaxIter(int value) |
GBTClassifier | setMaxMemoryInMB(int value) |
GBTClassifier | setMinInfoGain(double value) |
GBTClassifier | setMinInstancesPerNode(int value) |
GBTClassifier | setMinWeightFractionPerNode(double value) |
GBTClassifier | setSeed(long value) |
GBTClassifier | setStepSize(double value) |
GBTClassifier | setSubsamplingRate(double value) |
GBTClassifier | setValidationIndicatorCol(String value) |
GBTClassifier | setWeightCol(String value) Sets the value of param weightCol. |
DoubleParam | stepSize() Param for Step size (a.k.a. |
DoubleParam | subsamplingRate() Fraction of the training data used for learning each decision tree, in range (0, 1]. |
static String[] | supportedLossTypes() Accessor for supported loss settings: logistic |
String | uid() An immutable unique ID for the object and its derivatives. |
Param | validationIndicatorCol() Param for name of the column that indicates whether each row is for training or for validation. |
DoubleParam | validationTol() Threshold for stopping early when fit with validation is used. |
Param | weightCol() Param for weight column name. |
ProbabilisticClassifier
Methods inherited from class org.apache.spark.ml.classification.
[probabilityCol](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#probabilityCol--), [setProbabilityCol](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#setProbabilityCol-java.lang.String-), [setThresholds](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#setThresholds-double:A-), [thresholds](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#thresholds--)
Classifier
Methods inherited from class org.apache.spark.ml.classification.
[rawPredictionCol](../../../../../org/apache/spark/ml/classification/Classifier.html#rawPredictionCol--), [setRawPredictionCol](../../../../../org/apache/spark/ml/classification/Classifier.html#setRawPredictionCol-java.lang.String-)
Predictor
Methods inherited from class org.apache.spark.ml.
[featuresCol](../../../../../org/apache/spark/ml/Predictor.html#featuresCol--), [fit](../../../../../org/apache/spark/ml/Predictor.html#fit-org.apache.spark.sql.Dataset-), [labelCol](../../../../../org/apache/spark/ml/Predictor.html#labelCol--), [predictionCol](../../../../../org/apache/spark/ml/Predictor.html#predictionCol--), [setFeaturesCol](../../../../../org/apache/spark/ml/Predictor.html#setFeaturesCol-java.lang.String-), [setLabelCol](../../../../../org/apache/spark/ml/Predictor.html#setLabelCol-java.lang.String-), [setPredictionCol](../../../../../org/apache/spark/ml/Predictor.html#setPredictionCol-java.lang.String-), [transformSchema](../../../../../org/apache/spark/ml/Predictor.html#transformSchema-org.apache.spark.sql.types.StructType-)
Estimator
Methods inherited from class org.apache.spark.ml.
[fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-), [fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-), [fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-), [fit](../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-scala.collection.Seq-)
PipelineStage
Methods inherited from class org.apache.spark.ml.
[params](../../../../../org/apache/spark/ml/PipelineStage.html#params--)
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
GBTClassifierParams
Methods inherited from interface org.apache.spark.ml.tree.
[getLossType](../../../../../org/apache/spark/ml/tree/GBTClassifierParams.html#getLossType--), [getOldLossType](../../../../../org/apache/spark/ml/tree/GBTClassifierParams.html#getOldLossType--)
GBTParams
Methods inherited from interface org.apache.spark.ml.tree.
[getOldBoostingStrategy](../../../../../org/apache/spark/ml/tree/GBTParams.html#getOldBoostingStrategy-scala.collection.immutable.Map-scala.Enumeration.Value-), [getValidationTol](../../../../../org/apache/spark/ml/tree/GBTParams.html#getValidationTol--)
HasMaxIter
Methods inherited from interface org.apache.spark.ml.param.shared.
[getMaxIter](../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#getMaxIter--)
HasStepSize
Methods inherited from interface org.apache.spark.ml.param.shared.
[getStepSize](../../../../../org/apache/spark/ml/param/shared/HasStepSize.html#getStepSize--)
HasValidationIndicatorCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getValidationIndicatorCol](../../../../../org/apache/spark/ml/param/shared/HasValidationIndicatorCol.html#getValidationIndicatorCol--)
TreeEnsembleClassifierParams
Methods inherited from interface org.apache.spark.ml.tree.
[validateAndTransformSchema](../../../../../org/apache/spark/ml/tree/TreeEnsembleClassifierParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-)
TreeEnsembleParams
Methods inherited from interface org.apache.spark.ml.tree.
[getFeatureSubsetStrategy](../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#getFeatureSubsetStrategy--), [getOldStrategy](../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#getOldStrategy-scala.collection.immutable.Map-int-scala.Enumeration.Value-org.apache.spark.mllib.tree.impurity.Impurity-), [getSubsamplingRate](../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#getSubsamplingRate--)
DecisionTreeParams
Methods inherited from interface org.apache.spark.ml.tree.
[getCacheNodeIds](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getCacheNodeIds--), [getLeafCol](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getLeafCol--), [getMaxBins](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMaxBins--), [getMaxDepth](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMaxDepth--), [getMaxMemoryInMB](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMaxMemoryInMB--), [getMinInfoGain](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMinInfoGain--), [getMinInstancesPerNode](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMinInstancesPerNode--), [getMinWeightFractionPerNode](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getMinWeightFractionPerNode--), [getOldStrategy](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#getOldStrategy-scala.collection.immutable.Map-int-scala.Enumeration.Value-org.apache.spark.mllib.tree.impurity.Impurity-double-), [setLeafCol](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#setLeafCol-java.lang.String-)
HasCheckpointInterval
Methods inherited from interface org.apache.spark.ml.param.shared.
[getCheckpointInterval](../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html#getCheckpointInterval--)
HasSeed
Methods inherited from interface org.apache.spark.ml.param.shared.
[getSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#getSeed--)
HasWeightCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#getWeightCol--)
HasLabelCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#getLabelCol--), [labelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#labelCol--)
HasFeaturesCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[featuresCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#featuresCol--), [getFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#getFeaturesCol--)
HasPredictionCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#getPredictionCol--), [predictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#predictionCol--)
Params
Methods inherited from interface org.apache.spark.ml.param.
[clear](../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-), [copyValues](../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-), [defaultCopy](../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-), [defaultParamMap](../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--), [explainParam](../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-), [explainParams](../../../../../org/apache/spark/ml/param/Params.html#explainParams--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--), [extractParamMap](../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-), [get](../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-), [getDefault](../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-), [getOrDefault](../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-), [getParam](../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-), [hasDefault](../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-), [hasParam](../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-), [isDefined](../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-), [isSet](../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-), [onParamChange](../../../../../org/apache/spark/ml/param/Params.html#onParamChange-org.apache.spark.ml.param.Param-), [paramMap](../../../../../org/apache/spark/ml/param/Params.html#paramMap--), [params](../../../../../org/apache/spark/ml/param/Params.html#params--), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-), [set](../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-), [setDefault](../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-), [shouldOwn](../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-)
Identifiable
Methods inherited from interface org.apache.spark.ml.util.
[toString](../../../../../org/apache/spark/ml/util/Identifiable.html#toString--)
HasRawPredictionCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getRawPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasRawPredictionCol.html#getRawPredictionCol--), [rawPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasRawPredictionCol.html#rawPredictionCol--)
HasProbabilityCol
Methods inherited from interface org.apache.spark.ml.param.shared.
[getProbabilityCol](../../../../../org/apache/spark/ml/param/shared/HasProbabilityCol.html#getProbabilityCol--), [probabilityCol](../../../../../org/apache/spark/ml/param/shared/HasProbabilityCol.html#probabilityCol--)
HasThresholds
Methods inherited from interface org.apache.spark.ml.param.shared.
[getThresholds](../../../../../org/apache/spark/ml/param/shared/HasThresholds.html#getThresholds--), [thresholds](../../../../../org/apache/spark/ml/param/shared/HasThresholds.html#thresholds--)
HasVarianceImpurity
Methods inherited from interface org.apache.spark.ml.tree.
[getImpurity](../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html#getImpurity--), [getOldImpurity](../../../../../org/apache/spark/ml/tree/HasVarianceImpurity.html#getOldImpurity--)
DefaultParamsWritable
Methods inherited from interface org.apache.spark.ml.util.
[write](../../../../../org/apache/spark/ml/util/DefaultParamsWritable.html#write--)
MLWritable
Methods inherited from interface org.apache.spark.ml.util.
[save](../../../../../org/apache/spark/ml/util/MLWritable.html#save-java.lang.String-)
Methods inherited from interface org.apache.spark.internal.Logging
$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize