TreeEnsembleClassifierParams (Spark 3.5.5 JavaDoc) (original) (raw)

All Superinterfaces:
ClassifierParams, DecisionTreeParams, HasCheckpointInterval, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasProbabilityCol, HasRawPredictionCol, HasSeed, HasThresholds, HasWeightCol, Identifiable, Params, PredictorParams, ProbabilisticClassifierParams, java.io.Serializable, TreeEnsembleParams
All Known Subinterfaces:
GBTClassifierParams, RandomForestClassifierParams
All Known Implementing Classes:
GBTClassificationModel, GBTClassifier, RandomForestClassificationModel, RandomForestClassifier

public interface TreeEnsembleClassifierParams
extends TreeEnsembleParams, ProbabilisticClassifierParams
Parameters for Decision Tree-based ensemble classification algorithms.

Method Summary

All Methods Instance Methods Abstract Methods

Modifier and Type	Method and Description
StructType	validateAndTransformSchema(StructType schema, boolean fitting,DataType featuresDataType) Validates and transforms the input schema with the provided param map.

   * ### Methods inherited from interface org.apache.spark.ml.tree.[TreeEnsembleParams](../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html "interface in org.apache.spark.ml.tree")  
   `[featureSubsetStrategy](../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#featureSubsetStrategy--), [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--), [subsamplingRate](../../../../../org/apache/spark/ml/tree/TreeEnsembleParams.html#subsamplingRate--)`  
   * ### Methods inherited from interface org.apache.spark.ml.tree.[DecisionTreeParams](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html "interface in org.apache.spark.ml.tree")  
   `[cacheNodeIds](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#cacheNodeIds--), [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-), [leafCol](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#leafCol--), [maxBins](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxBins--), [maxDepth](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxDepth--), [maxMemoryInMB](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#maxMemoryInMB--), [minInfoGain](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minInfoGain--), [minInstancesPerNode](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minInstancesPerNode--), [minWeightFractionPerNode](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#minWeightFractionPerNode--), [setLeafCol](../../../../../org/apache/spark/ml/tree/DecisionTreeParams.html#setLeafCol-java.lang.String-)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasCheckpointInterval](../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html "interface in org.apache.spark.ml.param.shared")  
   `[checkpointInterval](../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html#checkpointInterval--), [getCheckpointInterval](../../../../../org/apache/spark/ml/param/shared/HasCheckpointInterval.html#getCheckpointInterval--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html "interface in org.apache.spark.ml.param.shared")  
   `[getSeed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#getSeed--), [seed](../../../../../org/apache/spark/ml/param/shared/HasSeed.html#seed--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html "interface in org.apache.spark.ml.param.shared")  
   `[getWeightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#getWeightCol--), [weightCol](../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#weightCol--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasLabelCol](../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasFeaturesCol](../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.[Params](../../../../../org/apache/spark/ml/param/Params.html "interface in org.apache.spark.ml.param")  
   `[clear](../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-), [copy](../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-), [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-)`  
   * ### Methods inherited from interface org.apache.spark.ml.util.[Identifiable](../../../../../org/apache/spark/ml/util/Identifiable.html "interface in org.apache.spark.ml.util")  
   `[toString](../../../../../org/apache/spark/ml/util/Identifiable.html#toString--), [uid](../../../../../org/apache/spark/ml/util/Identifiable.html#uid--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasRawPredictionCol](../../../../../org/apache/spark/ml/param/shared/HasRawPredictionCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasProbabilityCol](../../../../../org/apache/spark/ml/param/shared/HasProbabilityCol.html "interface in 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--)`  
   * ### Methods inherited from interface org.apache.spark.ml.param.shared.[HasThresholds](../../../../../org/apache/spark/ml/param/shared/HasThresholds.html "interface in 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--)`

Method Detail

 * #### validateAndTransformSchema  
 [StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") validateAndTransformSchema([StructType](../../../../../org/apache/spark/sql/types/StructType.html "class in org.apache.spark.sql.types") schema,  
                                       boolean fitting,  
                                       [DataType](../../../../../org/apache/spark/sql/types/DataType.html "class in org.apache.spark.sql.types") featuresDataType)  
 Validates and transforms the input schema with the provided param map.  
 Specified by:  
 `[validateAndTransformSchema](../../../../../org/apache/spark/ml/classification/ClassifierParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-)` in interface `[ClassifierParams](../../../../../org/apache/spark/ml/classification/ClassifierParams.html "interface in org.apache.spark.ml.classification")`  
 Specified by:  
 `[validateAndTransformSchema](../../../../../org/apache/spark/ml/PredictorParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-)` in interface `[PredictorParams](../../../../../org/apache/spark/ml/PredictorParams.html "interface in org.apache.spark.ml")`  
 Specified by:  
 `[validateAndTransformSchema](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifierParams.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-)` in interface `[ProbabilisticClassifierParams](../../../../../org/apache/spark/ml/classification/ProbabilisticClassifierParams.html "interface in org.apache.spark.ml.classification")`  
 Parameters:  
 `schema` \- input schema  
 `fitting` \- whether this is in fitting  
 `featuresDataType` \- SQL DataType for FeaturesType. E.g., `VectorUDT` for vector features.  
 Returns:  
 output schema

TreeEnsembleClassifierParams (Spark 3.5.5 JavaDoc) (original) (raw)

Method Summary

Method Detail