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

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

@@ -1,174 +1,174 @@
-{
-        "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": "TIMECODE",
-                        "Type": "record",
-                        "Optional": false,
-                        "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."
-                        ],
-                        "NestedParams":
-                        [
-                                {
-                                        "Name": "START_VALUE",
-                                        "Type": "timestampwz",
-                                        "Optional": true,
-                                        "Description": [
-                                                "Specifies the first sampling index to interpolate."
-                                        ]
-                                },
-                                {
-                                        "Name": "DURATION",
-                                        "Type": "string",
-                                        "Optional": true,
-                                        "Description": [
-                                               "Specifies the sampling interval associated with the result series."
-                                        ]
-                                }
-                        ]
-                },
-                {
-                        "Name": "SEQUENCE",
-                        "Type": "record",
-                        "Optional": false,
-                        "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."
-                        ],
-                        "NestedParams" :
-                        [
-                                {
-                                        "Name" : "START_VALUE",
-                                        "Type" : "float",
-                                        "Optional" : true,
-                                        "Description": [
-                                                "Specifies the first sampling index to interpolate."
-                                        ]
-                                },
-                                {
-                                        "Name" : "DURATION",
-                                        "Type" : "float",
-                                        "Optional" : true,
-                                        "Description": [
-                                                "Specifies the sampling interval associated with the result series."
-                                        ]
-                                }
-                        ]
-                },
-                {
-                        "Name": "INTERPOLATE",
-                        "Type": "string",
-                        "Optional": false,
-                        "PermittedValues": [
-                                "LINEAR",
-                                "LAG",
-                                "LEAD",
-                                "WEIGHTED",
-                                "SPLINE"
-                        ],
-                        "Description": [
-                                "enum( NONE, 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 valid when INTERPOLATE(WEIGHTED) has been selected.   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": false
+{
+        "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": "TIMECODE",
+                        "Type": "record",
+                        "Optional": false,
+                        "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."
+                        ],
+                        "NestedParams":
+                        [
+                                {
+                                        "Name": "START_VALUE",
+                                        "Type": "timestampwz",
+                                        "Optional": true,
+                                        "Description": [
+                                                "Specifies the first sampling index to interpolate."
+                                        ]
+                                },
+                                {
+                                        "Name": "DURATION",
+                                        "Type": "string",
+                                        "Optional": true,
+                                        "Description": [
+                                               "Specifies the sampling interval associated with the result series."
+                                        ]
+                                }
+                        ]
+                },
+                {
+                        "Name": "SEQUENCE",
+                        "Type": "record",
+                        "Optional": false,
+                        "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."
+                        ],
+                        "NestedParams" :
+                        [
+                                {
+                                        "Name" : "START_VALUE",
+                                        "Type" : "float",
+                                        "Optional" : true,
+                                        "Description": [
+                                                "Specifies the first sampling index to interpolate."
+                                        ]
+                                },
+                                {
+                                        "Name" : "DURATION",
+                                        "Type" : "float",
+                                        "Optional" : true,
+                                        "Description": [
+                                                "Specifies the sampling interval associated with the result series."
+                                        ]
+                                }
+                        ]
+                },
+                {
+                        "Name": "INTERPOLATE",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "LINEAR",
+                                "LAG",
+                                "LEAD",
+                                "WEIGHTED",
+                                "SPLINE"
+                        ],
+                        "Description": [
+                                "enum( NONE, 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 valid when INTERPOLATE(WEIGHTED) has been selected.   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": false
 }

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

@@ -1,137 +1,137 @@
-{
-        "FuncName": "TD_SEASONALNORMALIZE",
-        "FuncDescriptionShort": "Generates a series has been normalized with respect to its internal period as a season and interval cycles",
-        "FuncDescriptionLong": [
-                "The function SeasonalNormalize() takes a non-stationary series and normalizes the series by removing the unit roots. The function can be used with any cyclic data that can be subdivided into a collection of logical periods, in which each period can be further subdivided into a collection of logical intervals."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Model Preparation and Parameter Estimation",
-        "JSONVersion": "1",
-        "FuncRName": "td_Seasonal_Normalize",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": "SERIES",
-                        "Description": [
-                                "Specifies a logical-runtime series, with real number elements."
-                        ],
-                        "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(ARTFITMETADATA),…)",
-                                ""
-                        ],
-                        "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": [
-                                "Specifies whether to generate additional columns CYCLE_NO and SEASON_NO. CYCLE_NO is the n-th cycle of the season. SEASON_NO is the season for the data."
-                        ]
-                }
-        ],
-        "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"
-                }
-        ]
+{
+        "FuncName": "TD_SEASONALNORMALIZE",
+        "FuncDescriptionShort": "Generates a series has been normalized with respect to its internal period as a season and interval cycles",
+        "FuncDescriptionLong": [
+                "The function SeasonalNormalize() takes a non-stationary series and normalizes the series by removing the unit roots. The function can be used with any cyclic data that can be subdivided into a collection of logical periods, in which each period can be further subdivided into a collection of logical intervals."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Seasonal_Normalize",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "Specifies a logical-runtime series, with real number elements."
+                        ],
+                        "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(ARTFITMETADATA),…)",
+                                ""
+                        ],
+                        "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": [
+                                "Specifies whether to generate additional columns CYCLE_NO and SEASON_NO. CYCLE_NO is the n-th cycle of the season. SEASON_NO is the season for the data."
+                        ]
+                }
+        ],
+        "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"
+                }
+        ]
 }