IBM InfoSphere Streams Version 4.1.1

Migrating streams processing applications that use the InfoSphere® Streams TimeSeries Toolkit

The TimeSeries Toolkit ARIMA and HoltWinters operators are changed. Use these guidelines to migrate Version 4.0, or later applications that use these operators to Version 4.1.1.

Procedure

Update applications that use the ARIMA and HoltWinters operators by using the information in Table 1.
Table 1. Changes to the TimeSeries Toolkit ARIMA and HoltWinters operators
Operator Replacement Additional information
ARIMA ARIMA2
  • The coefficients() output function has been replaced with the getCoefficients() output function. Modify your applications, as needed. For example:
    • In previous releases, the coefficients() output function return type was map<rstring,map<uint32,map<uint32,float64>>>. The getCoefficients() output function return type is map<rstring,list<list<float64>>>.
  • The forecastedTimeSeriesStep() output function return type can be either float64 or list<float64>, depending on the attribute type that is specified by the inputTimeSeries parameter. For example:
    • If the inputTimeSeries parameter specifies an attribute type of float64, the return type is float64.
    • If the inputTimeSeries parameter specifies an attribute type of list<float64>, the return type is list<float64>.
  • The forecastedAllTimeSeriesSteps() output function return type can be either list<float64> or list<list<float64>>, depending on the attribute type that is specified by the inputTimeSeries parameter. For example:
    • If the inputTimeSeries parameter specifies an attribute type of float64, the return type is list<float64>.
    • If the inputTimeSeries parameter specifies an attribute type of list<float64>, the return type is list<list<float64>>.
  • The forecastedTimestamp() output function return type can either be timestamp or uint64, depending on the attribute type that is specified by the inputTimestamp parameter. For example, if the inputTimestamp parameter specifies an attribute type of timestamp, the return type is timestamp.
  • The forecastedAllTimestamps() output function return type can be either list<timestamp> or list<uint64>, depending on the attribute type that is specified by the inputTimestamp parameter. For example, if the inputTimestamp parameter specifies an attribute type of uint64, the return type is list<uint64>.
  • The partitionBy parameter now only specifies the expression for the key values from input port 0. To specify an expression for the key values from the control port (input port 1), use the controlPortPartitionBy parameter.
  • The controlPortPartitionBy parameter allows you to specify the expression for the key values from input port 1.
  • The retrainingConfig parameter is renamed to updateParams.
  • The controlSignal parameter no longer supports the TSSignal.Suspend, TSSignal.Resume, and TSSignal.Load control signals.
  • Using the TSSignal.Retrain signal with the ARIMA2 operator only retrains the ARIMA model. This signal no longer updates the model parameters. In order to update model parameters, use the TSSignal.UpdateParamsAll control signal. If you are using partitioning, the TSSignal.Retrain signal uses the expression specified by the controlPortPartitionBy parameter.
  • The TSSignal.UpdateParamsAll signal updates the ARIMA2 operator parameter values based on the attribute specified by the updateParams parameter, which was previously called retrainingConfig. If you are using partitioning, this signal updates the parameter values for all of the models, regardless of the key provided by the controlPortPartitionBy parameter. You cannot currently update the parameters for an individual model.
HoltWinters HoltWinters2
  • The forecastedTimeSeriesStep() output function return type can be either float64 or list<float64>, depending on the attribute type that is specified by the inputTimeSeries parameter. For example:
    • If the inputTimeSeries parameter specifies an attribute type of float64, the return type is float64.
    • If the inputTimeSeries parameter specifies an attribute type of list<float64>, the return type is list<float64>.
  • The forecastedAllTimeSeriesSteps() output function return type can be either list<float64> or list<list<float64>>, depending on the attribute type that is specified by the inputTimeSeries parameter. For example:
    • If the inputTimeSeries parameter specifies an attribute type of float64, the return type is list<float64>.
    • If the inputTimeSeries parameter specifies an attribute type of list<float64>, the return type is list<list<float64>>.
  • The forecastedTimestamp() output function return type can either be timestamp or uint64, depending on the attribute type that is specified by the inputTimestamp parameter. For example, if the inputTimestamp parameter specifies an attribute type of timestamp, the return type is timestamp.
  • The forecastedAllTimestamps() output function return type can be either list<timestamp> or list<uint64>, depending on the attribute type that is specified by the inputTimestamp parameter. For example, if the inputTimestamp parameter specifies an attribute type of uint64, the return type is list<uint64>.
  • The partitionBy parameter now only specifies the expression for the key values from input port 0. To specify an expression for the key values from the control port (input port 1), use the controlPortPartitionBy parameter.
  • The controlPortPartitionBy parameter allows you to specify the expression for the key values from input port 1.
  • The retrainingConfig parameter is renamed to updateParams.
  • The controlSignal parameter no longer supports the TSSignal.Suspend, TSSignal.Resume, and TSSignal.Load control signals.
  • Using the TSSignal.Retrain signal with the HoltWinters2 operator only retrains the HoltWinters model. This signal no longer updates the model parameters. In order to update model parameters, use the TSSignal.UpdateParamsAll control signal. If you are using partitioning, the TSSignal.Retrain signal uses the expression specified by the controlPortPartitionBy parameter.
  • The TSSignal.UpdateParamsAll signal updates the HoltWinters2 operator parameter values based on the attribute specified by the updateParams parameter, which was previously called retrainingConfig. If you are using partitioning, this signal updates the parameter values for all of the models, regardless of the key provided by the controlPortPartitionBy parameter. You cannot currently update the parameters for an individual model.