Implementations must adhere to the following contracts
General
Regardless of input ports/output port types, all implementations
must do the following:
- Validation. Validation of configuration should always be performed first.
- Declare parallelizability.. Implementations must declare parallelizability by calling
StreamingMetadataContext.parallelize(ParallelismStrategy)
.
Input record ports
Implementations with input record ports
must declare the following:
- Required data ordering:
Implementations that have data ordering requirements must declare them by calling
RecordPort#setRequiredDataOrdering
, otherwise data may arrive in any order.
- Required data distribution (only applies to parallelizable operators):
Implementations that have data distribution requirements must declare them by calling
RecordPort#setRequiredDataDistribution
, otherwise data will arrive in an unspecified partial distribution
.
Note that if the upstream operator's output distribution/ordering is compatible with those required,
we avoid a re-sort/re-distribution which is generally a very large savings from
a performance standpoint. In addition, some operators may chose to query the upstream output distribution/ordering
by calling
RecordPort#getSourceDataDistribution
and
RecordPort#getSourceDataOrdering
. These should be
viewed as a hints to help chose a more efficient algorithm. In such cases, though, operators must
still declare data ordering and data distribution requirements; otherwise there is no guarantee that
data will arrive sorted/distributed as required.
Output record ports
Implementations with output record ports
must declare the following:
- Type: Implementations must declare their output type by calling
RecordPort#setType
.
Implementations with output record ports
may declare the following:
- Output data ordering: Implementations that can make guarantees as to their output
ordering may do so by calling
RecordPort#setOutputDataOrdering
- Output data distribution (only applies to parallelizable operators): Implementations that can make guarantees as to their output
distribution may do so by calling
RecordPort#setOutputDataDistribution
Note that both of these properties are optional; if unspecified, performance may suffer since
the framework may unnecessarily re-sort/re-distributed the data.
Input model ports
In general, there is nothing special to declare for input model ports. Models
are implicitly duplicated to all partitions when going from non-parallel to
parallel operators. The case of a model going from a parallel to a non-parallel
node is a special case of a "model reducer" operator.
In the case of a model reducer, the downstream operator,
must declare
the following:
- Merge handler: Model reducers must declare a merge handler by
calling
AbstractModelPort#setMergeHandler
.
Note that
MergeModel
is a convenient, re-usable model reducer, parameterized with
a merge-handler.
Output model ports
SimpleModelPort
's have no associated metadata and therefore there is
never any output metadata to declare.
PMMLPort
's, on the other hand,
do have associated metadata. For all PMMLPorts, implementations must declare
the following:
- pmmlModelSpec: Implementations must declare the PMML model spec
by calling
PMMLPort.setPMMLModelSpec
.