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>

Type Parameters:

FeaturesType - Type of input features. E.g., Vector

E - Concrete Estimator type

M - Concrete Model type

All Implemented Interfaces:

java.io.Serializable, org.apache.spark.internal.Logging, ClassifierParams, ProbabilisticClassifierParams, Params, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasProbabilityCol, HasRawPredictionCol, HasThresholds, PredictorParams, Identifiable

Direct Known Subclasses:

DecisionTreeClassifier, FMClassifier, GBTClassifier, LogisticRegression, MultilayerPerceptronClassifier, NaiveBayes, RandomForestClassifier

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

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.spark.internal.Logging

org.apache.spark.internal.Logging.SparkShellLoggingFilter

Constructor Summary

Constructors

Constructor and Description
ProbabilisticClassifier()

Method Summary

Modifier and Type	Method and Description
Param<String>	probabilityCol() Param for Column name for predicted class conditional probabilities.
E	setProbabilityCol(String value)
E	setThresholds(double[] value)
DoubleArrayParam	thresholds() Param for Thresholds in multi-class classification to adjust the probability of predicting each class.

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

rawPredictionCol, setRawPredictionCol

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

copy, featuresCol, fit, labelCol, predictionCol, setFeaturesCol, setLabelCol, setPredictionCol, transformSchema

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

fit, fit, fit, fit

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

params

Methods inherited from class Object

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

Methods inherited from interface org.apache.spark.ml.classification.ProbabilisticClassifierParams

validateAndTransformSchema

Methods inherited from interface org.apache.spark.ml.classification.ClassifierParams

extractInstances

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

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

getProbabilityCol

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

getThresholds

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

Constructor Detail

ProbabilisticClassifier

public ProbabilisticClassifier()

Method Detail

probabilityCol

public final Param<String> probabilityCol()

Description copied from interface: HasProbabilityCol

Param for Column name for predicted class conditional probabilities. Note: Not all models output well-calibrated probability estimates! These probabilities should be treated as confidences, not precise probabilities.

Specified by:

probabilityCol in interface HasProbabilityCol

Returns:

(undocumented)

setProbabilityCol

public E setProbabilityCol(String value)

setThresholds

public E setThresholds(double[] value)

thresholds

public DoubleArrayParam thresholds()

Description copied from interface: HasThresholds

Param for Thresholds in multi-class classification to adjust the probability of predicting each class. Array must have length equal to the number of classes, with values &gt; 0 excepting that at most one value may be 0. The class with largest value p/t is predicted, where p is the original probability of that class and t is the class's threshold.

Specified by:

thresholds in interface HasThresholds

Returns:

(undocumented)