org.apache.flink.ml.operator

Class AlgoOperator<T extends AlgoOperator<T>>

java.lang.Object

org.apache.flink.ml.operator.AlgoOperator<T>

Type Parameters:

T - The class type of the AlgoOperator implementation itself

All Implemented Interfaces:

Serializable, WithParams<T>, HasMLEnvironmentId<T>

Direct Known Subclasses:

BatchOperator, StreamOperator

public abstract class AlgoOperator<T extends AlgoOperator<T>>
extends Object
implements WithParams<T>, HasMLEnvironmentId<T>, Serializable

Base class for algorithm operators.

Base class for the algorithm operators. It hosts the parameters and output tables of an algorithm operator. Each AlgoOperator may have one or more output tables. One of the output table is the primary output table which can be obtained by calling getOutput(). The other output tables are side output tables that can be obtained by calling getSideOutputs().

The input of an AlgoOperator is defined in the subclasses of the AlgoOperator.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.flink.ml.params.shared.HasMLEnvironmentId

ML_ENVIRONMENT_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlgoOperator() Construct the operator with empty Params.
protected	AlgoOperator(Params params) Construct the operator with the initial Params.

Method Summary

Modifier and Type	Method and Description
protected static void	checkMinOpSize(int size, AlgoOperator<?>... inputs)
protected static void	checkOpSize(int size, AlgoOperator<?>... inputs)
String[]	getColNames() Returns the column names of the output table.
TypeInformation<?>[]	getColTypes() Returns the column types of the output table.
Table	getOutput() Returns the table held by operator.
Params	getParams() Returns the all the parameters.
TableSchema	getSchema() Returns the schema of the output table.
String[]	getSideOutputColNames(int index) Get the column names of the specified side-output table.
TypeInformation<?>[]	getSideOutputColTypes(int index) Get the column types of the specified side-output table.
Table[]	getSideOutputs() Returns the side outputs.
protected void	setOutput(Table output) Set the table held by operator.
protected void	setSideOutputs(Table[] sideOutputs) Set the side outputs.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.ml.params.shared.HasMLEnvironmentId

getMLEnvironmentId, setMLEnvironmentId

Methods inherited from interface org.apache.flink.ml.api.misc.param.WithParams

get, set

Constructor Detail

AlgoOperator

protected AlgoOperator()

Construct the operator with empty Params.

This constructor is especially useful when users want to set parameters for the algorithm operators. For example: SplitBatchOp is widely used in ML data pre-processing, which splits one dataset into two dataset: training set and validation set. It is very convenient for us to write code like this:

 
 new SplitBatchOp().setSplitRatio(0.9)
 
 

AlgoOperator

protected AlgoOperator(Params params)

Construct the operator with the initial Params.

Method Detail

getParams

public Params getParams()

Description copied from interface: WithParams

Returns the all the parameters.

Specified by:

getParams in interface WithParams<T extends AlgoOperator<T>>

Returns:

all the parameters.

getOutput

public Table getOutput()

Returns the table held by operator.

getSideOutputs

public Table[] getSideOutputs()

Returns the side outputs.

setSideOutputs

protected void setSideOutputs(Table[] sideOutputs)

Set the side outputs.

Parameters:

sideOutputs - the side outputs set the operator.

setOutput

protected void setOutput(Table output)

Set the table held by operator.

Parameters:

output - the output table.

getColNames

public String[] getColNames()

Returns the column names of the output table.

getColTypes

public TypeInformation<?>[] getColTypes()

Returns the column types of the output table.

getSideOutputColNames

public String[] getSideOutputColNames(int index)

Get the column names of the specified side-output table.

Parameters:

index - the index of the table.

Returns:

the column types of the table.

getSideOutputColTypes

public TypeInformation<?>[] getSideOutputColTypes(int index)

Get the column types of the specified side-output table.

Parameters:

index - the index of the table.

Returns:

the column types of the table.

getSchema

public TableSchema getSchema()

Returns the schema of the output table.

toString

public String toString()

Overrides:

toString in class Object

checkOpSize

protected static void checkOpSize(int size,
                                  AlgoOperator<?>... inputs)

checkMinOpSize

protected static void checkMinOpSize(int size,
                                     AlgoOperator<?>... inputs)