org.apache.spark.ml.classification

Interface ClassifierParams

All Superinterfaces:

HasFeaturesCol, HasLabelCol, HasPredictionCol, HasRawPredictionCol, Identifiable, Params, PredictorParams, java.io.Serializable

All Known Subinterfaces:

DecisionTreeClassifierParams, FMClassifierParams, GBTClassifierParams, LinearSVCParams, LogisticRegressionParams, MultilayerPerceptronParams, OneVsRestParams, ProbabilisticClassifierParams, RandomForestClassifierParams, TreeEnsembleClassifierParams

All Known Implementing Classes:

ClassificationModel, Classifier, DecisionTreeClassificationModel, DecisionTreeClassifier, FMClassificationModel, FMClassifier, GBTClassificationModel, GBTClassifier, LinearSVC, LinearSVCModel, LogisticRegression, LogisticRegressionModel, MultilayerPerceptronClassificationModel, MultilayerPerceptronClassifier, NaiveBayes, NaiveBayesModel, OneVsRest, OneVsRestModel, ProbabilisticClassificationModel, ProbabilisticClassifier, RandomForestClassificationModel, RandomForestClassifier

public interface ClassifierParams
extends PredictorParams, HasRawPredictionCol

(private[spark]) Params for classification.

Method Summary

Modifier and Type	Method and Description
RDD<org.apache.spark.ml.feature.Instance>	extractInstances(Dataset<?> dataset, int numClasses) Extract labelCol, weightCol(if any) and featuresCol from the given dataset, and put it in an RDD with strong types.
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.PredictorParams

extractInstances, extractInstances

Methods inherited from interface org.apache.spark.ml.param.shared.HasLabelCol

getLabelCol, labelCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasFeaturesCol

featuresCol, getFeaturesCol

Methods inherited from interface org.apache.spark.ml.param.shared.HasPredictionCol

getPredictionCol, predictionCol

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copy, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn

Methods inherited from interface org.apache.spark.ml.util.Identifiable

toString, uid

Methods inherited from interface org.apache.spark.ml.param.shared.HasRawPredictionCol

getRawPredictionCol, rawPredictionCol

Method Detail

extractInstances

RDD<org.apache.spark.ml.feature.Instance> extractInstances(Dataset<?> dataset,
                                                           int numClasses)

Extract labelCol, weightCol(if any) and featuresCol from the given dataset, and put it in an RDD with strong types. Validates the label on the classifier is a valid integer in the range [0, numClasses).

Parameters:

dataset - (undocumented)

numClasses - (undocumented)

Returns:

(undocumented)

validateAndTransformSchema

StructType validateAndTransformSchema(StructType schema,
                                      boolean fitting,
                                      DataType featuresDataType)

Description copied from interface: PredictorParams

Validates and transforms the input schema with the provided param map.

Specified by:

validateAndTransformSchema in interface PredictorParams

Parameters:

schema - input schema

fitting - whether this is in fitting

featuresDataType - SQL DataType for FeaturesType. E.g., VectorUDT for vector features.

Returns:

output schema