PMMLPredict Syntax Elements | Vantage BYOM - PMMLPredict Syntax Elements - Teradata Vantage

Teradata Vantageā„¢ - Bring Your Own Model User Guide

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Vantage
Release Number
5.0
Published
October 2023
Language
English (United States)
Last Update
2024-04-06
dita:mapPath
fee1607120608274.ditamap
dita:ditavalPath
ayr1485454803741.ditaval
dita:id
fee1607120608274
schema
[Optional] Specify the schema in which PMMLPredict is installed.
Default: mldb
Accumulate
Specify one or more InputTable columns to copy to the output table. The asterisk specifies all InputTable columns.
An accumulate_column cannot have the reserved column name 'prediction' or 'json_report' or the data type BLOB or CLOB.
You cannot specify the same accumulate_column more than once.
ModelOutputFields
[Optional] Specify the scoring fields to output as individual columns (instead of outputting the JSON string that contains all the scoring output fields). For information about PMML output fields, see http://dmg.org/pmml/v4-2-1/Output.html.
To specify a model_output_field that is not in the JSON string is an error.
Default behavior: The function outputs the JSON string that contains all the output fields in the output table column json_report.
OverwriteCachedModel
[Optional] Valid values are: 'current_cached_model', '*', 'true', 't', 'yes', '1', 'false', 'f', 'no', 'n', or '0'. All of these values are equivalent as this argument applies only to the model specified in the model ON clause, which is assumed to be in the cache.
Important: Do not use the OverwriteCachedModel argument except when you are trying to replace a previously cached model. This applies to all models supported by BYOM. Using the argument in other cases, including in concurrent queries or multiple times within a short period of time, may lead to an OOM error from garbage collection not being fast enough.
If a model loaded into the memory of the node fits in the cache, it stays in the cache until being evicted to make space for another model that needs to be loaded or after 7 days if not used. Therefore, a model can remain in the cache after the query that loaded it completes. Other queries that use the same model can use it, saving the cost of reloading it into memory.
You want to overwrite a cached model only when it has been updated, to make sure that the Predict function uses the updated model instead of the cached model.
Default behavior: The function does not overwrite cached models.
IsDebug
[Optional] When true, debug statements are added to a trace table that must be created beforehand. See Error Logs.

Only available with BYOM version 3.00.00.02 and later.

Default: False