org.apache.spark.ml.classification

Class ProbabilisticClassifier<FeaturesType,E extends ProbabilisticClassifier<FeaturesType,E,M>,M extends ProbabilisticClassificationModel<FeaturesType,M>>

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<M>

org.apache.spark.ml.Predictor<FeaturesType,E,M>

org.apache.spark.ml.classification.Classifier<FeaturesType,E,M>

org.apache.spark.ml.classification.ProbabilisticClassifier<FeaturesType,E,M>

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

Direct Known Subclasses:

DecisionTreeClassifier, LogisticRegression, NaiveBayes, RandomForestClassifier

public abstract class ProbabilisticClassifier<FeaturesType,E extends ProbabilisticClassifier<FeaturesType,E,M>,M extends ProbabilisticClassificationModel<FeaturesType,M>>
extends Classifier<FeaturesType,E,M>

:: DeveloperApi ::

Single-label binary or multiclass classifier which can output class conditional probabilities.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProbabilisticClassifier()

Method Summary

Methods

Modifier and Type	Method and Description
Param<String>	featuresCol() Param for features column name.
String	getFeaturesCol()
String	getLabelCol()
String	getPredictionCol()
String	getRawPredictionCol()
Param<String>	labelCol() Param for label column name.
Param<String>	predictionCol() Param for prediction column name.
Param<String>	rawPredictionCol() Param for raw prediction (a.k.a.
E	setProbabilityCol(String value)
E	setThresholds(double[] value)
StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType)
StructType	validateAndTransformSchema(StructType schema, boolean fitting, DataType featuresDataType) Validates and transforms the input schema with the provided param map.

Methods inherited from class org.apache.spark.ml.classification.Classifier

setRawPredictionCol

Methods inherited from class org.apache.spark.ml.Predictor

copy, fit, setFeaturesCol, setLabelCol, setPredictionCol, transformSchema

Methods inherited from class org.apache.spark.ml.Estimator

fit, fit, fit, fit

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, validateParams

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

toString, uid

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

ProbabilisticClassifier

public ProbabilisticClassifier()

Method Detail

setProbabilityCol

public E setProbabilityCol(String value)

setThresholds

public E setThresholds(double[] value)

validateAndTransformSchema

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

rawPredictionCol

public Param<String> rawPredictionCol()

Param for raw prediction (a.k.a. confidence) column name.

Returns:

(undocumented)

getRawPredictionCol

public String getRawPredictionCol()

validateAndTransformSchema

public 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

labelCol

public Param<String> labelCol()

Param for label column name.

Returns:

(undocumented)

getLabelCol

public String getLabelCol()

featuresCol

public Param<String> featuresCol()

Param for features column name.

Returns:

(undocumented)

getFeaturesCol

public String getFeaturesCol()

predictionCol

public Param<String> predictionCol()

Param for prediction column name.

Returns:

(undocumented)

getPredictionCol

public String getPredictionCol()