teradataml 20.0.0.8__py3-none-any.whl

teradataml/data/jsons/uaf/17.20/TD_SELECTION_CRITERIA.json

@@ -0,0 +1,90 @@
+{
+        "FuncName": "TD_SELECTION_CRITERIA",
+        "FuncDescriptionShort": "The TD_SELECTION_CRITERIA function calculates a number of metrics ",
+        "FuncDescriptionLong": [
+                "The TD_SELECTION_CRITERIA function calculates a number of metrics against the residuals left over from a model validation exercise.  The produced metrics can be used by the data scientist to make an intelligent choice as to which forecast model candidates to select to pursue for their forecast modeling project. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Selection_Criteria",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This section outlines the syntax associated with invoking the TD_SELECTION_CRITERIA function.   This function can accept either a single multivariate series as an input, or alternatively can accept an ART table containing the residual results from a previously run regression operation. ",
+                                "For the case in which the input is a single multivariate series, the fields in the SERIES_SPEC(PAYLOAD(FIELDS(). CONTENT(MULTIVAR_REAL)) must consists of: First field referenced is the original series value; Second field referenced is the calculated series value produced by the model; Third field is the calculated residual: original_value minus calculated_value",
+                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_SELECTION_CRITERIA  function returns only a primary result set consisting of one row per unique series acted upon.   There are no secondary or tertiary result sets produced by this function.  The primary result set can be retrieved by issuing a SELECT against the analytical result table (ART) containing the results."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [
+                {
+                        "Name": "VAR_COUNT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "For an ARIMA(p,d,q) model, this is an integer indicating the total number of parameters: VAR_COUNT = p + q +1(CONSTANT(1)); present in the model. "
+                        ]
+                },
+                {
+                        "Name": "CONSTANT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "If  the ARIMA model has the constant part when fit the model. 0 is no constant and 1 is with constant"
+                        ]
+                },
+                {
+                        "Name": "USE_LIKELIHOOD",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "If the calculation of those selection criteria values like AIC are based on the max log-likelihood provided during the model fitting stage. Only available when input table is art generated from TD_ARIMAESTIMATE.",
+                                "If throwing regular input or art from TD_ARIMAVALIDATE, function will error out.",
+                                "0 is using RSS, and 1 is using log-likelihood. Default value is 0 - using residuals."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}

teradataml/data/jsons/uaf/17.20/TD_SIGNIF_PERIODICITIES.json

@@ -0,0 +1,80 @@
+{
+        "FuncName": "TD_SIGNIF_PERIODICITIES",
+        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
+        "FuncDescriptionLong": [
+                "The Significance of Periodicities statistical test aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the 'model fitting' exercise; and, the second portion to be used for the 'model validation' exercise.  The TD_SIGNIF_PERIODICITIES function is usually executed against the residuals produced during the second 'model validation' exercise, meaning against the 'in-sample' forecasted data points."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Signif_Periodicities",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This section outlines the syntax associated with invoking the TD_SIGNIF_PERIODICITIES function.   This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (TD_ARIMAVALIDATE) operation. ",
+                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
+                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_SIGNIF_PERIODICITIES function returns only a primary result set consisting of one row per unique periodicity acted upon.   There are no secondary or tertiary result sets produced by this function.  The primary result set can be retrieved by issuing a SELECT against the analytical result table (ART) containing the results."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The significance level for the statistical F-test"
+                        ]
+                },
+                {
+                        "Name": "PERIODICITIES",
+                        "Type": "list",
+                        "ListType": "double",
+                        "Optional": false,
+                        "AllowNaN": false,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "A list containing one or more floating point values; representing significant periodicities: w1, w2, ..., wd. ; in terms of wk.  Where   wk = 2pi / P"
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}

teradataml/data/jsons/uaf/17.20/TD_SIGNIF_RESIDMEAN.json

@@ -0,0 +1,68 @@
+{
+        "FuncName": "TD_SIGNIF_RESIDMEAN",
+        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
+        "FuncDescriptionLong": [
+                "The Significance of Residual Mean statistical test is aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the “model fitting” exercise; and, the second portion to be used for the “model validation” exercise.  The TD_SIGNIF_RESIDMEAN function is usually executed against the residuals produced during the second “model validation” exercise, meaning against the “in-sample” forecasted data points."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Signif_Residmean",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (TD_ARIMAVALIDATE) operation. ",
+                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
+                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_SIGNIF_RESIDMEAN  function returns only a primary result set consisting of one row per unique series acted upon.   There are no secondary or tertiary result sets produced by this function.  The primary result set can be retrieved by issuing a SELECT against the analytical result table (ART) containing the results.",
+                                "There is one result row returned for each unique series acted upon. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The significance level for the statistical t-test"
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}

teradataml/data/jsons/uaf/17.20/TD_SIMPLEEXP.json

@@ -0,0 +1,184 @@
+{
+        "FuncName": "TD_SIMPLEEXP",
+        "FuncDescriptionShort": "The forecasting of the original series",
+        "FuncDescriptionLong": [
+                "The Simple Exponential Smoothing (aka, Single Exponential Smoothing) approach employs a forecasting model that uses only the “level” modeling component to accomplish the forecasting of the original series."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Series Forecasting",
+        "JSONVersion": "1",
+        "FuncRName": "td_Simple_Exp",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "Passed in a logical univariate series, this function will forecast “h” periods (“h” steps) into the future, meaning “h” periods beyond the last observed sample point for the passed in series.   This function outputs up to three result sets.  The primary result set contains the historical data points, the forecasted data points, and the prediction level data points.  This result set can be retrieved by issuing a SELECT against the analytical result table.   The optional secondary result set contains a collection of goodness-of-fit metrics, roughly equivalent to those returned by the independent TD_FIT_METRICS function.  The optional tertiary result set contains the residual series, associated with the forecasting operation. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "<varies>",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The primary result set contains the historical “observed” values, the “forecasted” values, and, if requested, the high and low prediction intervals  The primary analytical result set can be retrieved by issuing a SELECT against the table created by the INTO VOLATILE clause. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                },
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": false,
+                        "LayerName": "ARTFITMETADATA",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "integer",
+                                "integer",
+                                "float"
+                        ],
+                        "Description": [
+                                "The RETURNS TABLE for this optional analytical result set, containing “goodness of fit” metadata, is described in this subsection.   This result set is generated in response to the FUNC_PARAMS (FIT_METRICS(1) having a passed in flag value of '1'.   The result set can be retrieved by invoking the TD_EXTRACT_RESULTS function against the analytical result table containing the metadata. This result set will be deposited into LAYER1 under the name ARTFITMETADATA.",
+                                "There is one result row returned for each unique series acted upon. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                },
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": false,
+                        "LayerName": "ARTFITRESIDUALS",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "This result set is generated in response to the FUNC_PARAMS( RESIDUALS(1)) having a passed in flag value of '1'.   The result set can be retrieved by invoking the TD_EXTRACT_RESULTS function against the analytical result table containing the metadata. This result set will be deposited into LAYER1 under the name ARTFITRESIDUALS."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "FORECAST_PERIODS",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Number of Periods to Forecast ahead"
+                        ]
+                },
+                {
+                        "Name": "ALPHA",
+                        "Type": "double",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "UpperBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "If present, this value is used in the equation to perform the forecasting.  If not present, then the value of ALPHA is estimated by using 'goodness of fit' metrics",
+                                "F_{t+1} = F_t + a(Y_t - F_t)  =  aY_t + (1- a)F_t"
+                        ]
+                },
+                {
+                        "Name": "PREDICTION_INTERVALS",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "NONE",
+                                "80",
+                                "95",
+                                "BOTH"
+                        ],
+                        "DefaultValue": "BOTH",
+                        "Description": [
+                                "Set to either of: 'NONE' or '80' or '95' or 'BOTH'; default is 'BOTH'"
+                        ]
+                },
+                {
+                        "Name": "FORECAST_STARTING_VALUE",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "FIRST",
+                        "PermittedValues": [
+                                "FIRST",
+                                "MEAN"
+                        ],
+                        "Description": [
+                                "Set to either of: 'FIRST' or 'MEAN'; default is 'FIRST'  "
+                        ]
+                },
+                {
+                        "Name": "FIT_METRICS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Flag indicating whether or not to generate the secondary result set that contains the model metadata statistics.  A value of FIT_METRICS(1) means generate the secondary result set.   A value of FIT_METRICS(0) means do not generate the secondary result set.  Default is FIT_METRICS(0).  The generated result set can be retrieved by issuing a TD_EXTRACT_RESULTS against the analytical result table containing the results."
+                        ]
+                },
+                {
+                        "Name": "RESIDUALS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Flag indicating whether or not to generate the tertiary result set that contains the model residuals.  A value of RESIDUALS(1) means generate the tertiary result set.   A value of RESIDUALS(0) means do not generate the tertiary result set.  Default is RESIDUALS(0).  The generated result set can be retrieved by issuing a TD_EXTRACT_RESULTS against the analytical result table containing the results."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": [
+                {
+                        "Name": "INDEX_STYLE",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "NUMERICAL_SEQUENCE",
+                        "PermittedValues": [
+                                "NUMERICAL_SEQUENCE",
+                                "FLOW_THROUGH"
+                        ],
+                        "Description": [
+                                "Specifies the INDEX_STYLE of the output format."
+                        ],
+                        "LangName": "output_fmt_index_style"
+                }
+        ]
+}

teradataml/data/jsons/uaf/17.20/TD_SINFO.json

@@ -0,0 +1,58 @@
+{
+        "FuncName": "TD_SINFO",
+        "FuncDescriptionShort": "Used to return some metadata describing the logical series",
+        "FuncDescriptionLong": [
+                "The TD_SINFO 'Series Information' function is an AF Utility function used to return some metadata describing the logical series identified by the SERIES_SPEC specification passed into the function.  For each series this function returns:",
+                "Series Index Data type - TIMESTAMP, TIMESTAMP WITH TIME ZONE, DATE, INTEGER, or FLOAT",
+                "Starting Index value associated with the series ",
+                "Ending Index value associated with the series ",
+                "Count of total number of entries in the series",
+                "Flag indicating whether this is a discrete/regular series or an irregular series",
+                "Sample interval - sample interval associated with a discrete series; or, alternatively, average of all sample intervals encountered, if it is an irregular series.",
+                "Content Type of  payload “fields” - REAL, COMPLEX, AMPL_PHASE_RADIANS, AMPL_PHASE_DEGREES, MULTIVAR_REAL, MULTIVAR_COMPLEX, MULTIVAR_AMPL_PHASE_RADIANS, or MULTIVAR_AMPL_PHASE_DEGREES",
+                "For each payload “fields” :Minimum sample magnitude encountered in series,Maximum sample magnitude encountered in series,Average of all magnitudes encountered in series, Root-Mean-Square (RMS) for each magnitude in the series"
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "General Utility",
+        "JSONVersion": "1",
+        "FuncRName": "td_SInfo",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "This AF function is passed a collection of logical series described by a series specification SERIES_SPEC. These logical series can be of either the regular or irregular variety.  Their indexing mechanisms can be based on time or space. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "char(40) ",
+                                "varies",
+                                "varies",
+                                "integer",
+                                "integer",
+                                "varchar(60)",
+                                "varchar(20)",
+                                "list<N, float>",
+                                "list<N, float>",
+                                "list<N, float>",
+                                "list<N, float>"
+                        ],
+                        "Description": [
+                                "Invoking the TD_SINFO function generates only a primary analytical result set; there are no secondary or other result sets generated by invoking this function. The primary result set can be accessed via a subsequent SELECT statement issued against the analytical result table."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [],
+        "InputFmt": false,
+        "OutputFmt": false
+}