class Pipeline extends Estimator[PipelineModel] with MLWritable
A simple pipeline, which acts as an estimator. A Pipeline consists of a sequence of stages, each
of which is either an Estimator or a Transformer. When Pipeline.fit is called, the
stages are executed in order. If a stage is an Estimator, its Estimator.fit method will
be called on the input dataset to fit a model. Then the model, which is a transformer, will be
used to transform the dataset as the input to the next stage. If a stage is a Transformer,
its Transformer.transform method will be called to produce the dataset for the next stage.
The fitted model from a Pipeline is a PipelineModel, which consists of fitted models and
transformers, corresponding to the pipeline stages. If there are no stages, the pipeline acts as
an identity transformer.
- Annotations
- @Since("1.2.0")
- Source
- Pipeline.scala
- Grouped
- Alphabetic
- By Inheritance
- Pipeline
- MLWritable
- Estimator
- PipelineStage
- Logging
- Params
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Type Members
-   implicit  class LogStringContext extends AnyRef- Definition Classes
- Logging
 
Value Members
-   final  def !=(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def ##: Int- Definition Classes
- AnyRef → Any
 
-   final  def $[T](param: Param[T]): TAn alias for getOrDefault().An alias for getOrDefault().- Attributes
- protected
- Definition Classes
- Params
 
-   final  def ==(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def asInstanceOf[T0]: T0- Definition Classes
- Any
 
-   final  def clear(param: Param[_]): Pipeline.this.typeClears the user-supplied value for the input param. Clears the user-supplied value for the input param. - Definition Classes
- Params
 
-    def clone(): AnyRef- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
 
-    def copy(extra: ParamMap): PipelineCreates a copy of this instance with the same UID and some extra 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().- Definition Classes
- Pipeline → Estimator → PipelineStage → Params
- Annotations
- @Since("1.4.0")
 
-    def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): TCopies param values from this instance to another instance for params shared by them. Copies param values from this instance to another instance for params shared by them. This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and toparamMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.- to
- the target instance, which should work with the same set of default Params as this source instance 
- extra
- extra params to be copied to the target's - paramMap
- returns
- the target instance with param values copied 
 - Attributes
- protected
- Definition Classes
- Params
 
-   final  def defaultCopy[T <: Params](extra: ParamMap): TDefault implementation of copy with extra params. Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance. - Attributes
- protected
- Definition Classes
- Params
 
-   final  def eq(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-    def equals(arg0: AnyRef): Boolean- Definition Classes
- AnyRef → Any
 
-    def explainParam(param: Param[_]): StringExplains a param. Explains a param. - param
- input param, must belong to this instance. 
- returns
- a string that contains the input param name, doc, and optionally its default value and the user-supplied value 
 - Definition Classes
- Params
 
-    def explainParams(): StringExplains all params of this instance. Explains all params of this instance. See explainParam().- Definition Classes
- Params
 
-   final  def extractParamMap(): ParamMapextractParamMapwith no extra values.extractParamMapwith no extra values.- Definition Classes
- Params
 
-   final  def extractParamMap(extra: ParamMap): ParamMapExtracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra. Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra. - Definition Classes
- Params
 
-    def fit(dataset: Dataset[_]): PipelineModelFits the pipeline to the input dataset with additional parameters. Fits the pipeline to the input dataset with additional parameters. If a stage is an Estimator, its Estimator.fitmethod will be called on the input dataset to fit a model. Then the model, which is a transformer, will be used to transform the dataset as the input to the next stage. If a stage is a Transformer, itsTransformer.transformmethod will be called to produce the dataset for the next stage. The fitted model from a Pipeline is an PipelineModel, which consists of fitted models and transformers, corresponding to the pipeline stages. If there are no stages, the output model acts as an identity transformer.- dataset
- input dataset 
- returns
- fitted pipeline 
 
-    def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[PipelineModel]Fits multiple models to the input data with multiple sets of parameters. Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training. - dataset
- input dataset 
- paramMaps
- An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap. 
- returns
- fitted models, matching the input parameter maps 
 - Definition Classes
- Estimator
- Annotations
- @Since("2.0.0")
 
-    def fit(dataset: Dataset[_], paramMap: ParamMap): PipelineModelFits a single model to the input data with provided parameter map. Fits a single model to the input data with provided parameter map. - dataset
- input dataset 
- paramMap
- Parameter map. These values override any specified in this Estimator's embedded ParamMap. 
- returns
- fitted model 
 - Definition Classes
- Estimator
- Annotations
- @Since("2.0.0")
 
-    def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): PipelineModelFits a single model to the input data with optional parameters. Fits a single model to the input data with optional parameters. - dataset
- input dataset 
- firstParamPair
- the first param pair, overrides embedded params 
- otherParamPairs
- other param pairs. These values override any specified in this Estimator's embedded ParamMap. 
- returns
- fitted model 
 - Definition Classes
- Estimator
- Annotations
- @Since("2.0.0") @varargs()
 
-   final  def get[T](param: Param[T]): Option[T]Optionally returns the user-supplied value of a param. Optionally returns the user-supplied value of a param. - Definition Classes
- Params
 
-   final  def getClass(): Class[_ <: AnyRef]- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
 
-   final  def getDefault[T](param: Param[T]): Option[T]Gets the default value of a parameter. Gets the default value of a parameter. - Definition Classes
- Params
 
-   final  def getOrDefault[T](param: Param[T]): TGets the value of a param in the embedded param map or its default value. Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set. - Definition Classes
- Params
 
-    def getParam(paramName: String): Param[Any]Gets a param by its name. Gets a param by its name. - Definition Classes
- Params
 
-    def getStages: Array[PipelineStage]- Annotations
- @Since("1.2.0")
 
-   final  def hasDefault[T](param: Param[T]): BooleanTests whether the input param has a default value set. Tests whether the input param has a default value set. - Definition Classes
- Params
 
-    def hasParam(paramName: String): BooleanTests whether this instance contains a param with a given name. Tests whether this instance contains a param with a given name. - Definition Classes
- Params
 
-    def hashCode(): Int- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
 
-    def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean- Attributes
- protected
- Definition Classes
- Logging
 
-    def initializeLogIfNecessary(isInterpreter: Boolean): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-   final  def isDefined(param: Param[_]): BooleanChecks whether a param is explicitly set or has a default value. Checks whether a param is explicitly set or has a default value. - Definition Classes
- Params
 
-   final  def isInstanceOf[T0]: Boolean- Definition Classes
- Any
 
-   final  def isSet(param: Param[_]): BooleanChecks whether a param is explicitly set. Checks whether a param is explicitly set. - Definition Classes
- Params
 
-    def isTraceEnabled(): Boolean- Attributes
- protected
- Definition Classes
- Logging
 
-    def log: Logger- Attributes
- protected
- Definition Classes
- Logging
 
-    def logDebug(msg: => String, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logDebug(entry: LogEntry, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logDebug(entry: LogEntry): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logDebug(msg: => String): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logError(msg: => String, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logError(entry: LogEntry, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logError(entry: LogEntry): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logError(msg: => String): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logInfo(msg: => String, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logInfo(entry: LogEntry, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logInfo(entry: LogEntry): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logInfo(msg: => String): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logName: String- Attributes
- protected
- Definition Classes
- Logging
 
-    def logTrace(msg: => String, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logTrace(entry: LogEntry, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logTrace(entry: LogEntry): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logTrace(msg: => String): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logWarning(msg: => String, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logWarning(entry: LogEntry, throwable: Throwable): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logWarning(entry: LogEntry): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def logWarning(msg: => String): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-   final  def ne(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-   final  def notify(): Unit- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
 
-   final  def notifyAll(): Unit- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
 
-    lazy val params: Array[Param[_]]Returns all params sorted by their names. 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. - Definition Classes
- Params
- Note
- Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params. 
 
-    def save(path: String): UnitSaves this ML instance to the input path, a shortcut of write.save(path).Saves this ML instance to the input path, a shortcut of write.save(path).- Definition Classes
- MLWritable
- Annotations
- @Since("1.6.0") @throws("If the input path already exists but overwrite is not enabled.")
 
-   final  def set(paramPair: ParamPair[_]): Pipeline.this.typeSets a parameter in the embedded param map. Sets a parameter in the embedded param map. - Attributes
- protected
- Definition Classes
- Params
 
-   final  def set(param: String, value: Any): Pipeline.this.typeSets a parameter (by name) in the embedded param map. Sets a parameter (by name) in the embedded param map. - Attributes
- protected
- Definition Classes
- Params
 
-   final  def set[T](param: Param[T], value: T): Pipeline.this.typeSets a parameter in the embedded param map. Sets a parameter in the embedded param map. - Definition Classes
- Params
 
-   final  def setDefault(paramPairs: ParamPair[_]*): Pipeline.this.typeSets default values for a list of params. Sets default values for a list of params. Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.- paramPairs
- a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called. 
 - Attributes
- protected
- Definition Classes
- Params
 
-   final  def setDefault[T](param: Param[T], value: T): Pipeline.this.typeSets a default value for a param. 
-    def setStages(value: Array[_ <: PipelineStage]): Pipeline.this.type- Annotations
- @Since("1.2.0")
 
-    val stages: Param[Array[PipelineStage]]param for pipeline stages param for pipeline stages - Annotations
- @Since("1.2.0")
 
-   final  def synchronized[T0](arg0: => T0): T0- Definition Classes
- AnyRef
 
-    def toString(): String- Definition Classes
- Identifiable → AnyRef → Any
 
-    def transformSchema(schema: StructType): StructTypeCheck transform validity and derive the output schema from the input schema. Check transform validity and derive the output schema from the input schema. We check validity for interactions between parameters during transformSchemaand raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled byParam.validate().Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks. - Definition Classes
- Pipeline → PipelineStage
- Annotations
- @Since("1.2.0")
 
-    def transformSchema(schema: StructType, logging: Boolean): StructType:: DeveloperApi :: :: DeveloperApi :: Derives the output schema from the input schema and parameters, optionally with logging. This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise. - Attributes
- protected
- Definition Classes
- PipelineStage
- Annotations
- @DeveloperApi()
 
-    val uid: StringAn immutable unique ID for the object and its derivatives. An immutable unique ID for the object and its derivatives. - Definition Classes
- Pipeline → Identifiable
- Annotations
- @Since("1.4.0")
 
-   final  def wait(arg0: Long, arg1: Int): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
-   final  def wait(arg0: Long): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
 
-   final  def wait(): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
-    def withLogContext(context: Map[String, String])(body: => Unit): Unit- Attributes
- protected
- Definition Classes
- Logging
 
-    def write: MLWriterReturns an MLWriterinstance for this ML instance.Returns an MLWriterinstance for this ML instance.- Definition Classes
- Pipeline → MLWritable
- Annotations
- @Since("1.6.0")
 
Deprecated Value Members
-    def finalize(): Unit- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- (Since version 9) 
 
Inherited from MLWritable
Inherited from Estimator[PipelineModel]
Inherited from PipelineStage
Inherited from Logging
Inherited from Params
Inherited from Serializable
Inherited from Identifiable
Inherited from AnyRef
Inherited from Any
Parameters
A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.