teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,98 @@
+{
+        "FuncName": "TD_POWERTRANSFORM",
+        "FuncDescriptionShort": "Applies a power transform to a series",
+        "FuncDescriptionLong": [
+                "At its core, this function takes a logical-runtime series - time series or numerically sequenced series - as an input and applies a power transform to the series, producing another series (1D array) as an output.  The passed in logical input series can be either a univariate or multivariate series, in which case the function respectively produces a univariate or multivariate output series.   The data scientist has a choice of preserving the input series indexing mechanism, or even altering it, via the OUTPUT_FMT(INDEX_STYLE()) declaration."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Power_Transform",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "this function takes a logical-runtime series - time series or numerically sequenced series - 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": [
+                                "The TD_POWERTRANSFORM function returns only a primary result set.   There are no secondary or tertiary result sets produced by this function.",
+                                "The produced logical result matrix always contains real number elements.  The data scientist has the choice with regards to the indexing mechanism (ROW_I) to be associated with the output series - 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": "BACK_TRANSFORM",
+                        "Type": "integer",
+                        "Optional": false,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Flag set to 0 or 1.  BACK_TRANSFORM(0) is the default - means the forward transform is to be applied.  BACK_TRANSFORM(1) means the back transform is to be applied."
+                        ]
+                },
+                {
+                        "Name": "P",
+                        "Type": "double",
+                        "Optional": false,
+                        "AllowNaN": false,
+                        "Description": [
+                                "Incoming magnitudes are raised to this power.   Collectively, P and B determine the power function to be applied"
+                        ]
+                },
+                {
+                        "Name": "B",
+                        "Type": "double",
+                        "Optional": false,
+                        "AllowNaN": false,
+                        "Description": [
+                                "Germane for log functions.  The log to be applied. Collectively, P and B determine the power function to be applied"
+                        ]
+                },
+                {
+                        "Name": "LAMBDA",
+                        "Type": "double",
+                        "Optional": false,
+                        "AllowNaN": false,
+                        "Description": [
+                                "Germane for the Box-Cox transformation"
+                        ],
+                        "LangName": "lambda1"
+                }
+        ],
+        "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_RESAMPLE.json

@@ -0,0 +1,194 @@
+{
+        "FuncName": "TD_RESAMPLE",
+        "FuncDescriptionShort": "Interpolating data based on existing data",
+        "FuncDescriptionLong": [
+                "Another classical approach to transforming a time series from an irregular to regular, and/or altering the sampling interval associated with the time series, is to apply a resampling function to the series. Resampling functions generally take as an input: a time series, which can be regular or irregular to begin with; a starting point, aka, 'time-zero'; and a desired target sampling interval.  There are usually multiple choices available to the data scientist as to how the interpolation associated with the sample interval change is going to occur."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Data Preparation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Resample",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "The Teradata rendition of this function takes a logical series, containing any form of regular or irregular series - time series, spatial series, arbitrary numerical series - and applies an interpolation algorithm to transform it into a discrete series with the target start point and target sampling interval.    The input series and the result series both contain real numbers - CONTENT(REAL) or CONTENT(MULTIVAR_REAL)- as their series elements.  In producing the output, the data scientist has a choice of preserving or replacing the series indexing mechanism, via the OUTPUT_FMT(INDEX_STYLE()) declaration.  The default INDEX_STYLE declaration indexes the result series as: OUTPUT_FMT(INDEX_STYLE(FLOW_THROUGH)). "
+                        ],
+                        "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"
+                        ],
+                        "Description": [
+                                "The TD_RESAMPLE 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"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [
+                {
+                        "Name": "SEQUENCE",
+                        "Type": "record",
+                        "Optional": true,
+                        "CheckDuplicates": true,
+                        "Description": [
+                                "Describes the result series that this function is to produce.",
+                                "At least one of TIMECODE or SEQUENCE must be present.",
+                                "Input series must contain an index data type corresponding to SEQUENCE (real, integer, etc.).",
+                                "If SEQUENCE parameter exists then TIMECODE will not work, the two are mutually exclusive parameters."
+                        ],
+                        "LangName": "...",
+                        "NestedParams": [
+                                {
+                                        "Name": "START_VALUE",
+                                        "Type": "float",
+                                        "Optional": true,
+                                        "Description": [
+                                                "Starting value - this is the first sampling index that the resample function is to interpolate"
+                                        ]
+                                },
+                                {
+                                        "Name": "DURATION",
+                                        "Type": "float",
+                                        "Optional": true,
+                                        "Description": [
+                                                "Sampling duration - sampling interval associated with the result series."
+                                        ]
+                                }
+                        ]
+                },
+                {
+                        "Name": "TIMECODE",
+                        "Type": "record",
+                        "Optional": true,
+                        "CheckDuplicates": true,
+                        "Description": [
+                                "Describes the result series that this function is to produce.",
+                                "At least one of TIMECODE or SEQUENCE must be present.",
+                                "Input series must contain an index data type corresponding to TIMECODE (timstampwz, time-duration, etc.).",
+                                "If TIMECODE parameter exists then SEQUENCE will not work, the two are mutually exclusive parameters."
+                        ],
+                        "LangName": "...",
+                        "NestedParams": [
+                                {
+                                        "Name": "START_VALUE",
+                                        "Type": "timestampwz",
+                                        "Optional": true,
+                                        "Description": [
+                                                "Starting value - this is the first sampling index that the resample function is to interpolate"
+                                        ]
+                                },
+                                {
+                                        "Name": "DURATION",
+                                        "Type": "string",
+                                        "Optional": true,
+                                        "Description": [
+                                                "Sampling duration - sampling interval associated with the result series."
+                                        ]
+                                }
+                        ]
+                },
+                {
+                        "Name": "INTERPOLATE",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "LINEAR",
+                                "LAG",
+                                "LEAD",
+                                "WEIGHTED",
+                                "SPLINE"
+                        ],
+                        "Description": [
+                                "enum( LINEAR, LAG, LEAD, WEIGHTED, SPLINE  ) : enumerated value selecting one of the valid supported interpolation strategies."
+                        ]
+                },
+                {
+                        "Name": "WEIGHT",
+                        "Type": "double",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "UpperBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Only required when INTERPOLATE(WEIGHTED) has been selected, otherwise invalid parameter.",
+                                "The interpolated value is calculated as: Y_t  =  Y_{t_LEFT} * (1 - WEIGHT) + (Y-{t_RIGHT} * WEIGHT)"
+                        ]
+                },
+                {
+                        "Name": "SPLINE_PARAMS",
+                        "Type": "record",
+                        "Optional": true,
+                        "CheckDuplicates": true,
+                        "Description": [
+                                "Only valid when INTERPOLATE(SPLINE) has been selected. This is used to specify characteristics of the generated spline. This parameter is optional."
+                        ],
+                        "LangName": "...",
+                        "NestedParams": [
+                                {
+                                        "Name": "METHOD",
+                                        "Type": "string",
+                                        "Optional": true,
+                                        "PermittedValues": [
+                                                "NATURAL",
+                                                "CLAMPED",
+                                                "NOT_A_KNOT"
+                                        ],
+                                        "DefaultValue": "NOT_A_KNOT",
+                                        "Description": [
+                                                "Specifies which kind of spline to be produced. The available types are NATURAL, CLAMPED, and NOT_A_KNOT. This parameter is optional - the default value is NOT_A_KNOT. "
+                                        ]
+                                },
+                                {
+                                        "Name": "yp1",
+                                        "Type": "double",
+                                        "Optional": true,
+                                        "AllowNaN": false,
+                                        "DefaultValue": 0.0,
+                                        "Description": [
+                                                "Only valid when METHOD(CLAMPED) has been specified. Specifies the value of the first derivative for the left boundary condition. This parameter is optional - the default value is 0."
+                                        ]
+                                },
+                                {
+                                        "Name": "ypn",
+                                        "Type": "double",
+                                        "Optional": true,
+                                        "AllowNaN": false,
+                                        "DefaultValue": 0.0,
+                                        "Description": [
+                                                "Only valid when METHOD(CLAMPED) has been specified. Specifies the value of the first derivative for the right boundary condition. This parameter is optional - the default value is 0."
+                                        ]
+                                }
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": [
+                {
+                        "Name": "INDEX_STYLE",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "FLOW_THROUGH",
+                        "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_SAX.json

@@ -0,0 +1,210 @@
+{
+    "FuncName": "TD_SAX",
+    "FuncDescriptionShort": "TD_SAX transform a time series into sequence of symbols.",
+    "FuncDescriptionLong": [
+            "TD_SAX uses Piecewise Aggregate Approximation (PAA) and transform a timeseries into sequence of symbols.",
+            "The symbols can be characters, string, and bitmap."             
+    ],
+    "FunctionVersion": "...",
+    "JSONVersion": "1",
+    "FunctionCategory": "Digital Signal Processing",
+    "FuncRName": "td_SAX",
+    "MaxInputFiles": 1,
+    "Input": [
+        {
+            "Type": "SERIES",
+            "Description": [
+                "Time series whose value can be REAL or MULTIVAR_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>",
+                "float",
+                "float"
+            ],
+            "Description": [
+                "The primary analytical result set contains the SAX representation of the input time series.",
+                "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"
+        }
+    ],
+    "IsPlottable": true,
+    "Params": [
+        {
+            "Name": "WINDOW_TYPE",
+            "Type": "string",
+            "Optional": true,
+            "PermittedValues": [                               
+                "GLOBAL",
+                "SLIDING"
+            ],
+            "DefaultValue": "GLOBAL",
+            "Description": [
+                "[Optional] If not specified, the GLOBAL type is the default.",
+                "Specifies the window type used in the SAX transformation."
+            ]
+        },
+        {
+            "Name": "OUTPUT_TYPE",
+            "Type": "string",
+            "Optional": true,
+            "PermittedValues": [
+                "STRING",
+                "BITMAP",
+                "O_CHARS"
+            ],
+            "DefaultValue": "STRING",
+            "Description": [
+                "[Optional] If not specified, the STRING type is the default.",
+                "The output format of the result can be string, char or bitmap."
+            ]
+        },
+        {
+            "Name": "MEAN",
+            "Type": "list",
+            "ListType": "float",
+            "Optional": true,
+            "CheckDuplicates": false,
+            "Description": [
+                "The global mean values that the function uses to calculate the SAX code for every partition",
+                "If not specified, the function calculates the mean values for every partition.",
+                "If the mean specifies one value and multiple payloads, then the specified value applies to every payload.",
+                "If the mean specifies multiple values, then the specified values apply to the corresponding payloads."
+            ]
+        },
+        {
+            "Name": "STD_DEV",
+            "Type": "list",
+            "ListType": "float",
+            "Optional": true,
+            "CheckDuplicates": false,
+            "Description": [
+                "The global mean values that the function uses to calculate the SAX code for every partition",
+                "If not specified, the function calculates the standard deviation values for every partition.",
+                "If the standard deviation specifies one value and multiple payloads, then the specified value applies to every payload.",
+                "If the standard deviation specifies multiple values, then the specified values apply to the corresponding payloads."
+            ]
+        },
+        {
+            "Name": "WINDOW_SIZE",
+            "Type": "integer",
+            "Optional": true,
+            "LowerBound": 1,
+            "LowerBoundType": "INCLUSIVE",
+            "Description": [
+                "The size of sliding window used in the SAX transformation and maximum value is 64000.",
+                "The window size is required for SLIDING window type."
+            ]
+        },
+        {
+            "Name": "OUTPUT_FREQUENCY",
+            "Type": "integer",
+            "Optional": true,
+            "LowerBound": 1,
+            "DefaultValue": 1,
+            "LowerBoundType": "INCLUSIVE",
+            "Description": [
+                "The number of data points that the window slides between successive outputs.",
+                "This is valid for SLIDING window type."
+            ]
+        },
+        {
+            "Name": "POINTS_PER_SYMBOL",
+            "Type": "integer",
+            "Optional": true,
+            "LowerBound": 1,
+            "DefaultValue": 1,
+            "LowerBoundType": "INCLUSIVE",
+            "Description": [
+                "The number of data points to be converted to one SAX symbol.",
+                "This is valid for GLOBAL window type."
+            ]
+        },
+        {
+            "Name": "SYMBOLS_PER_WINDOW ",
+            "Type": "integer",
+            "Optional": true,
+            "LowerBound": 1,
+            "DefaultValue": 1,
+            "LowerBoundType": "INCLUSIVE",
+            "Description": [
+                "The number of SAX symbols to be generated for each window.",
+                "This is valid for SLIDING window type."
+            ]
+        },
+        {
+            "Name": "ALPHABET_SIZE",
+            "Type": "integer",
+            "Optional": true,
+            "LowerBound": 2,
+            "DefaultValue": 4,
+            "LowerBoundType": "INCLUSIVE",
+            "Description": [
+                "The number of symbols in the SAX alphabet.",
+                "The alphabet consists letters a through t.",
+                "The alphabet size must be [2,20]."
+            ]
+        },
+        {
+            "Name": "BITMAP_LEVEL",
+            "Type": "integer",
+            "Optional": true,
+            "LowerBound": 1,
+            "DefaultValue": 2,
+            "LowerBoundType": "INCLUSIVE",
+            "Description": [
+                "The number of consecutive symbols to be converted to one symbol on a bitmap.",
+                "For bitmap level 1, the bitmap contains the symbols 'a', 'b', 'c', and so on.",
+                "For bitmap level 2, the bitmap contains the symbols 'aa', 'ab', 'ac', and so on.",
+                "The range must be [1,4]."
+            ]
+        },
+        {
+            "Name": "CODE_STATS",
+            "Type": "integer",
+            "Optional": true,
+            "DefaultValue": 0,
+            "PermittedValues": [
+                0, 1
+            ],
+            "Description": [
+                "Indicator that the function prints the mean and standard deviation."
+            ]
+        },
+        {
+            "Name": "BREAKPOINTS    ",
+            "Type": "list",
+            "ListType": "float",
+            "Optional": true,
+            "CheckDuplicates": false,
+            "Description": [
+                "The breakpoints to form the SAX code based on input data."
+            ]
+        }
+    ],
+    "InputFmt":  false,
+    "OutputFmt": [
+        {
+            "Name": "INDEX_STYLE",
+            "Type": "string",
+            "Optional": true,
+            "DefaultValue": "NUMERICAL_SEQUENCE",
+            "PermittedValues": [
+                "NUMERICAL_SEQUENCE"
+            ],
+            "Description": [
+                "Specifies the INDEX_STYLE of the output format."
+            ],
+            "LangName": "output_fmt_index_style"
+        }
+    ]
+}

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

@@ -0,0 +1,143 @@
+{
+        "FuncName": "TD_SEASONALNORMALIZE",
+        "FuncDescriptionShort": "Generates a series has been normalized with respect to its internal period as a season and interval cycles",
+        "FuncDescriptionLong": [
+                "This section outlines the syntax associated with invoking the TD_SEASONALNORMALIZE, 'Seasonal Normalize' table function.    The TD_SEASONALNORMALIZE function takes a logical-runtime series, with real number elements (containing the original series, Xt), as an input, with a SERIES_SPEC(INTERVAL()) and a FUNC_PARAMS(SEASON_CYCLE()) declaration, specifying the season and cycle duration respectively for data normalization.  The function then generates a series having the same number of sample points as the input series, where the generated series has been normalized with respect to its internal period as a season and interval cycles.  The data scientist can then perform a statistical test to see whether or not the generated series is stationary and thus ready to model."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Seasonal_Normalize",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "It takes a logical-runtime series, with real number elements (containing the original series, Xt), 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": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "<varies>",
+                                "big_integer",
+                                "big_integer"
+                        ],
+                        "Description": [
+                                "The primary layer payload contains the computed seasonal normalized values.",
+                                "The primary result set can be accessed either via a subsequent SELECT * FROM <art table> statement or by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTPRIMARY),…) .",
+                                ""
+                        ],
+                        "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": "ARTMETADATA",
+                        "ResultTableColumnTypes": [
+                                "<varies>",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "A second layer ARTMETADATA payload contains the <mean, standardDeviation> for each payload column in the primary layer for a season.  The prefix for the payload column is MEAN_ and SD_.",
+                                "The secondary result set can be accessed by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTMETADATA),…)",
+                                ""
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [
+                {
+                        "Name": "SEASON_CYCLE",
+                        "Type": "record",
+                        "Optional": false,
+                        "CheckDuplicates": true,
+                        "Description": [
+                                "Multiple plots can be specified.  It contains an array of plot entries, separated by comma."
+                        ],
+                        "NestedParams": [
+                                {
+                                        "Name": "CYCLES",
+                                        "Type": "string",
+                                        "Optional": false,
+                                        "PermittedValues": [
+                                                "CAL_YEARS",
+                                                "CAL_MONTHS",
+                                                "CAL_DAYS",
+                                                "WEEKS",
+                                                "DAYS",
+                                                "HOURS",
+                                                "MINUTES",
+                                                "SECONDS",
+                                                "MILLISECONDS",
+                                                "MICROSECONDS"
+                                        ],
+                                        "Description": [
+                                                "The CYCLE is a logical time-unit with one of the enum values: TS_CAL_YEARS, TS_CAL_MONTHS, TS_CAL_DAYS, TS_WEEKS, TS_DAYS,  TS_HOURS, TS_MINUTES, TS_SECONDS,  TS_MILLISECONDS, TS_MICROSECONDS."
+                                        ],
+                                        "LangName": "season_cycle"
+                                },
+                                {
+                                        "Name": "DURATION",
+                                        "Type": "integer",
+                                        "Optional": false,
+                                        "LowerBound": 1,
+                                        "LowerBoundType": "INCLUSIVE",
+                                        "AllowNaN": false,
+                                        "Description": [
+                                                "duration - positive INTEGER",
+                                                "Specifies the number of time-units as the duration of each seasonal cycle."
+                                        ],
+                                        "LangName": "cycle_duration"
+                                }
+                        ]
+                },
+                {
+                        "Name": "SEASON_INFO",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1,
+                                2,
+                                3
+                        ],
+                        "Description": [
+                                "This flag is used to generate additional columns CYCLE_NO and SEASON_NO.",
+                                "SEASON_NO is the season for the data.  The value starts from 1.",
+                                "CYCLE_NO is the n-th cycle of the season.  The value starts from 1.",
+                                "The flag value is between 0 and 3.",
+                                "0 - indicates no extra columns being generated.",
+                                "1 - indicates SEASON_NO column being generated.",
+                                "2 - indicates CYCLE_NO column being generated.",
+                                "3 - indicates both SEASON_NO and CYCLE_NO columns being generated."
+                        ]
+                }
+        ],
+        "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"
+                }
+        ]
+}