Use this stored procedure to apply a decision 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_DECTREE(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 decision 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 class.
- Default: The name of the target column that is used to build the model.
- Data type: VARCHAR(128)
- prob
- Optional.
- A flag that indicates whether the probability of the predicted class is included in the output
table.
- Default: false
- Data type: BOOLEAN
- outtableprob
- Optional.
- The name of the probability output table where class probability predictions are stored.
- Default: NULL
- Data type: VARCHAR(128)
Returned information
The number of the input table records for which predictions are generated as a result set.
Example
CALL IDAX.PREDICT_DECTREE('model=adult_dectree, intable=adult, outtable=adult_pred, prob=true, outtableprob=adult_pred_dist');