teradataml 17.20.0.7__py3-none-any.whl → 20.0.0.1__py3-none-any.whl

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

@@ -1,80 +1,80 @@
-{
-        "FuncName": "TD_ARIMAFORECAST",
-        "FuncDescriptionShort": "ARIMA formulas that are being solved for the coefficients",
-        "FuncDescriptionLong": [
-                "ARIMA formulas that are being solved for the coefficients: Auto-Regressive: (AR1, ..., ARp) , Seasonal Auto-Regressive: (SAR1, ..., SARP) , Moving Average: (MA1, ..., MAq), and Seasonal Moving Average: (SMA1, ..., SMAQ) .  The reader should take note that the AR, SAR, MA, and SMA formulas solved by most of the statistical programs, such as 'R', may differ from the text books, relative to the 'sign' associated with the MA and SMA coefficients.",
-                "There are two approach available for the data scientist, regarding the usage of: TD_ARIMAESTIMATE, TD_ARIMAVALIDATE, and TD_ARIMAFORECAST.",
-                "Option 1: This approach uses all three phases: estimation, validation, and forecast.   First execute TD_ARIMAESTIMATE, then pass the estimate ART table result into TD_ARIMAVALIDATE, then pass the validate ART result into TD_ARIMAFORECAST. ",
-                "Option 2: The validation phase (TD_ARIMAVALIDATE) may be skipped, meaning that the ART produced by TD_ARIMAESTIMATE can directly be passed into TD_ARIMAFORECAST. In this case, TD_ARIMAESTIMATE must use FIT_PERCENTAGE(100), otherwise TD_ARIMAFORECAST will error out."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Series Forecasting",
-        "JSONVersion": "1",
-        "FuncRName": "td_Arima_Forecast",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "ART"
-                        ],
-                        "Description": [
-                                "Passed in an art spec with layer specified ARTMODEL, this function will forecast 'h' periods ('h' steps) into the future, meaning 'h' periods beyond the last observed sample point recorded in the passed in model.   This function only outputs a primary result set, containing forecasted value. This primary result set can be retrieved by issuing a SELECT 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",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-					 
-                                "<varies>",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-					 
-                                "Invoking this UAF Function only generates a primary result set containing 'forecasted' values.  The primary result set can be accessed via a subsequent SELECT statement against the ART table 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": "FORECAST_PERIODS",
-                        "Type": "integer",
-                        "Optional": false,
-                        "LowerBound": 1,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "Number of Periods to Forecast ahead"
-                        ]
-                }
-        ],
-        "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"
-                }
-        ]
+{
+        "FuncName": "TD_ARIMAFORECAST",
+        "FuncDescriptionShort": "ARIMA formulas that are being solved for the coefficients",
+        "FuncDescriptionLong": [
+                "ARIMA formulas that are being solved for the coefficients: Auto-Regressive: (AR1, ..., ARp) , Seasonal Auto-Regressive: (SAR1, ..., SARP) , Moving Average: (MA1, ..., MAq), and Seasonal Moving Average: (SMA1, ..., SMAQ) .  The reader should take note that the AR, SAR, MA, and SMA formulas solved by most of the statistical programs, such as 'R', may differ from the text books, relative to the 'sign' associated with the MA and SMA coefficients.",
+                "There are two approach available for the data scientist, regarding the usage of: TD_ARIMAESTIMATE, TD_ARIMAVALIDATE, and TD_ARIMAFORECAST.",
+                "Option 1: This approach uses all three phases: estimation, validation, and forecast.   First execute TD_ARIMAESTIMATE, then pass the estimate ART table result into TD_ARIMAVALIDATE, then pass the validate ART result into TD_ARIMAFORECAST. ",
+                "Option 2: The validation phase (TD_ARIMAVALIDATE) may be skipped, meaning that the ART produced by TD_ARIMAESTIMATE can directly be passed into TD_ARIMAFORECAST. In this case, TD_ARIMAESTIMATE must use FIT_PERCENTAGE(100), otherwise TD_ARIMAFORECAST will error out."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Series Forecasting",
+        "JSONVersion": "1",
+        "FuncRName": "td_Arima_Forecast",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "ART"
+                        ],
+                        "Description": [
+                                "Passed in an art spec with layer specified ARTMODEL, this function will forecast 'h' periods ('h' steps) into the future, meaning 'h' periods beyond the last observed sample point recorded in the passed in model.   This function only outputs a primary result set, containing forecasted value. This primary result set can be retrieved by issuing a SELECT 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",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+					 
+                                "<varies>",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+					 
+                                "Invoking this UAF Function only generates a primary result set containing 'forecasted' values.  The primary result set can be accessed via a subsequent SELECT statement against the ART table 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": "FORECAST_PERIODS",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Number of Periods to Forecast ahead"
+                        ]
+                }
+        ],
+        "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_ARIMAVALIDATE.json

@@ -1,151 +1,151 @@
-{
-        "FuncName": "TD_ARIMAVALIDATE",
-        "FuncDescriptionShort": "performs in-sample forecasting and then generates a residual series from the forecasted values with the observed 'test data' values",
-        "FuncDescriptionLong": [
-                "The TD_ARIMAVALIDATE function first performs an “In-Sample” forecast, followed by an analysis of the produced residuals.  The aim of this analysis is to provide the data scientist with a collection of metrics which are useful for model selection and expose the produced residuals, such that a number of model validation statistical tests can be conducted."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Model Preparation and Parameter Estimation",
-        "JSONVersion": "1",
-        "FuncRName": "td_Arima_Validate",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": "ART",
-                        "Description": [
-                                "Passed in an art table in ART_SPEC without specifying layer"
-                        ],
-                        "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": [
-                                "a primary layer containing the model selection metrics",
-                                "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"
-                },
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": false,
-                        "LayerName": "ARTFITMETADATA",
-                        "ResultTableColumnTypes": [
-                                "integer",
-                                "integer",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "integer",
-                                "integer",
-                                "float",
-                                "float",
-                                "float",
-                                "varchar(16)"
-                        ],
-                        "Description": [
-                                "a secondary layer containing the goodness-of-fit metrics",
-                                "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."
-                        ],
-                        "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": [
-                                "a tertiary layer containing the residuals left over from the validation exercise",
-                                "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 LAYER2 under the name ARTFITRESIDUALS."
-                        ],
-                        "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": "ARTMODEL",
-                        "ResultTableColumnTypes": [
-                                "integer",
-                                "integer",
-                                "varbyte(64000)"
-                        ],
-                        "Description": [
-                                "a quaternary layer, containing the model context, which can subsequently be used for forecasting with the model.",
-                                "This result set is always generated and contains the MODEL context which can subsequently be used to facilitate forecasting with the model.   Note that the main 'model' context is present in binary form and is not meant for human consumption.   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 LAYER3 under the name ARTMODEL."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-                {
-                        "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"
-                }
-        ]
-}
+{
+        "FuncName": "TD_ARIMAVALIDATE",
+        "FuncDescriptionShort": "performs in-sample forecasting and then generates a residual series from the forecasted values with the observed 'test data' values",
+        "FuncDescriptionLong": [
+                "The TD_ARIMAVALIDATE function first performs an “In-Sample” forecast, followed by an analysis of the produced residuals.  The aim of this analysis is to provide the data scientist with a collection of metrics which are useful for model selection and expose the produced residuals, such that a number of model validation statistical tests can be conducted."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Arima_Validate",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "ART",
+                        "Description": [
+                                "Passed in an art table in ART_SPEC without specifying layer"
+                        ],
+                        "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": [
+                                "a primary layer containing the model selection metrics",
+                                "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"
+                },
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": false,
+                        "LayerName": "ARTFITMETADATA",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "a secondary layer containing the goodness-of-fit metrics",
+                                "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."
+                        ],
+                        "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": [
+                                "a tertiary layer containing the residuals left over from the validation exercise",
+                                "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 LAYER2 under the name ARTFITRESIDUALS."
+                        ],
+                        "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": "ARTMODEL",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "varbyte(64000)"
+                        ],
+                        "Description": [
+                                "a quaternary layer, containing the model context, which can subsequently be used for forecasting with the model.",
+                                "This result set is always generated and contains the MODEL context which can subsequently be used to facilitate forecasting with the model.   Note that the main 'model' context is present in binary form and is not meant for human consumption.   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 LAYER3 under the name ARTMODEL."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "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"
+                }
+        ]
+}