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

teradataml/data/jsons/uaf/17.20/{TD_HOLT_WINTERS_FORECAST.json → TD_HOLT_WINTERS_FORECASTER.json}

@@ -162,7 +162,6 @@
                         "Name": "SEASONAL_PERIODS",
                         "Type": "integer",
                         "Optional": true,
-                        "DefaultValue": 1,
                         "LowerBound": 1,
                         "LowerBoundType": "INCLUSIVE",
                         "AllowNaN": false,
@@ -243,13 +242,13 @@
                         "Name": "PREDICTION_INTERVALS",
                         "Type": "string",
                         "Optional": true,
+                        "DefaultValue": "BOTH",
                         "PermittedValues": [
                                 "NONE",
                                 "80",
                                 "95",
                                 "BOTH"
                         ],
-                        "DefaultValue": "BOTH",
                         "Description": [
                                 "Set to either of: 'NONE' or '80' or '95' or 'BOTH'; default is 'BOTH'"
                         ]

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

@@ -65,7 +65,7 @@
                                 "AMPL_PHASE_RADIANS",
                                 "AMPL_PHASE_DEGREES",
                                 "AMPL_PHASE",
-                                "MULTIVAR_COMPLEX",				 
+                                "MULTIVAR_COMPLEX",
                                 "MULTIVAR_AMPL_PHASE_RADIANS",
                                 "MULTIVAR_AMPL_PHASE_DEGREES",
                                 "MULTIVAR_AMPL_PHASE"
@@ -76,20 +76,6 @@
                                 "The default value is dependent on the datatype of the input series; a single var input will generate COMPLEX output CONTENT by default; a multi var input will generate MULTIVAR_COMPLEX output CONTENT by default."
                         ],
                         "LangName": "output_fmt_content"
-                },
-                {
-                        "Name": "ROW_MAJOR",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 1,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "The data scientist may explicity declare whether they want the matrix output in a row-major-centric or column-major-centric manner, via the OUTPUT_FMT(ROW_MAJOR()) construct."
-                        ],
-                        "LangName": "output_fmt_row_major"
                 }
         ]
 }

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

@@ -0,0 +1,162 @@
+{
+        "FuncName": "TD_IDWT",
+        "FuncDescriptionShort": "TD_IDWT is a function that performs inverse discrete wavelet transform (IDWT).",
+        "FuncDescriptionLong": [
+                "TD_IDWT is a function that performs inverse discrete wavelet transform (IDWT)."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Digital Signal Processing",
+        "JSONVersion": "1",
+        "FuncRName": "td_IDWT",
+        "MaxInputFiles": 2,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "Specify the SERIES_SPEC of the series.",
+                                "Multiple payloads are supported, and each payload column is transformed independently.",
+                                "Only REAL or MULTIVAR_REAL payload content types are supported."
+                        ],
+                        "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": [
+                                "[Optional] Specify the SERIES_SPEC of the series. The series specifies the filter.",
+                                "It should have two payload columns corresponding to low and high pass filters.",
+                                "Only MULTIVAR_REAL payload content type is supported."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": true
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "big_integer",
+                                "float",
+                                "<varies>"
+                        ],
+                        "Description": [
+                                "The TD_IDWT function returns only a primary result set."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "WAVELET",
+                        "Type": "string",
+                        "Optional": true,
+                        "Description": [
+                                "Name of the wavelet.",
+                                "If this parameter is specified, then do not include a second input series for the function.",
+                                "If this parameter is not specified, then include a second input series to provide the filter.",
+                                "Data type is case-sensitive.",
+                                "Option families and names are:",
+                                "Daubechies: 'db1' or 'haar', 'db2', 'db3', .... ,'db38'",
+                                "Coiflets: 'coif1', 'coif2', ... , 'coif17'",
+                                "Symlets: 'sym2', 'sym3', ... ,' sym20'",
+                                "Discrete Meyer: 'dmey'",
+                                "Biorthogonal: 'bior1.1', 'bior1.3', 'bior1.5', 'bior2.2', 'bior2.4', 'bior2.6', 'bior2.8', 'bior3.1', 'bior3.3', 'bior3.5', 'bior3.7', 'bior3.9', 'bior4.4', 'bior5.5', 'bior6.8'",
+                                "Reverse Biorthogonal: 'rbio1.1', 'rbio1.3', 'rbio1.5' 'rbio2.2', 'rbio2.4', 'rbio2.6', 'rbio2.8', 'rbio3.1', 'rbio3.3', 'rbio3.5', 'rbio3.7','rbio3.9', 'rbio4.4', 'rbio5.5', 'rbio6.8'"
+                        ]
+                },
+                {
+                        "Name": "MODE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                            "zero",
+                            "symmetric",
+                            "constant",
+                            "smooth",
+                            "periodic",
+                            "periodization",
+                            "reflect",
+                            "antisymmetric",
+                            "antireflect",
+                            "sym",
+                            "symh",
+                            "symw",
+                            "spd",
+                            "sp1",
+                            "sp0",
+                            "zpd",
+                            "ppd",
+                            "per",
+                            "asym",
+                            "asymh",
+                            "asymw"
+                        ],
+                        "DefaultValue": "symmetric",
+                        "Description": [
+                                "Signal extension mode.",
+                                "Data type is case-insensitive.",
+                                "Options are:",
+                                "symmetric, sym, symh",
+                                "reflect, symw",
+                                "smooth, spd, sp1",
+                                "constant, sp0",
+                                "zero, zpd",
+                                "periodic, ppd",
+                                "periodization, per",
+                                "antisymmetric, asym, asymh",
+                                "antireflect, asymw"
+                        ]
+                },
+                {
+                        "Name": "PART",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "a",
+                                "d"
+                        ],
+                        "Description": [
+                                "Indicator that the input is partial decomposition result. Valid values are 'a' or 'd', corresponding to the approximation or the detail of the decomposition result.",
+                                "Data type is case-insensitive."
+                        ]
+                }
+        ],
+        "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] The INDEX_STYLE of the output format is NUMERICAL_SEQUENCE."
+                        ],
+                        "LangName": "output_fmt_index_style"
+                }
+        ]
+}

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

@@ -0,0 +1,149 @@
+{
+        "FuncName": "TD_IDWT2D",
+        "FuncDescriptionShort": "TD_IDWT2D performs inverse discrete wavelet transform (IDWT) for two-dimensional data.",
+        "FuncDescriptionLong": [
+                "TD_IDWT2D performs inverse discrete wavelet transform (IDWT) for two-dimensional data. The algorithm is applied first horizontally by row axis, then vertically by column axis."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Digital Signal Processing",
+        "JSONVersion": "1",
+        "FuncRName": "td_IDWT2D",
+        "MaxInputFiles": 2,
+        "Input": [
+                {
+                        "Type": ["MATRIX", "ART"],
+                        "Description": [
+                                "Specify the MATRIX_SPEC of the matrix.",
+                                "Multiple payloads are supported, and each payload column is transformed independently.",
+                                "Only MULTIVAR_REAL payload content type is supported."
+                        ],
+                        "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": [
+                                "[Optional] Specify the SERIES_SPEC of the series. The series specifies the filter.",
+                                "It should have two payload columns corresponding to low and high pass filters.",
+                                "Only MULTIVAR_REAL payload content type is supported."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": true
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "big_integer",
+                                "float",
+                                "<varies>"
+                        ],
+                        "Description": [
+                                "The TD_IDWT2D function returns only a primary result set."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "WAVELET",
+                        "Type": "string",
+                        "Optional": true,
+                        "Description": [
+                                "Name of the wavelet.",
+                                "If this parameter is specified, then do not include a second input series for the function.",
+                                "If this parameter is not specified, then include a second input series to provide the filter.",
+                                "Data type is case-sensitive.",
+                                "Option families and names are:",
+                                "Daubechies: 'db1' or 'haar', 'db2', 'db3', .... ,'db38'",
+                                "Coiflets: 'coif1', 'coif2', ... , 'coif17'",
+                                "Symlets: 'sym2', 'sym3', ... ,' sym20'",
+                                "Discrete Meyer: 'dmey'",
+                                "Biorthogonal: 'bior1.1', 'bior1.3', 'bior1.5', 'bior2.2', 'bior2.4', 'bior2.6', 'bior2.8', 'bior3.1', 'bior3.3', 'bior3.5', 'bior3.7', 'bior3.9', 'bior4.4', 'bior5.5', 'bior6.8'",
+                                "Reverse Biorthogonal: 'rbio1.1', 'rbio1.3', 'rbio1.5' 'rbio2.2', 'rbio2.4', 'rbio2.6', 'rbio2.8', 'rbio3.1', 'rbio3.3', 'rbio3.5', 'rbio3.7','rbio3.9', 'rbio4.4', 'rbio5.5', 'rbio6.8'"
+                        ]
+                },
+                {
+                        "Name": "MODE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                            "zero",
+                            "symmetric",
+                            "constant",
+                            "smooth",
+                            "periodic",
+                            "periodization",
+                            "reflect",
+                            "antisymmetric",
+                            "antireflect",
+                            "sym",
+                            "symh",
+                            "symw",
+                            "spd",
+                            "sp1",
+                            "sp0",
+                            "zpd",
+                            "ppd",
+                            "per",
+                            "asym",
+                            "asymh",
+                            "asymw"
+                        ],
+                        "DefaultValue": "symmetric",
+                        "Description": [
+                                "Signal extension mode.",
+                                "Data type is case-insensitive.",
+                                "Options are:",
+                                "symmetric, sym, symh",
+                                "reflect, symw",
+                                "smooth, spd, sp1",
+                                "constant, sp0",
+                                "zero, zpd",
+                                "periodic, ppd",
+                                "periodization, per",
+                                "antisymmetric, asym, asymh",
+                                "antireflect, asymw"
+                        ]
+                }
+        ],
+        "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] The INDEX_STYLE of the output format is NUMERICAL_SEQUENCE."
+                        ],
+                        "LangName": "output_fmt_index_style"
+                }
+        ]
+}

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

@@ -0,0 +1,117 @@
+{
+        "FuncName": "TD_IQR",
+        "FuncDescriptionShort": "TD_IQR uses interquartile range for anomaly detection.",
+        "FuncDescriptionLong": [
+                "Anomaly detection identifies data points, events and observations that deviate from the normal behavior of the data set.",
+                "Anomalous data can indicate critical incidents, such as a change in consumer behavior or observations that are suspicious.",
+                "Anomalies in data are also called standard deviations, outliers, noise, novelties, and exceptions.",
+                "TD_IQR uses interquartile range for anomaly detection.",
+                "Any data point that falls outside of 1.5 times of an interquartile range below the first quartile and above the third quartile is considered an outlier.",
+                "The TD_IQR function creates a two-layered ART table."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Anomaly Detection",
+        "JSONVersion": "1",
+        "FuncRName": "td_IQR",
+        "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": [
+                                "VARCHAR",
+                                "<varies>",
+                                "<varies>",
+                                "integer"
+                        ],
+                        "Description": [
+                                "The primary result set contains the list of anomaly data points.",
+                                "The primary result set is accessed using a SELECT statement."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                },
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": false,
+                        "LayerName": "ARTSTATSDATA",
+                        "ResultTableColumnTypes": [
+                                "integer"
+                        ],
+                        "Description": [
+                                "The secondary result set contains the number of anomalies.",
+                                "The secondary is accessed using the TD_EXTRACT_RESULTS utility function."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                },
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": false,
+                        "LayerName": "ARTFITMETADATA",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "integer",
+                                "integer",
+                                "float"
+                        ],
+                        "Description": [
+                                "The RETURNS TABLE for this optional analytical result set, containing “goodness of fit” metadata, is described in this subsection.   This result set is generated in response to the FUNC_PARAMS (FIT_METRICS(1) having a passed in flag value of '1'.   The result set can be retrieved by invoking the TD_EXTRACT_RESULTS function against the analytical result table containing the metadata. This result set will be deposited into LAYER1 under the name ARTFITMETADATA.",
+                                "There is one result row returned for each unique series acted upon. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name" : "STAT_METRICS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Indicator for secondary layer to give the number of outliers."
+                        ]
+                }
+        ],
+        "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_LINEAR_REGR.json

@@ -38,7 +38,7 @@
                         "Description": [
                                 "The TD_LINEAR_REGR function can produce a multilayered ART table result. Invoking this UAF function generates up to three analytical result sets: a primary analytical result set containing the calculated coefficients, and one or two auxiliary result sets - one containing model statistics and the other containing residual context.   ",
                                 "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"
                 },
                 {

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

@@ -92,7 +92,7 @@
                         "Type": "float",
                         "Optional": true,
                         "LowerBound": 0,
-                        "LowerBoundType": "INCLUSIVE",
+                        "LowerBoundType": "EXCLUSIVE",
                         "Description": [
                                 "Optional Parameter.  Only valid with a FREQ_STYLE(K_HERTZ).  A 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."
                         ]

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

@@ -26,7 +26,6 @@
                         "PrimaryLayer": true,
                         "LayerName": "ARTPRIMARY",
                         "ResultTableColumnTypes": [
-
                                 "<varies>",
                                 "float",
                                 "float",
@@ -51,7 +50,6 @@
                                 "float"
                         ],
                         "Description": [
-
                                 "The RETURNS TABLE for this optional analytical result set is described in this subsection.   This result set is generated in response to the FUNC_PARAMS( RESIDUALS(1)) having a passed in flag value of '1'.   The result set can be retrieved by invoking the TD_EXTRACT_RESULTS function against the analytical result table containing the metadata. This result set will be deposited into LAYER1 under the name ARTFITRESIDUALS."
                         ],
                         "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
@@ -134,7 +132,7 @@
                         "LowerBoundType": "INCLUSIVE",
                         "AllowNaN": false,
                         "Description": [
-                                "Only apply to MA, moving average forecast.  must be between 1 to 32000."
+                                "Only used with ALGORITHM(MA), and required, moving average forecast.  must be between 1 to 32000."
                         ]
                 },
                 {