IDAX.PREDICT_REGTREE - Apply a regression tree model

Use this stored procedure to apply a regression tree model to predict a class value for records of the input table.

Authorization

The privileges held by the authorization ID of the statement must include the IDAX_USER role. Additionally, you must be the owner of the model or have the authority to alter it.

Syntax

IDAX.PREDICT_REGTREE(in parameter_string varchar(32672))

Parameter descriptions

parameter_string
Mandatory one-string parameter that contains pairs of <parameter>=<value> entries that are separated by a comma.
Data type: VARCHAR(32672)
The following list shows the parameter values:
model
Mandatory.
The name of the regression tree model that is to be applied.
Data type: VARCHAR(64)
intable
Mandatory.
The name of the input table.
Data type: VARCHAR(128)
outtable
Mandatory.
The name of the output table where the predictions are stored.
Data type: VARCHAR(128)
id
Optional.
The column of the input table that identifies a unique instance ID.
Default: The name of the id column that is used to build the model.
Data type: VARCHAR(128)
target
Optional.
The column of the input table that represents the prediction target.
The specified target column is not used for prediction.
The specified target column can contain NULL values.
Default: The name of the target column that is used to build the model.
Data type: VARCHAR(128)
var
Optional.
A flag that shows whether the variance of the predictions are to be included in the output table.
Default: false
Data type: BOOLEAN

Returned information

The number of the input table records for which predictions are generated as a result set.

Example

CALL IDAX.PREDICT_REGTREE('model=adult_regtree, intable=adult, outtable=adult_pred, var=true');