org.apache.spark.ml

Class PipelineStage

Object

org.apache.spark.ml.PipelineStage

All Implemented Interfaces:

java.io.Serializable, org.apache.spark.internal.Logging, Params, Identifiable

Direct Known Subclasses:

Estimator, Transformer

public abstract class PipelineStage
extends Object
implements Params, org.apache.spark.internal.Logging

A stage in a pipeline, either an Estimator or a Transformer.

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
PipelineStage()

Method Summary

Modifier and Type	Method and Description
abstract PipelineStage	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
Param<?>[]	params() Returns all params sorted by their names.
abstract StructType	transformSchema(StructType schema) Check transform validity and derive the output schema from the input schema.

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, copyValues, defaultCopy, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, onParamChange, 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.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

PipelineStage

public PipelineStage()

Method Detail

copy

public abstract PipelineStage copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

Specified by:

copy in interface Params

Parameters:

extra - (undocumented)

Returns:

(undocumented)

params

public Param<?>[] params()

Description copied from interface: Params

Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

Specified by:

params in interface Params

Returns:

(undocumented)

transformSchema

public abstract StructType transformSchema(StructType schema)

Check transform validity and derive the output schema from the input schema.

We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

Parameters:

schema - (undocumented)

Returns:

(undocumented)