teradataml 20.0.0.0__py3-none-any.whl → 20.0.0.2__py3-none-any.whl

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

@@ -0,0 +1,209 @@
+{
+        "FuncName": "TD_MATRIX2IMAGE",
+        "FuncDescriptionShort": "TD_MATRIX2IMAGE converts a matrix to an image.",
+        "FuncDescriptionLong": [
+                "The conversion produces an image using color maps.",
+                "The color image produced by TD_MATRIX2IMAGE is limited to 8-bit color depth.",
+                "In previous versions, TD_PLOT with MESH option was used to convert a matrix to an image. TD_PLOT is limited to a single payload.",
+                "TD_MATRIX2IMAGE can combine three payloads to create RGB color images."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "General Utility",
+        "JSONVersion": "1",
+        "FuncRName": "td_Matrix_2_Image",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "MATRIX",
+                        "Description": [
+                                "The TD_MATRIX2IMAGE function takes matrixes or ART as input.",
+                                "These series may have real numbers or multivariate reals (vector of real numbers) as their individual elements.",
+                                "These logical series can be regular or irregular.",
+                                "Their indexing can be based on integer or float data types."
+                        ],
+                        "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": [
+                                "big_integer",
+                                "big_integer",
+                                "blob"
+                        ],
+                        "Description": [
+                                "The TD_MATRIX2IMAGE function returns a primary result set without additional layers."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "IMAGE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "PNG",
+                                "JPG"
+                        ],
+                        "DefaultValue": "PNG",
+                        "Description": [
+                                "[Optional] The image output format. It can be PNG or JPG. The default is PNG."
+                        ]
+                },
+                {
+                        "Name": "TYPE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "GRAY",
+                                "RGB",
+                                "COLORMAP"
+                        ],
+                        "Description": [
+                                "[Optional] The type of the image.",
+                                "It can be GRAY, RGB or COLORMAP.",
+                                "GRAY has a single payload, the output image is a gray scale image.",
+                                "RGB has three payloads corresponding to RED, GREEN and BLUE channels, the output image is a RGB color image.",
+                                "COLORMAP has a single payload. The output image is a RGB color image.",
+                                "If there is a single payload, then the default type is GRAY.",
+                                "If there are three payloads, then the default type is RGB."
+                        ]
+                },
+                {
+                        "Name": "COLORMAP",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "viridis",
+                        "Description": [
+                                "[Optional] The colormap to use when the TYPE is COLORMAP.",
+                                "The values corresponds to the COLORMAP of TD_PLOT.",
+                                "If not specified, then the default colormap is viridis.",
+                                "The value is case-sensitive."
+                        ]
+                },
+                {
+                        "Name": "RANGE",
+                        "Type": "list",
+                        "ListType": "double",
+                        "ListSize": 2,
+                        "Optional": true,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "[Optional] The range of the single payload value to be scaled.",
+                                "By default, the MIN and MAX values of the payload are used as the range.",
+                                "Used when TYPE is GRAY or COLORMAP."
+                        ]
+                },
+                {
+                        "Name": "RED",
+                        "Type": "list",
+                        "ListType": "double",
+                        "ListSize": 2,
+                        "Optional": true,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "[Optional] The range of the first payload value.",
+                                "By default, the MIN and MAX values of the payload are used as the range.",
+                                "It is only used when TYPE is RGB."
+                        ]
+                },
+                {
+                        "Name": "GREEN",
+                        "Type": "list",
+                        "ListType": "double",
+                        "ListSize": 2,
+                        "Optional": true,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "[Optional] The range of the second payload value.",
+                                "By default, the MIN and MAX values of the payload are used as the range.",
+                                "It is only used when TYPE is RGB."
+                        ]
+                },
+                {
+                        "Name": "BLUE",
+                        "Type": "list",
+                        "ListType": "double",
+                        "ListSize": 2,
+                        "Optional": true,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "[Optional] The range of the third payload value.",
+                                "By default, the MIN and MAX values of the payload are used as the range.",
+                                "It is only used when TYPE is RGB."
+                        ]
+                },
+                {
+                        "Name": "FLIPX",
+                        "Type": "integer",
+                        "Optional": true,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "[Optional] Indicator to flip the image horizontally.",
+                                "A value of 1 means flip the image.",
+                                "A value of 0 means do not flip the image."
+                        ],
+                        "LangName": "flip_x"
+                },
+                {
+                        "Name": "FLIPY",
+                        "Type": "integer",
+                        "Optional": true,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "[Optional] Indicator to flip the image vertically.",
+                                "A value of 1 means flip the image.",
+                                "A value of 0 means do not flip the image."
+                        ],
+                        "LangName": "flip_y"
+                }
+        ],
+        "InputFmt": [
+                {
+                        "Name": "INPUT_MODE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "MANY2ONE",
+                                "ONE2ONE",
+                                "MATCH"
+                        ],
+                        "Description": [
+                                "When there are two input series, then the INPUT_FMT specification is mandatory.",
+                                "[Optional] The INPUT_MODE parameter has the following options:",
+                                "ONE2ONE: Both the primary and secondary series specifications contain a series name which identifies the two series in the function.",
+                                "MANY2ONE: The MANY specification is the primary series declaration. The secondary series specification contains a series name that identifies the single secondary series.",
+                                "MATCH: Both series are defined by their respective SERIES_SPEC(INSTANCE_NAME()) declarations."
+                        ],
+                        "LangName": "input_fmt_input_mode"
+                }
+        ],
+        "OutputFmt": [
+                {
+                        "Name": "INDEX_STYLE",
+                        "Type": "string",
+                        "Optional": true,
+                        "DefaultValue": "NUMERICAL_SEQUENCE",
+                        "PermittedValues": [
+                                "NUMERICAL_SEQUENCE"
+                        ],
+                        "Description": [
+                                "[Optional] Specify the INDEX_STYLE of the output format.",
+                                "Option is NUMERICAL_SEQUENCE."
+                        ],
+                        "LangName": "output_fmt_index_style"
+                }
+        ]
+}

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

@@ -2,7 +2,7 @@
         "FuncName": "TD_PACF",
         "FuncDescriptionShort": "Computes the Partial Auto Correlation function of a series",
         "FuncDescriptionLong": [
-                "the TD_PACF, Partial Auto Correlation function, can be passed either a discrete series - time or spatial series (INPUT_TYPE(DATA_SERIES)) - as an input; or, alternatively, can be passed a series containing previously computed Auto Correlation coefficients - lag and magnitude (INPUT_TYPE(ACF)).   The passed in logical-runtime series is permitted to have elements which are either univariate or multivariate reals. Each input series produces a result series, which is indexed on 'LAG', and containing univariate or multivariate real number magnitudes as it result series elements.  This function provides the ability to generate 'on-demand' plots.  The generated plots can be either univariate, multivariate, or composite in nature. The chosen implementation’s output and style specification closely match Matplotlib ( https://matplotlib.org/ ), an extremely popular Python plotting library. The primary purpose for this decision is to jump start existing Matplotlib users into TD_PLOT usage.  However, the Teradata implementation is a completely independent and separate one based on C/C++."
+                "the TD_PACF, Partial Auto Correlation function, can be passed either a discrete series - time or spatial series (INPUT_TYPE(DATA_SERIES)) - as an input; or, alternatively, can be passed a series containing previously computed Auto Correlation coefficients - lag and magnitude (INPUT_TYPE(ACF)).   The passed in logical-runtime series is permitted to have elements which are either univariate or multivariate reals. Each input series produces a result series, which is indexed on 'LAG', and containing univariate or multivariate real number magnitudes as it result series elements."
         ],
         "FunctionVersion": "...",
         "FunctionCategory": "Model Preparation and Parameter Estimation",
@@ -111,4 +111,4 @@
         ],
         "InputFmt": false,
         "OutputFmt": false
-}
+}

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

@@ -59,7 +59,7 @@
                         "Type": "float",
                         "Optional": true,
                         "LowerBound": 0,
-                        "LowerBoundType": "INCLUSIVE",
+                        "LowerBoundType": "EXCLUSIVE",
                         "Description": [
                                 "Floating point constant representing the sample rate, in hertz.  A value of 10000.0 means that the sample points were obtained by sampling at a rate of 10,000 hertz."
                         ]
@@ -87,13 +87,13 @@
                                 "FOURIER",
                                 "INCRFOURIER"
                         ],
-						"Description": [
+                        "Description": [
                                 "ALGORITHM('AUTOCOV') - Use the Fourier Cosine of the Auto covariance approach to calculate power spectrum",
                                 "ALGORITHM('AUTOCORR') - Use the Fourier Cosine of the Auto correlation approach to calculate power spectrum",
                                 "ALGORITHM('FOURIER') - Use the Fourier Transform approach to calculate power spectrum",
                                 "ALGORITHM('INCRFOURIER') - Use the Incremental Fourier Transform approach to calculate power spectrum"
                         ]
-                 },
+                },
                 {
                         "Name": "INCRFOURIER_PARAM",
                         "Type": "record",
@@ -146,7 +146,7 @@
                                                 "PARZEN",
                                                 "WELCH"
                                         ],
-										"Description": [
+                                        "Description": [
                                                 "WINDOW('NONE') - Do not apply a smoothing window.  Theoretically this translates into the application of a square wave window, which has a magnitude of '1.0' for the whole duration of the window.",
                                                 "WINDOW_NAME('TUKEY') - Apply a Tukey smoothing window with the supplied alpha value",
                                                 "WINDOW_NAME ('BARTLETT') - Apply a Bartlett smoothing window",
@@ -172,4 +172,4 @@
         ],
         "InputFmt": false,
         "OutputFmt": false
-}
+}

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

@@ -36,60 +36,64 @@
         ],
         "IsPlottable": false,
         "Params": [
-                  {
-                        "Name": "TIMECODE",
+                {
+                        "Name": "SEQUENCE",
                         "Type": "record",
-                        "Optional": false,
+                        "Optional": true,
                         "CheckDuplicates": true,
-                        "LangName": "...",
                         "Description": [
-                                "Describes the result series that this function is to produce. At least one of TIMECODE or SEQUENCE must be present, and must correspond correctly to the index data type of the input series. They are mutually exclusive."
+                                "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."
                         ],
-                        "NestedParams":
-                        [
+                        "LangName": "...",
+                        "NestedParams": [
                                 {
                                         "Name": "START_VALUE",
-                                        "Type": "timestampwz",
+                                        "Type": "float",
                                         "Optional": true,
                                         "Description": [
-                                                "Specifies the first sampling index to interpolate."
+                                                "Starting value - this is the first sampling index that the resample function is to interpolate"
                                         ]
                                 },
                                 {
                                         "Name": "DURATION",
-                                        "Type": "string",
+                                        "Type": "float",
                                         "Optional": true,
                                         "Description": [
-                                               "Specifies the sampling interval associated with the result series."
+                                                "Sampling duration - sampling interval associated with the result series."
                                         ]
                                 }
                         ]
                 },
                 {
-                        "Name": "SEQUENCE",
+                        "Name": "TIMECODE",
                         "Type": "record",
-                        "Optional": false,
+                        "Optional": true,
                         "CheckDuplicates": true,
-                        "LangName": "...",
                         "Description": [
-                                "Describes the result series that this function is to produce. At least one of TIMECODE or SEQUENCE must be present, and must correspond correctly to the index data type of the input series. They are mutually exclusive."
+                                "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."
                         ],
-                        "NestedParams" :
-                        [
+                        "LangName": "...",
+                        "NestedParams": [
                                 {
-                                        "Name" : "START_VALUE",
-                                        "Type" : "float",
-                                        "Optional" : true,
+                                        "Name": "START_VALUE",
+                                        "Type": "timestampwz",
+                                        "Optional": true,
                                         "Description": [
-                                                "Specifies the first sampling index to interpolate."
+                                                "Starting value - this is the first sampling index that the resample function is to interpolate"
                                         ]
                                 },
                                 {
-                                        "Name" : "DURATION",
-                                        "Type" : "float",
-                                        "Optional" : true,
+                                        "Name": "DURATION",
+                                        "Type": "string",
+                                        "Optional": true,
                                         "Description": [
-                                                "Specifies the sampling interval associated with the result series."
+                                                "Sampling duration - sampling interval associated with the result series."
                                         ]
                                 }
                         ]
@@ -106,7 +110,7 @@
                                 "SPLINE"
                         ],
                         "Description": [
-                                "enum( NONE, LINEAR, LAG, LEAD, WEIGHTED, SPLINE  ) : enumerated value selecting one of the valid supported interpolation strategies."
+                                "enum( LINEAR, LAG, LEAD, WEIGHTED, SPLINE  ) : enumerated value selecting one of the valid supported interpolation strategies."
                         ]
                 },
                 {
@@ -119,7 +123,8 @@
                         "UpperBoundType": "INCLUSIVE",
                         "AllowNaN": false,
                         "Description": [
-                                "Only valid when INTERPOLATE(WEIGHTED) has been selected.   The interpolated value is calculated as: Y_t  =  Y_{t_LEFT} * (1 - WEIGHT) + (Y-{t_RIGHT} * WEIGHT)"
+                                "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)"
                         ]
                 },
                 {
@@ -170,5 +175,20 @@
                 }
         ],
         "InputFmt": false,
-        "OutputFmt": 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,208 @@
+{
+    "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"
+            ],
+            "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"
+            ],
+            "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"
+        }
+    ]
+}