org.apache.spark.ml

Interface PredictorParams

All Superinterfaces:

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

All Known Subinterfaces:

AFTSurvivalRegressionParams, ClassifierParams, DecisionTreeClassifierParams, DecisionTreeParams, DecisionTreeRegressorParams, FactorizationMachines, FactorizationMachinesParams, FMClassifierParams, FMRegressorParams, GBTClassifierParams, GBTParams, GBTRegressorParams, GeneralizedLinearRegressionBase, LinearRegressionParams, LinearSVCParams, LogisticRegressionParams, MultilayerPerceptronParams, NaiveBayesParams, OneVsRestParams, ProbabilisticClassifierParams, RandomForestClassifierParams, RandomForestParams, RandomForestRegressorParams, TreeEnsembleClassifierParams, TreeEnsembleParams, TreeEnsembleRegressorParams

All Known Implementing Classes:

AFTSurvivalRegression, AFTSurvivalRegressionModel, ClassificationModel, Classifier, DecisionTreeClassificationModel, DecisionTreeClassifier, DecisionTreeRegressionModel, DecisionTreeRegressor, FMClassificationModel, FMClassifier, FMRegressionModel, FMRegressor, GBTClassificationModel, GBTClassifier, GBTRegressionModel, GBTRegressor, GeneralizedLinearRegression, GeneralizedLinearRegressionModel, LinearRegression, LinearRegressionModel, LinearSVC, LinearSVCModel, LogisticRegression, LogisticRegressionModel, MultilayerPerceptronClassificationModel, MultilayerPerceptronClassifier, NaiveBayes, NaiveBayesModel, OneVsRest, OneVsRestModel, PredictionModel, Predictor, ProbabilisticClassificationModel, ProbabilisticClassifier, RandomForestClassificationModel, RandomForestClassifier, RandomForestRegressionModel, RandomForestRegressor, RegressionModel, Regressor

public interface PredictorParams
extends Params, HasLabelCol, HasFeaturesCol, HasPredictionCol

(private[ml]) Trait for parameters for prediction (regression and classification).

Method Summary

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

Method Detail

extractInstances

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

Extract labelCol, weightCol(if any) and featuresCol from the given dataset, and put it in an RDD with strong types.

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

extractInstances

RDD<org.apache.spark.ml.feature.Instance> extractInstances(Dataset<?> dataset,
                                                           scala.Function1<org.apache.spark.ml.feature.Instance,scala.runtime.BoxedUnit> validateInstance)

Extract labelCol, weightCol(if any) and featuresCol from the given dataset, and put it in an RDD with strong types. Validate the output instances with the given function.

Parameters:

dataset - (undocumented)

validateInstance - (undocumented)

Returns:

(undocumented)

validateAndTransformSchema

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

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

Parameters:

schema - input schema

fitting - whether this is in fitting

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

Returns:

output schema