Module datarush.analytics

Package com.pervasive.datarush.analytics.regression

Class RegressionPredictor

java.lang.Object

com.pervasive.datarush.operators.AbstractLogicalOperator

com.pervasive.datarush.operators.StreamingOperator

com.pervasive.datarush.operators.ExecutableOperator

com.pervasive.datarush.analytics.util.AbstractPredictor

com.pervasive.datarush.analytics.regression.RegressionPredictor

All Implemented Interfaces:

LogicalOperator

public class RegressionPredictor
extends AbstractPredictor

Apply a regression model to the input data. The model defines the independent variables used to create the model. The input data must contain the same independent variables as fields in the data flow. The predicted value is added to the output data flow. All input fields are also transferred to the output.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PREDICTED_SUFFIX	The default value for getPredictedFieldSuffix().

Constructor Summary

Constructors

Constructor	Description
RegressionPredictor()	Construct a new operator instance.

Method Summary

Modifier and Type	Method	Description
protected void	execute(PMMLModel model, RecordValued input, ScalarSettable[] predictedFields)	Called to perform prediction.
String	getPredictedFieldSuffix()	Get the suffix to add to the target field name.
protected RecordTokenType	predictedType(PMMLModelSpec modelSpec)	Given the model spec, returns the predicted type.
void	setPredictedFieldSuffix(String predictedFieldSuffix)	Set the suffix to be added to the target field name.

Methods inherited from class com.pervasive.datarush.analytics.util.AbstractPredictor

computeMetadata, execute, getInput, getModel, getOutput, pushPrediction, stepNext

Methods inherited from class com.pervasive.datarush.operators.ExecutableOperator

cloneForExecution, getNumInputCopies, getPortSettings, handleInactiveOutput

Methods inherited from class com.pervasive.datarush.operators.AbstractLogicalOperator

disableParallelism, getInputPorts, getOutputPorts, newInput, newInput, newOutput, newRecordInput, newRecordInput, newRecordOutput, notifyError

Methods inherited from class java.lang.Object

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

Field Detail

PREDICTED_SUFFIX

public static final String PREDICTED_SUFFIX

The default value for getPredictedFieldSuffix().

See Also:

Constant Field Values

Constructor Detail

RegressionPredictor

public RegressionPredictor()

Construct a new operator instance.

Method Detail

getPredictedFieldSuffix

public String getPredictedFieldSuffix()

Get the suffix to add to the target field name.

Returns:

target field name suffix

setPredictedFieldSuffix

public void setPredictedFieldSuffix(String predictedFieldSuffix)

Set the suffix to be added to the target field name. The suffix is set to "(predicted)" by default.

Parameters:

predictedFieldSuffix - target field name suffix

predictedType

protected RecordTokenType predictedType(PMMLModelSpec modelSpec)

Description copied from class: AbstractPredictor

Given the model spec, returns the predicted type. This should not include the input type ( the input is automatically prepended to the type that is returned )

Specified by:

predictedType in class AbstractPredictor

Parameters:

modelSpec - the model metadata

Returns:

the predicted type

execute

protected void execute(PMMLModel model,
                       RecordValued input,
                       ScalarSettable[] predictedFields)

Description copied from class: AbstractPredictor

Called to perform prediction. Subclasses are expected to loop over the input by calling AbstractPredictor.stepNext(). For each row of input, subclasses should first set the predicted values in the predictedFields array and then invoke AbstractPredictor.pushPrediction(). Subclasses should not invoke pushEndOfData since that is automatically handled by the base class.

Specified by:

execute in class AbstractPredictor

Parameters:

model - The input PMML model

input - The input data

predictedFields - An array of fields that reference the predicted field locations. The array positionally corresponds to the type returned by AbstractPredictor.predictedType(PMMLModelSpec).