teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,163 @@
+{
+        "FuncName": "TD_SMOOTHMA",
+        "FuncDescriptionShort": "Applies a smoothing algorithm to the series",
+        "FuncDescriptionLong": [
+                "The TD_SMOOTHMA provides five forms of moving average style of smoothing functions - cumulative, exponential, simple, centered, and weighted; and, additionally provides a moving median style of smoothing.  "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Smoothma",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "The function takes in a 1D array of real numbers as an input"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "SERIES",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "<varies>",
+                                "float"
+                        ],
+                        "Description": [
+                                "produces a 1D array of reals as an output",
+                                "The TD_SMOOTHMA function returns only a primary result set.   There are no secondary or tertiary result sets produced by this function.  ",
+                                "The transformed output series always contains elements that are univariate (in response to a CONTENT(REAL) input, or multivariate (in response to a CONTENT(MULTIVAR_REAL) real numbers.  The data scientist has the choice with regards to the indexing mechanism (ROW_I) to be associated with the output array - OUTPUT_FMT(INDEX_STYLE()). "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "MA",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "CUMULATIVE",
+                                "MEAN",
+                                "MEDIAN",
+                                "EXPONENTIAL"
+                        ],
+                        "Description": [
+                                "enum( CUMULATIVE, MEAN, MEDIAN, EXPONENTIAL) moving average type.  The enumerated value instructs the TD_SMOOTHMA function the type of moving average algorithms to be performed.  Only one MA type can be specified per TD_SMOOTHMA invocation.   It is a required parameter.   ",
+                                "CUMULATIVE - Cumulative Moving Average  - other applicable parameters to CMA: None",
+                                "MEAN - Simple Moving Average -  applicable parameters: M_WINDOW, ONE_SIDED, PAD, WELL_KNOWN,  WEIGHTS.",
+                                "MEDIAN - Simple Moving Median - applicable parameters: WINDOW, PAD.",
+                                "EXPONENTIAL - Exponential Moving Average - applicable parameters: "
+                        ]
+                },
+                {
+                        "Name": "WINDOW",
+                        "Type": "integer",
+                        "Optional": true,
+                        "LowerBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Positive Integer value.  The order (window size) of the moving average to be applied.  Odd numbers use the Simple Moving Average formula.  Even numbers use the Centered Moving Average formula.    Example: a 3-MA would be an order of '3'.   WINDOW(6) with MA(MEAN) uses the Centered Moving average algorithm.",
+                                "WINDOW - only applicable to MA('MEAN') and MA('MEDIAN')."
+                        ]
+                },
+                {
+                        "Name": "ONE_SIDED",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Flag with value of 1 or 0.   ONE_SIDED(1) means that there is no centering.  The last WINDOW entries, inclusive, is averaged to form the current entry.  ONE_SIDED(0) means centering does apply.  This is the default.",
+                                "ONE_SIDED - only applicable to MA('MEAN')."
+                        ]
+                },
+                {
+                        "Name": "LAMBDA",
+                        "Type": "float",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "UpperBoundType": "INCLUSIVE",
+                        "Description": [
+                                "LAMBDA is a float value between 0 and 1, which represents the degree of weighting decrease.  A higher LAMBDA :  λ  has the effect of discounting older observations faster.  ",
+                                "LAMBDA  - only applicable to MA('EXPONENTIAL')."
+                        ],
+                        "LangName": "lambda1"
+                },
+                {
+                        "Name": "WEIGHTS",
+                        "Type": "list",
+                        "ListType": "float",
+                        "ListSize": "WINDOW",
+                        "Optional": true,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "Optional list of weights to be applied when calculating the moving average.  The weights are described as:   ( a-k, ..., ak ).  Where k= (m-1)/2.  The general rule is that the weights should sum up to '1' and should be symmetrical : aj = a-j.   If the weights don’t sum up to '1',  The sum from the list of weights divides each element in the list to get a fraction for each element to achieve the same effect of the sum up to '1'.",
+                                "The number of elements in the WEIGHTS list must match the WINDOW value.   TD_SMOOTHMA uses the number of the WEIGHTS element as the default WINDOW value if it is not specified. ",
+                                "WEIGHTS - only applicable to MA('MEAN').   "
+                        ]
+                },
+                {
+                        "Name": "WELL_KNOWN",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "3MA",
+                                "5MA",
+                                "2x12MA",
+                                "3x3MA",
+                                "3x5MA",
+                                "S15MA",
+                                "S21MA",
+                                "H5MA",
+                                "H9MA",
+                                "H13MA",
+                                "H23MA"
+                        ],
+                        "Description": [
+                                "Enum ('3MA',  '5MA',  '2x12MA','3x3MA', '3x5MA', 'S15MA',  'S21MA', 'H5MA', 'H9MA', 'H13MA',  'H23MA' ) : enumerated value selecting one of the valid supported well known weighted MA combinations to be applied to the input series.  WELL_KNOWN and WEIGHTS must be used in a mutually exclusive fashion.  See Well Known Weighted MA table for details. ",
+                                "WELL_KNOWN - only applicable to SMA only.   ",
+                                "WELL_KNOWN type must have the following WINDOW.   If WINDOW is not specified, TD_SMOOTHMA() provides the value in the chart below.",
+                                "WELLKNOWN -> WINDOW; 3MA, 3X3MA, H5MA -> 5; 3X5MA -> 7; H9MA -> 9; 2X12MA, H13MA -> 13; S15MA -> 15; S21MA -> 21; H23MA -> 23"
+                        ]
+                },
+                {
+                        "Name": "PAD",
+                        "Type": "float",
+                        "Optional": true,
+                        "Description": [
+                                "The produced output series has their magnitudes set to this value for element less than WINDOW.   For example PAD(4.5) is to output a pad value of 4.5 for the series less than WINDOW.",
+                                "PAD - only applicable to MA('MEAN') and MA('MEDIAN')."
+                        ]
+                }
+        ],
+        "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_TRACKINGOP.json

@@ -0,0 +1,101 @@
+{
+        "FuncName": "TD_TRACKINGOP",
+        "FuncDescriptionShort": "Perform Space-Time Analytics",
+        "FuncDescriptionLong": [
+                "Perform Space-Time Analytics"
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "General Utility",
+        "JSONVersion": "1",
+        "FuncRName": "td_Tracking_Op",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "a multivariate series containing object 'tracking' context.  Minimally, the payload contains three fields: an arrival time, a departure time, and a geospatial ST_POINT specifying the location; additionally, the multivariate series may contain any number of auxiliary non-LOB payload fields."
+                        ],
+                        "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",
+                                "ST_GEOMETRYLINESTRING",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_TRACKING 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 table containing the results.",
+                                "The primary result set contains one row per processed 'tracking' series."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [
+                {
+                        "Name": "DISTANCE",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Indicator to calculate the track distance. A value of 1 means to calculate. A value of 0 means do not calculate. Default value is 0."
+                        ]
+                },
+                {
+                        "Name": "SPEED",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Indicator to calculate the average speed with maximum and minimum values. A value of 1 means to calculate. A value of 0 means do not calculate. Default value is 0."
+                        ]
+                },
+                {
+                        "Name": "TIME_SPENT",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Indicator to calculate the total time for the trip. A value of 1 means to calculate. A value of 0 means do not calculate. Default value is 0."
+                        ]
+                },
+                {
+                        "Name": "METRIC",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Indicator to use metric distance and time. A value of 1 means to use kilometers. A value of 0 means to use miles. Default value is 0."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}

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

@@ -0,0 +1,112 @@
+{
+        "FuncName": "TD_UNDIFF",
+        "FuncDescriptionShort": "The Teradata TD_UNDIFF reconstructs a series using a differenced series as input.",
+        "FuncDescriptionLong": [
+                "Because differenced series are series of differences, the reconstruction is simply a cumulative sum of the input values. Which values are summed together is dependent on the lag of the differenced series – for example, if the series was differenced with a lag of 1, then reconstruction each reconstructed value would be a sum of the previous reconstructed value and the corresponding value in the difference series. If the series was differenced with a lag of 2, then it would be a sum of the reconstructed value 2 steps prior, with the corresponding value, and so on. If the series was differenced multiple times, the previous steps would occur that many times, using the partially reconstructed series as input.",
+                "It is important to note that to completely reconstruct the original series, the initial values of the original series must be given. If the series was differenced with lag 1, then the initial value of the original series must be present for a full reconstruction. With a lag of 2, the initial 2 values must be present, and so on. If the series was differenced multiple times, then the initial values of the intermediate steps must be given.",
+                "Reconstruction can be done without initial values, but the output series will not be identical to the original series, merely similar in characteristics."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_UNDIFF",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": ["ART","SERIES"],
+                        "Description": [
+                                "The TD_UNDIFF function takes a differenced series as input "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                },
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "Pass in the undiff series and let function compute initial values"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": true
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "SERIES",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "float"
+                        ],
+                        "Description": [
+                                ".  In its simplest form, the function returns a row index column and an output column, where the output is the result of applying the TD_UNDIFF function against the input series.",
+                                "Invoking this UAF 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": true,
+        "Params": [
+                {
+                        "Name": "LAG",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Zero or Positive Integer value.  References, relative to any time series element, Yt, another time series element located at Yt-LAG .  "
+                        ]
+                },
+                {
+                        "Name": "DIFFERENCES",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Zero or Positive Integer value.  Referenced formula as (1-B^LAG)^DIFFERENCES * Y_t  "
+                        ]
+                },
+                {
+                        "Name": "SEASONAL_MULTIPLIER",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Zero or Positive Integer value.  Computed diff according to it as if SEASONAL_MULTIPLIER is 0 then result is (1-B^LAG)^DIFFERENCES * Y_t, otherwise multiply same result by (1-B)^SEASONAL_MULTIPLIER"
+                        ]
+                },
+                {
+                        "Name": "INITIAL_VALUES",
+                        "Type": "list",
+                        "ListType": "float",
+                        "Optional": true,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "Required parameter if no <orign undiff series> is passed in. When passed in, it is used to provide starting values for the undifferencing operation. As many or as few values can be provided, there is no specified size."
+                        ],
+                        "LangName": "..."
+                }
+        ],
+        "InputFmt": [
+                {
+                        "Name": "INPUT_MODE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "MANY2ONE",
+                                "ONE2ONE",
+                                "MATCH"
+                        ],
+                        "Description": [
+                                "Specifies the input mode supported by the function."
+                        ],
+                        "LangName": "input_fmt_input_mode"
+                }
+        ],
+        "OutputFmt": false
+}

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

@@ -0,0 +1,95 @@
+{
+        "FuncName": "TD_UNNORMALIZE",
+        "FuncDescriptionShort": "provides the data scientist with the ability to 'undo' the seasonal normalization",
+        "FuncDescriptionLong": [
+                "The TD_UNNORMALIZE function is the sister-function for the TD_SEASONALNORMALIZE function.  It provides the data scientist with the ability to “undo” the seasonal normalization which was done during the stationary processing phase of the forecast modelling flow.  The TD_UNNORMALIZE is typically used during the forecasting phase of the modelling flow."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Unnormalize",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "The first input should be SERIES_SPEC wavelets that contains the wavelets of data to be unnormalized"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                },
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "The second input is either a SERIES_SPEC or an ART_SPEC which contains the <mean, standardDeviation> pairs needed to unnormalize the first input SERIES wavelets."
+                        ],
+                        "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",
+                                "input-type"
+                        ],
+                        "Description": [
+                                "The output columns should match the columns of the first input, with the exception that the row axis column is being renamed to ROW_I."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [
+                {
+                        "Name": "FIELDS",
+                        "Type": "list",
+                        "ListType": "integer",
+                        "Optional": true,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "If FIELDS is not specified, all payload fields of the first input needs to be unnormalized.  If it is specified, only the payload fields in the list are unnormalized.",
+                                "The integer values should be 0 or positive values.  The payload field indexes start from 1."
+                        ],
+                        "LangName": "..."
+                }
+        ],
+        "InputFmt": [
+                {
+                        "Name": "INPUT_MODE",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "MANY2ONE",
+                                "ONE2ONE",
+                                "MATCH"
+                        ],
+                        "Description": [
+                                "Specifies the input mode supported by the function."
+                        ],
+                        "LangName": "input_fmt_input_mode"
+                }
+        ],
+        "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_WHITES_GENERAL.json

@@ -0,0 +1,78 @@
+{
+        "FuncName": "TD_WHITES_GENERAL",
+        "FuncDescriptionShort": "This is a statistical test that is performed on behalf of univariate or multivariate regression models",
+        "FuncDescriptionLong": [
+                "The hope in building a univariate or multi-variate regression model is to create a regression model (estimator) that can be characterized as being BLUE: meaning the 'Best Linear Unbiased Estimator'.  One of the properties of such an estimator is that the variance should be homoscedastic, meaning that the variance should be constant.   Variances that are not constant, are said to be heteroscedastic.",
+                "The Whites General (WG) statistical test has an easier implementation and does not require any re-ordering, as the Goldfeld-Quandt test, and is not sensitive to the 'normal distribution assumption', as is the Breusch-Pagan-Godfrey test"
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Whites_General",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This function is executed against the residuals left over after running a regression.  These residuals may either reside within an independent table, or may exist in the form of tertiary results resident within an analytical result table.  The SERIES_SPEC identifies the location and context associated with the residual series.  If the residual series exists as a tertiary result set within an analytical result table, the SERIES_SPEC identifies that location, and the DBS software performs the extraction 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",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_WHITES_GENERAL  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 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": false,
+        "Params": [
+                {
+                        "Name": "VARIABLES_COUNT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "An integer indicating how many explanatory variables (N) are referenced within the PAYLOAD() declaration embedded within the original series specification.  These N explanatory variable are the variables that are to be fed into the auxiliary regression."
+                        ]
+                },
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The significance level used for the test."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}