org.apache.spark.ml

Class PipelineModel

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Transformer

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

org.apache.spark.ml.PipelineModel

All Implemented Interfaces:

java.io.Serializable, Logging, Identifiable, Params

public class PipelineModel
extends Model<PipelineModel>
implements Logging

:: AlphaComponent :: Represents a compiled pipeline.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PipelineModel(Pipeline parent, ParamMap fittingParamMap, Transformer[] stages)

Method Summary

Methods

Modifier and Type	Method and Description
ParamMap	fittingParamMap() Fitting parameters, such that parent.fit(..., fittingParamMap) could reproduce the model.
<M extends Model<M>> M	getModel(Estimator<M> stage) Gets the model produced by the input estimator.
Pipeline	parent() The parent estimator that produced this model.
Transformer[]	stages()
DataFrame	transform(DataFrame dataset, ParamMap paramMap) Transforms the dataset with provided parameter map as additional parameters.
StructType	transformSchema(StructType schema, ParamMap paramMap) :: DeveloperApi ::

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

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

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

Constructor Detail

PipelineModel

public PipelineModel(Pipeline parent,
             ParamMap fittingParamMap,
             Transformer[] stages)

Method Detail

parent

public Pipeline parent()

Description copied from class: Model

The parent estimator that produced this model.

Specified by:

parent in class Model<PipelineModel>

fittingParamMap

public ParamMap fittingParamMap()

Description copied from class: Model

Fitting parameters, such that parent.fit(..., fittingParamMap) could reproduce the model.

Specified by:

fittingParamMap in class Model<PipelineModel>

stages

public Transformer[] stages()

getModel

public <M extends Model<M>> M getModel(Estimator<M> stage)

Gets the model produced by the input estimator. Throws an NoSuchElementException is the input estimator does not exist in the pipeline.

transform

public DataFrame transform(DataFrame dataset,
                  ParamMap paramMap)

Description copied from class: Transformer

Transforms the dataset with provided parameter map as additional parameters.

Specified by:

transform in class Transformer

Parameters:

dataset - input dataset

paramMap - additional parameters, overwrite embedded params

Returns:

transformed dataset

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