Trait/Object

org.apache.flink.ml.pipeline

Transformer

Related Docs: object Transformer | package pipeline

Permalink

trait Transformer[Self <: Transformer[Self]] extends Estimator[Self] with WithParameters with Serializable

Transformer trait for Flink's pipeline operators.

A Transformer transforms a DataSet of an input type into a DataSet of an output type. Furthermore, a Transformer is also an Estimator, because some transformations depend on the training data. In order to do that the implementing class has to provide a TransformDataSetOperation and FitOperation implementation. The Scala compiler finds these implicit values if it is put in the scope of the companion object of the implementing class.

Transformer can be chained with other Transformer and Predictor to create pipelines. These pipelines can consist of an arbitrary number of Transformer and at most one trailing Predictor.

The pipeline mechanism has been inspired by scikit-learn

Self Type
Self
Linear Supertypes
Serializable, Serializable, Estimator[Self], WithParameters, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Transformer
  2. Serializable
  3. Serializable
  4. Estimator
  5. WithParameters
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def chainPredictor[P <: Predictor[P]](predictor: P): ChainedPredictor[Self, P]

    Permalink

    Chains a Transformer with a Predictor to form a ChainedPredictor.

    Chains a Transformer with a Predictor to form a ChainedPredictor.

    P

    Type of the Predictor

    predictor

    Trailing Predictor of the resulting pipeline

  6. def chainTransformer[T <: Transformer[T]](transformer: T): ChainedTransformer[Self, T]

    Permalink

    Chains two Transformer to form a ChainedTransformer.

    Chains two Transformer to form a ChainedTransformer.

    T

    Type of the Transformer

    transformer

    Right side transformer of the resulting pipeline

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fit[Training](training: DataSet[Training], fitParameters: ParameterMap = ParameterMap.Empty)(implicit fitOperation: FitOperation[Self, Training]): Unit

    Permalink

    Fits the estimator to the given input data.

    Fits the estimator to the given input data. The fitting logic is contained in the FitOperation. The computed state will be stored in the implementing class.

    Training

    Type of the training data

    training

    Training data

    fitParameters

    Additional parameters for the FitOperation

    fitOperation

    FitOperation which encapsulates the algorithm logic

    Definition Classes
    Estimator
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. val parameters: ParameterMap

    Permalink
    Definition Classes
    WithParameters
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. def transform[Input, Output](input: DataSet[Input], transformParameters: ParameterMap = ParameterMap.Empty)(implicit transformOperation: TransformDataSetOperation[Self, Input, Output]): DataSet[Output]

    Permalink

    Transform operation which transforms an input DataSet of type I into an output DataSet of type O.

    Transform operation which transforms an input DataSet of type I into an output DataSet of type O. The actual transform operation is implemented within the TransformDataSetOperation.

    Input

    Input data type

    Output

    Output data type

    input

    Input DataSet of type I

    transformParameters

    Additional parameters for the TransformDataSetOperation

    transformOperation

    TransformDataSetOperation which encapsulates the algorithm's logic

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Estimator[Self]

Inherited from WithParameters

Inherited from AnyRef

Inherited from Any

Ungrouped