org.apache.spark.ml.classification

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

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

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

org.apache.spark.ml.impl.estimator.PredictionModel<FeaturesType,M>

org.apache.spark.ml.classification.ClassificationModel<FeaturesType,M>

org.apache.spark.ml.classification.ProbabilisticClassificationModel<FeaturesType,M>

All Implemented Interfaces:

java.io.Serializable, Logging, ClassifierParams, ProbabilisticClassifierParams, Identifiable, PredictorParams, HasFeaturesCol, HasLabelCol, HasPredictionCol, HasProbabilityCol, HasRawPredictionCol, Params

Direct Known Subclasses:

LogisticRegressionModel

public abstract class ProbabilisticClassificationModel<FeaturesType,M extends ProbabilisticClassificationModel<FeaturesType,M>>
extends ClassificationModel<FeaturesType,M>
implements ProbabilisticClassifierParams

:: AlphaComponent ::

Model produced by a ProbabilisticClassifier. Classes are indexed {0, 1, ..., numClasses - 1}.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProbabilisticClassificationModel()

Method Summary

Methods

Modifier and Type	Method and Description
M	setProbabilityCol(String value)
DataFrame	transform(DataFrame dataset, ParamMap paramMap) Transforms dataset by reading from featuresCol, and appending new columns as specified by parameters: - predicted labels as predictionCol of type Double - raw predictions (confidences) as rawPredictionCol of type Vector - probability of each class as probabilityCol of type Vector.

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

numClasses, setRawPredictionCol, transformColumnsImpl

Methods inherited from class org.apache.spark.ml.impl.estimator.PredictionModel

setFeaturesCol, setPredictionCol, transformSchema

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

fittingParamMap, parent

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

transform, transform

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.param.HasLabelCol

getLabelCol, labelCol

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

featuresCol, getFeaturesCol

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

getPredictionCol, predictionCol

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

addOutputColumn, checkInputColumn, explainParams, get, getParam, isSet, paramMap, params, set, set, validate, validate

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

uid

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

getRawPredictionCol, rawPredictionCol

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

getProbabilityCol, probabilityCol

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

ProbabilisticClassificationModel

public ProbabilisticClassificationModel()

Method Detail

setProbabilityCol

public M setProbabilityCol(String value)

transform

public DataFrame transform(DataFrame dataset,
                  ParamMap paramMap)

Transforms dataset by reading from featuresCol, and appending new columns as specified by parameters: - predicted labels as predictionCol of type Double - raw predictions (confidences) as rawPredictionCol of type Vector - probability of each class as probabilityCol of type Vector.

Overrides:

transform in class ClassificationModel<FeaturesType,M extends ProbabilisticClassificationModel<FeaturesType,M>>

Parameters:

dataset - input dataset

paramMap - additional parameters, overwrite embedded params

Returns:

transformed dataset