org.apache.spark.ml.impl.estimator

Class PredictionModel<FeaturesType,M extends PredictionModel<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>

All Implemented Interfaces:

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

Direct Known Subclasses:

ClassificationModel, RegressionModel

public abstract class PredictionModel<FeaturesType,M extends PredictionModel<FeaturesType,M>>
extends Model<M>
implements PredictorParams

:: AlphaComponent ::

Abstraction for a model for prediction tasks (regression and classification).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PredictionModel()

Method Summary

Methods

Modifier and Type	Method and Description
M	setFeaturesCol(String value)
M	setPredictionCol(String value)
DataFrame	transform(DataFrame dataset, ParamMap paramMap) Transforms dataset by reading from featuresCol, calling predict(), and storing the predictions as a new column predictionCol.
StructType	transformSchema(StructType schema, ParamMap paramMap) :: DeveloperApi ::

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.impl.estimator.PredictorParams

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.Logging

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

Constructor Detail

PredictionModel

public PredictionModel()

Method Detail

setFeaturesCol

public M setFeaturesCol(String value)

setPredictionCol

public M setPredictionCol(String value)

transformSchema

public StructType transformSchema(StructType schema,
                         ParamMap paramMap)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema and parameters. The schema describes the columns and types of the data.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - Input schema to this stage

paramMap - Parameters passed to this stage

Returns:

Output schema from this stage

transform

public DataFrame transform(DataFrame dataset,
                  ParamMap paramMap)

Transforms dataset by reading from featuresCol, calling predict(), and storing the predictions as a new column predictionCol.

Specified by:

transform in class Transformer

Parameters:

dataset - input dataset

paramMap - additional parameters, overwrite embedded params

Returns:

transformed dataset with predictionCol of type Double