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

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

@@ -0,0 +1,469 @@
+{
+        "FuncName": "TD_AUTOARIMA",
+        "FuncDescriptionShort": "TD_AUTOARIMA fits the best ARIMA model to univariate time series.",
+        "FuncDescriptionLong": [
+                "The function searches the possible models within the order constrains in the function parameters.",
+                "returns the best ARIMA model based on the criterion provided by the INFOR_CRITERIA parameter.",       
+                "The TD_AUTOARIMA function creates a six-layered ART table."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Auto_Arima",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "Time series whose value can be REAL."
+                        ],
+                        "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>",
+								"big_integer",
+                                "VARCHAR",
+                                "float",
+                                "float",
+                                "float",
+								"float"
+                        ],
+                        "Description": [
+                                "The primary result containing the selected best model’s coefficients.",
+                                "The primary result set is accessed using a SELECT statement."
+                        ],
+                        "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": [
+								"<varies>",
+								"big_integer",
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+								"float",
+								"float",
+								"VARCHAR"
+                        ],
+                        "Description": [
+                                "The secondary 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. ",
+                                "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": [
+                                "<varies>",
+								"big_integer",
+								"float",
+								"float",
+								"float"
+                        ],
+                        "Description": [
+                                "The tertiary result set contains residuals from the fitting exercise.",
+                                "The tertiary is accessed using the TD_EXTRACT_RESULTS utility function."
+                        ],
+                        "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": [
+                                "<varies>",
+								"big_integer",
+								"VARBYTE"
+                        ],
+                        "Description": [
+                                "The quaternary result set contains the best model context, which is used during the forecasting process.",
+                                "The quaternary is accessed using the TD_EXTRACT_RESULTS utility function."
+                        ],
+                        "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": "ARTICANDORDER",
+                        "ResultTableColumnTypes": [
+                                "<varies>",
+								"big_integer",
+								"integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+								"float",
+								"VARCHAR"
+                        ],
+                        "Description": [
+                                "The quinary result set contains the information criteria such as AIC and SBIC, and the order of the best model.",
+                                "The quinary is accessed using the TD_EXTRACT_RESULTS utility function."
+                        ],
+                        "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": "ARTARMAROOTS",
+                        "ResultTableColumnTypes": [
+                                "<varies>",
+								"big_integer",
+								"VARCHAR",                        
+                                "float",
+                                "float",
+                                "VARCHAR"                             					
+                        ],
+                        "Description": [
+                                "The senary result set contains the roots information.",
+                                "The senary is accessed using the TD_EXTRACT_RESULTS utility function."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "MAX_PQ_NONSEASONAL",
+                        "Type": "list",
+                        "ListType": "integer",
+                        "ListSize": 2,
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+						"DefaultValue": [5, 5],
+                        "Description": [
+                                "The (p,q) order of the maximum autoregression (AR) and moving average (MA) parameters."
+                        ]
+                },
+				{
+                        "Name": "MAX_PQ_SEASONAL",
+                        "Type": "list",
+                        "ListType": "integer",
+                        "ListSize": 2,
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+						"DefaultValue": [2, 2],
+                        "Description": [
+                                "The (P,Q) order of the max seasonal AR and MA parameters."
+                        ]
+                },
+				{
+                        "Name": "START_PQ_NONSEASONAL",
+                        "Type": "list",
+                        "ListType": "integer",
+                        "ListSize": 2,
+                        "Optional": true,       
+						"LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",						
+						"DefaultValue": [0, 0],
+                        "Description": [
+                                "The start value of (p,q). Only used when STEPWISE(1)."
+                        ]
+                },
+				{
+                        "Name": "START_PQ_SEASONAL",
+                        "Type": "list",
+                        "ListType": "integer",
+                        "ListSize": 2,
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+						"DefaultValue": [0, 0],
+                        "Description": [
+                                "The start value of seasonal (P,Q). Only used when STEPWISE(1)."
+                        ]
+                },
+				{
+                        "Name" : "d",
+						"Type" : "integer",
+						"Optional" : true,                     
+						"DefaultValue": -1,
+                        "Description": [
+                                "The order of first-differencing. Default is -1 (auto search d)."
+                        ]
+                },
+				{
+                        "Name" : "Ds",
+						"Type" : "integer",
+						"Optional" : true,                     
+						"DefaultValue": -1,
+                        "Description": [
+                                "The order of seasonal-differencing. Default: -1 (auto search Ds))."
+                        ]
+                },
+				{
+                        "Name" : "MAX_d",
+						"Type" : "integer",
+						"Optional" : true,
+                        "LowerBound": 0,												
+                        "LowerBoundType": "INCLUSIVE",
+						"DefaultValue": 2,
+                        "Description": [
+                                "Maximum number of non-seasonal differences."
+                        ]
+                },
+				{
+                        "Name" : "MAX_Ds",
+						"Type" : "integer",
+						"Optional" : true,
+                        "LowerBound": 0,												
+                        "LowerBoundType": "INCLUSIVE",
+						"DefaultValue": 1,
+                        "Description": [
+                                "Maximum number of seasonal differences."
+                        ]
+                },
+				{
+                        "Name" : "PERIOD",
+						"Type" : "integer",
+						"Optional" : true,
+                        "LowerBound": 1,
+						"UpperBound": 12,
+                        "LowerBoundType": "INCLUSIVE",
+                        "UpperBoundType": "INCLUSIVE",
+						"DefaultValue": 1,
+                        "Description": [
+                                "The number of periods per season. For non-seasonal data, period is 1."
+                        ]
+                },
+				{
+                        "Name" : "STATIONARY",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 0,
+                        "Description": [
+                                "If true, the the function restricts search to stationary models. A value of 1 means true. A value of 0 means false."
+                        ]
+                },
+				{
+                        "Name" : "SEASONAL",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 1,
+                        "Description": [
+                                "If false, then the function restricts search to non-seasonal models. A value of 1 means true. A value of 0 means false. Default is 1, meaning search all models including seasonal."
+                        ]
+                },
+				{
+                        "Name" : "CONSTANT",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 1,
+                        "Description": [
+                                "Indicator that TD_AUTOARIMA function include an intercept. A value of 1 means CONSTANT/intercept should be included. A value of 0 means CONSTANT/intercept should not be included."
+                        ]
+                },
+				{
+                        "Name" : "ALGORITHM",
+						"Type" : "string",
+						"Optional" : true,
+                        "PermittedValues": [
+                               "MLE", 
+							   "CSS_MLE", 
+							   "CSS"
+                        ],
+						"DefaultValue": "MLE",
+                        "Description": [
+                                "The approach used by TD_AUTOARIMA to estimate the coefficients."
+                        ]
+                },
+				{
+                        "Name" : "FIT_PERCENTAGE",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               
+                        ],
+						"DefaultValue": 100,
+                        "Description": [
+                                "Percentage of passed-in sample points used for the model fitting (parameter estimation). The default is 100, meaning 100%."
+                        ]
+                },
+				{
+                        "Name" : "INFOR_CRITERIA",
+						"Type" : "string",
+						"Optional" : true,
+                        "PermittedValues": [
+                              "AIC", 
+							  "AICC", 
+							  "BIC"
+                        ],
+						"DefaultValue": "AIC",
+                        "Description": [
+                                "Information criterion to be used in model selection. Options are AIC, AICc, BIC."
+                        ]
+                },
+				{
+                        "Name" : "STEPWISE",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 0,
+                        "Description": [
+                                "If true, then the function does stepwise selection. If false, the the function selects all models. A value of 1 means true. A value of 0 means false."
+                        ]
+                },
+				{
+                        "Name" : "NMODELS",
+						"Type" : "integer",
+						"Optional" : true,
+                        "LowerBound": 1,
+						"UpperBound": 94,
+                        "LowerBoundType": "INCLUSIVE",
+                        "UpperBoundType": "INCLUSIVE",
+						"DefaultValue": 94,
+                        "Description": [
+                                "Maximum number of models considered in the stepwise search."
+                        ]
+                },
+				{
+                        "Name" : "MAX_ITERATIONS",
+						"Type" : "integer",
+						"Optional" : true,
+                        "LowerBound": 1,						
+                        "LowerBoundType": "INCLUSIVE",
+						"DefaultValue": 100,
+                        "Description": [
+                                "The maximum number of iterations that can be employed to non-linear optimization procedure."
+                        ]
+                },
+				{
+                        "Name" : "COEFF_STATS",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 0,
+                        "Description": [
+                                "Indicator to return coefficient statistical columns TSTAT_VALUE and TSTAT_PROB. A value of 1 means return the columns. A value of 0 means do not return the columns."
+                        ]
+                },
+				{
+                        "Name" : "FIT_METRICS",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 0,
+                        "Description": [
+                                "Indicator to generate the secondary result set that contains the model metadata statistics. A value of 1 means generate the secondary result set. A value of 0 means do not generate the secondary result set."
+                        ]
+                },
+				{
+                        "Name" : "RESIDUALS",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 0,
+                        "Description": [
+                                "Indicator to generate the tertiary result set that contains the model residuals. A value of 1 means generate the tertiary result set. A value of 0 means do not generate the tertiary result set."
+                        ]
+                },
+				{
+                        "Name" : "ARMA_ROOTS",
+						"Type" : "integer",
+						"Optional" : true,
+                        "PermittedValues": [
+                               0,
+							   1
+                        ],
+						"DefaultValue": 0,
+                        "Description": [
+                                "Indicator to generate the senary result set that contains the inverse AR and MA roots of result best model that TD_AUTOARIMA selected (the model in the primary output layer). There should be no inverse roots showing outside of the unit circle. A value of 1 means generate result set. A value of 0 means do not generate a result set."
+                        ]
+                },
+				{
+                        "Name" : "TEST_NONSEASONAL",
+						"Type" : "string",
+						"Optional" : true,
+                        "PermittedValues": [
+                               "ADF"
+                        ],
+						"DefaultValue": "ADF",
+                        "Description": [
+                                "Nonseasonal unit root test used to choose differencing number d.",
+								"TD_AUTOARIMA function only uses ADF test for nonseasonal unit root test."
+                        ]
+                },
+				{
+                        "Name" : "TEST_SEASONAL",
+						"Type" : "string",
+						"Optional" : true,
+                        "PermittedValues": [
+                               "OCSB"
+                        ],
+						"DefaultValue": "OCSB",
+                        "Description": [
+                                "Seasonal unit root test used to choose differencing number D.",
+								"TD_AUTOARIMA function only uses OCSB test for seasonal unit root test."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": [
+                {
+                        "Name": "INDEX_STYLE",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "NUMERICAL_SEQUENCE",
+                        "PermittedValues": [
+                                "NUMERICAL_SEQUENCE",
+                                "FLOW_THROUGH"
+                        ],
+                        "Description": [
+                                "[Optional] User can choose between an index style of NUMERICAL_SEQUENCE or FLOW_THROUGH."								
+                        ],
+                        "LangName": "output_fmt_index_style"
+                }
+        ]
+}

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

@@ -43,13 +43,11 @@
                         "PrimaryLayer": true,
                         "LayerName": "ARTPRIMARY",
                         "ResultTableColumnTypes": [
-					 
                                 "<varies>",
                                 "<varies>",
                                 "float"
                         ],
                         "Description": [
-					 
                                 "The TD_BINARYMATRIXOP function returns only a primary result set.   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 table containing the results.",
                                 "<varies> data type and values dependent upon the OUTPUT_FMT(INDEX_STYLE()) declaration."
                         ],
@@ -58,7 +56,6 @@
         ],
         "IsPlottable": true,
         "Params": [
-	 
                 {
                         "Name": "MATHOP",
                         "Type": "string",

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

@@ -43,12 +43,10 @@
                         "PrimaryLayer": true,
                         "LayerName": "ARTPRIMARY",
                         "ResultTableColumnTypes": [
-					 
                                 "<varies>",
                                 "float"
                         ],
                         "Description": [
-					 
                                 "The TD_BINARYSERIES_OP function returns only a primary result set.   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 table containing the results.",
                                 "<varies> data type and values dependent upon the OUTPUT_FMT(INDEX_STYLE()) declaration."
                         ],

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

@@ -73,13 +73,14 @@
                         "Name": "SIGNIFICANCE_LEVEL",
                         "Type": "double",
                         "Optional": true,
+                        "DefaultValue": 0.05,
                         "LowerBound": 0,
                         "UpperBound": 1,
                         "LowerBoundType": "EXCLUSIVE",
                         "UpperBoundType": "EXCLUSIVE",
                         "AllowNaN": false,
                         "Description": [
-                                "The desired significance level for the test. Set to 0.01 or 0.05. "
+                                "The desired significance level for the test. Set to 0.01 or 0.05. Default is 0.05."
                         ]
                 }
         ],

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

@@ -28,7 +28,6 @@
                         "PrimaryLayer": true,
                         "LayerName": "ARTPRIMARY",
                         "ResultTableColumnTypes": [
-					 
                                 "integer",
                                 "integer",
                                 "float",
@@ -43,7 +42,6 @@
                                 "varchar(16)"
                         ],
                         "Description": [
-					 
                                 "The TD_BREUSCH_PAGAN_GODFREY function returns only a primary result set consisting of one row per unique series acted upon.  The row contains data describing the results of running the BPG test upon that series.  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 table containing the results."
                         ],
                         "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
@@ -52,7 +50,6 @@
         "IsPlottable": false,
         "Params": [
                 {
-		 
                         "Name": "VARIABLES_COUNT",
                         "Type": "integer",
                         "Optional": false,
@@ -69,9 +66,9 @@
                         "Optional": true,
                         "Description": [
                                 "This is an optional parameter.  If present, it signifies that the data scientist desires that the provided regression formula serve as the driving formula for the auxiliary regression.   In performing the regression, the software will use the explanatory variables identified within the PAYLOAD() portion of the original series specification. ",
-                                "If the AUX_FORMULA is not present, then this signifies that the BPG test should be performed using the default auxiliary regression formula, which, based on the number of explanatory variables, runs the auxiliary regression as:",
+                                "If the FORMULA is not present, then this signifies that the BPG test should be performed using the default auxiliary regression formula, which, based on the number of explanatory variables, runs the auxiliary regression as:",
                                 "p_t = a_0 + a_1 * X1 + a_2 * X2 + ... + a_N * XN ; where N is the VARIABLES_COUNT.",
-                                "When present, the AUX_FORMULA is a Teradata formula string that defines the formula that is to be used in the auxiliary regression operation. As an example consider: FORMULA(ρt = α0 + α1 X12 );  in which ρt is the dependent variable whose data is self-generated by this test;  and X1 (which is squared in the formula) is the single explanatory variable, whose data source is identified by the PAYLOAD() portion of the original series specification; and α0 and α1 are the coefficients to be solved. "
+                                "When present, the FORMULA is a Teradata formula string that defines the formula that is to be used in the auxiliary regression operation. As an example consider: FORMULA(ρt = α0 + α1 X12 );  in which ρt is the dependent variable whose data is self-generated by this test;  and X1 (which is squared in the formula) is the single explanatory variable, whose data source is identified by the PAYLOAD() portion of the original series specification; and α0 and α1 are the coefficients to be solved. "
                         ]
                 },
                 {

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

@@ -33,13 +33,11 @@
                         "PrimaryLayer": true,
                         "LayerName": "ARTPRIMARY",
                         "ResultTableColumnTypes": [
-					 
                                 "integer",
                                 "float",
                                 "float"
                         ],
                         "Description": [
-					 
                                 "The TD_CONVOLVE function returns only a primary result set.   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 table containing the results."
                         ],
                         "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
@@ -47,7 +45,6 @@
         ],
         "IsPlottable": true,
         "Params": [
-	 
                 {
                         "Name": "ALGORITHM",
                         "Type": "string",
@@ -57,9 +54,9 @@
                                 "CONV_DFFT"
                         ],
                         "Description": [
-                                "Optional Parameter.  Mainly a feature intended for testing.   Bypasses the internal planning and  forces a particular convolution algorithm to be applied.     Choices are: 'CONV_SUMMATION', or 'CONV_DFFT'.  If an attempt is made to force the CONV_SUMMATION approach when either input series has greater than 64 entries, a SQL error is returned to the caller.     When this parameter is NOT PRESENT, the internal planning logic will select the best option, dependent upon the number of entries in the source input series.    "
+                                "Optional parameter. Options are CONV_SUMMATION or CONV_DFFT. By default, the function selects the best option based on the number of entries present in the two inputs, and their types ( REAL, COMPLEX, and so on.) CONV_SUMMATION only supports:• REAL,REAL • REAL, MULTIVAR_REAL • MULTIVAR_REAL,REAL • MULTIVAR_REAL,MULTIVAR_REAL. If the CONV_SUMMATION option is passed in when the first input is greater than 64 entries or the second input is greater than 63 entries, then CONV_DFFT is used instead. This parameter is mostly used for testing."
                         ]
-                }											    
+                }
         ],
         "InputFmt": [
                 {
@@ -78,4 +75,4 @@
                 }
         ],
         "OutputFmt": false
-}
+}

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

@@ -45,9 +45,7 @@
                 }
         ],
         "IsPlottable": true,
-        "Params": [
-
-        ],
+        "Params": [],
         "InputFmt": [
                 {
                         "Name": "INPUT_MODE",

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

@@ -31,13 +31,11 @@
                         "PrimaryLayer": true,
                         "LayerName": "ARTPRIMARY",
                         "ResultTableColumnTypes": [
-
                                 "float",
                                 "float",
                                 "varchar(40)"
                         ],
                         "Description": [
-
                                 "This primary layer will contain the Bartlett test statistics and p-value, significant level and test results.",
                                 "The primary result set can be retrieved by issuing a SELECT against the analytical result table (ART) containing the results whereas the secondary results set can be accessed via the TD_EXTRACT_RESULTS utility function. ",
                                 "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",
@@ -50,7 +48,6 @@
                         "PrimaryLayer": false,
                         "LayerName": "ARTCPDATA",
                         "ResultTableColumnTypes": [
-
                                 "integer",
                                 "integer",
                                 "float",
@@ -63,7 +60,6 @@
                                 "float"
                         ],
                         "Description": [
- 
                                 "The secondary layer ARTCPDATA will contain the cumulative periodogram at each periodicity, related intermediate calculation result and confidence band result at each periodicity in order to be used to plot the cumulative periodograms.",
                                 "there will be one result row per unique periodicity returned for each series acted upon."
                         ],
@@ -72,7 +68,6 @@
         ],
         "IsPlottable": true,
         "Params": [
-
                 {
                         "Name": "SIGNIFICANCE_LEVEL",
                         "Type": "double",