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

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

@@ -1,67 +1,67 @@
-{
-        "FuncName": "TD_MINFO",
-        "FuncDescriptionShort": "Used to return metadata describing the logical matrix",
-        "FuncDescriptionLong": [
-                "The TD_MINFO, 'Matrix Information', function is an AF Utility function used to return metadata describing the logical matrix identified by the MATRIX_SPEC specification passed into the function.  For each matrix this function returns:",
-                "Matrix Row/Column Index Data type - TIMESTAMP, TIMESTAMP WITH TIME ZONE, DATE, INTEGER, or FLOAT",
-                "Starting Row/Column Index value associated with the matrix ",
-                "Ending Row/Column Index value associated with the matrix ",
-                "Count of total number of entries for Row/Column Index",
-                "Flag indicating whether the matrix is regular or irregular along Row/Column Index",
-                "Row/Column Index Sample interval - row/column index sample interval associated with a discrete row/column index; or, alternatively, average of all row/column index sample intervals encountered, if it has an irregular row/column index.",
-                "Content Type of  payload “fields” - REAL, COMPLEX, AMPL_PHASE_RADIANS, AMPL_PHASE_DEGREES, MULTIVAR_REAL, MULTIVAR_COMPLEX, MULTIVAR_AMPL_PHASE_RADIANS, or MULTIVAR_AMPL_PHASE_DEGREES",
-                "For each payload “fields” entry: Minimum sample magnitude encountered in matrix; Maximum sample magnitude encountered in matrix; Average of all magnitudes encountered in matrix",
-                "Count of total number of null value in all the result payload fields.",
-                "Flag indicating whether the matrix is malformed or well input matrix."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "General Utility",
-        "JSONVersion": "1",
-        "FuncRName": "td_MInfo",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": "MATRIX",
-                        "Description": [
-                                "This AF function is passed a collection of logical matrices described by a matrix specification, MATRIX_SPEC. These logical matrices can be of either the regular or irregular variety.  Their indexing mechanisms can be based on time or space"
-                        ],
-                        "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": [
-                                "char(40) ",
-                                "varies",
-                                "varies",
-                                "float",
-                                "integer",
-                                "varchar(60)",
-                                "varchar(40)",
-                                "varies",
-                                "varies",
-                                "integer",
-                                "integer",
-                                "varchar(60)",
-                                "varchar(20)",
-                                "list<N, float>",
-                                "list<N, float>",
-                                "list<N, float>",
-                                "integer",
-                                "varchar(50)"
-                        ],
-                        "Description": [
-                                "Invoking this AF utility function generates only a primary analytical result set. There are no secondary or other results generated. The primary result set can be accessed via a subsequent SELECT statement issued against the analytical result table. "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": false,
-        "Params": [],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_MINFO",
+        "FuncDescriptionShort": "Used to return metadata describing the logical matrix",
+        "FuncDescriptionLong": [
+                "The TD_MINFO, 'Matrix Information', function is an AF Utility function used to return metadata describing the logical matrix identified by the MATRIX_SPEC specification passed into the function.  For each matrix this function returns:",
+                "Matrix Row/Column Index Data type - TIMESTAMP, TIMESTAMP WITH TIME ZONE, DATE, INTEGER, or FLOAT",
+                "Starting Row/Column Index value associated with the matrix ",
+                "Ending Row/Column Index value associated with the matrix ",
+                "Count of total number of entries for Row/Column Index",
+                "Flag indicating whether the matrix is regular or irregular along Row/Column Index",
+                "Row/Column Index Sample interval - row/column index sample interval associated with a discrete row/column index; or, alternatively, average of all row/column index sample intervals encountered, if it has an irregular row/column index.",
+                "Content Type of  payload “fields” - REAL, COMPLEX, AMPL_PHASE_RADIANS, AMPL_PHASE_DEGREES, MULTIVAR_REAL, MULTIVAR_COMPLEX, MULTIVAR_AMPL_PHASE_RADIANS, or MULTIVAR_AMPL_PHASE_DEGREES",
+                "For each payload “fields” entry: Minimum sample magnitude encountered in matrix; Maximum sample magnitude encountered in matrix; Average of all magnitudes encountered in matrix",
+                "Count of total number of null value in all the result payload fields.",
+                "Flag indicating whether the matrix is malformed or well input matrix."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "General Utility",
+        "JSONVersion": "1",
+        "FuncRName": "td_MInfo",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "MATRIX",
+                        "Description": [
+                                "This AF function is passed a collection of logical matrices described by a matrix specification, MATRIX_SPEC. These logical matrices can be of either the regular or irregular variety.  Their indexing mechanisms can be based on time or space"
+                        ],
+                        "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": [
+                                "char(40) ",
+                                "varies",
+                                "varies",
+                                "float",
+                                "integer",
+                                "varchar(60)",
+                                "varchar(40)",
+                                "varies",
+                                "varies",
+                                "integer",
+                                "integer",
+                                "varchar(60)",
+                                "varchar(20)",
+                                "list<N, float>",
+                                "list<N, float>",
+                                "list<N, float>",
+                                "integer",
+                                "varchar(50)"
+                        ],
+                        "Description": [
+                                "Invoking this AF utility function generates only a primary analytical result set. There are no secondary or other results generated. The primary result set can be accessed via a subsequent SELECT statement issued against the analytical result table. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [],
+        "InputFmt": false,
+        "OutputFmt": false
 }

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

@@ -1,179 +1,179 @@
-{
-        "FuncName": "TD_MULTIVAR_REGR",
-        "FuncDescriptionShort": "Multivariate linear regression is about fitting the observed data to some multidimensional surface",
-        "FuncDescriptionLong": [
-                "Multivariate linear regression is about fitting the observed data to some multidimensional surface - a formula is postulated which purportedly defines how an explanatory variable is related to a response variable.   The response variable being the 'observed result/response' that the scientist hopes to model with the formula and the set of explanatory variables being the variables, which in conjunction with the formula, can be used to 'explain' the result.  "
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Model Preparation and Parameter Estimation",
-        "JSONVersion": "1",
-        "FuncRName": "td_Multivar_Regr",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": "SERIES",
-                        "Description": [
-                                "a multivariate series - with the first payload field representing the response variable and the remainder of the payload fields representing the explanatory variables - as input"
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-                                "integer",
-                                "varchar(120)",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "varchar(40)",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-                                "The TD_MULTIVAR_REGR function can create a multilevel ART table.  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"
-                },
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": false,
-                        "LayerName": "ARTFITMETADATA",
-                        "ResultTableColumnTypes": [
-                                "float",
-                                "integer",
-                                "float",
-                                "float",
-                                "float",
-                                "integer",
-                                "integer",
-                                "float"
-                        ],
-                        "Description": [
-                                "The secondary result set can be accessed by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTFITMETADATA),…)",
-                                "This result set is generated in response to the FUNC_PARAMS MODEL_STATS(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 deposited in LAYER1 under the name ARTFITMETADATA."
-                        ],
-                        "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": "ARTFITRESIDUALS",
-                        "ResultTableColumnTypes": [
-                                "integer",
-                                "column<N, float>",
-                                "float",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-                                "The tertiary result set can be accessed by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTFITRESIDUALS),…)",
-                                "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.  This result set will be deposited in LAYER2 under the name ARTFITRESIDUALS.'1'.   The result set can be retrieved by invoking the TD_EXTRACT_RESULTS function against the analytical result table containing the metadata. This will be deposited in LAYER2, under the name ARTFITRESIDUALS. "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-                {
-                        "Name": "VARIABLES_COUNT",
-                        "Type": "integer",
-                        "Optional": false,
-                        "LowerBound": 3,
-                        "LowerBoundType": "INCLUSIVE",
-                        "Description": [
-                                "An integer indicating that 1 response variable and (N-1) explanatory variables are referenced within the <multivar-series-specification>.  The first series is always the response variable series 'Y'; the next N-1 series are the explanatory variable series named - X1, X2,  XN-1 ."
-                        ]
-                },
-                {
-                        "Name": "WEIGHTS",
-                        "Type": "integer",
-                        "Optional": false,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                " A zero (0) or one (1) integer value.  A flag indicating that the N+1 series referenced within the  <multivar-series-specification> is the weight series.  This series is to be interpreted as a series of weights that can be used to perform a weighted least squares regression solution."
-                        ]
-                },
-                {
-                        "Name": "FORMULA",
-                        "Type": "<td_formula>",
-                        "Optional": false,
-                        "Description": [
-                                "A Teradata formula string that defines the formula that is to be used in the regression operation.  As an example consider: FORMULA(Y = c + a*x1+ b*(exp(x1)*cos(x1))); in which Y is the response variable; x1 is the explanatory variable; and, a, b, and c are the coefficients that the regression is to determine.  See the Teradata Formula String subsection within the TD_GENSERIES4FUNC function section for additional information.  Note: The name of the response variable must always be Y; and, the name of the explanatory variable must always be X1.   User is free to name the coefficients whatever they wish."
-                        ]
-                },
-                {
-                        "Name": "ALGORITHM",
-                        "Type": "string",
-                        "Optional": false,
-                        "Description": [
-                                "Implementation method name.    A value of 'QR' , ALGORITHM (QR), means that QR decomposition is to be employed.  A value of 'PSI', ALGORITHM (PSI),  means that pseudo-inverse based on SVD is to be used to solve the regression."
-                        ]
-                },
-                {
-                        "Name": "COEFF_STATS",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 0,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "A zero (0) or one (1) integer value.  A flag indicating that the optional coefficient statistical columns are being requests.  See the RETURNS TABLE section below, in particular the Primary Result Set, to acquire more information on the extra columns returned.   So COEFF_STATS(0), the default, means no stats are requested, whereas COEFF_STATS(1) means that stats are being requested."
-                        ]
-                },
-                {
-                        "Name": "CONF_INT_LEVEL",
-                        "Type": "double",
-                        "Optional": true,
-                        "DefaultValue": 0.9,
-                        "LowerBound": 0,
-                        "UpperBound": 1,
-                        "LowerBoundType": "EXCLUSIVE",
-                        "UpperBoundType": "EXCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "A positive float between 0 and 1 exclusive. Only valid when COEFF_STATS(1).",
-                                "This is the confidence interval level value used for coefficient statistics calculation. Default value: 0.9."
-                        ]
-                },
-                {
-                        "Name": "MODEL_STATS",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 0,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "A zero (0) or one (1) integer value.  A flag indicating that the optional model statistics are to be generated, and made available for retrieval via the TD_EXTRACT_RESULTS function. See the RETURNS TABLE section below, in particular the Secondary Model Statistics Result Set, to acquire more information on the extra columns returned.   So MODEL_STATS(0), the default, means no stats are requested, whereas MODEL_STATS(1) means that stats are being requested"
-                        ]
-                },
-                {
-                        "Name": "RESIDUALS",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 0,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "A zero (0) or one (1) integer value.   A flag indicating that the optional residual statistics are to be generated, and made available for retrieval via the TD_EXTRACT_RESULTS function. See the RETURNS TABLE section below, in particular the Tertiary Residuals Result Set, to acquire more information on the extra columns returned.    So RESIDUALS(0), the default, means no stats are requested, whereas RESIDUALS(1) means that stats are being requested."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_MULTIVAR_REGR",
+        "FuncDescriptionShort": "Multivariate linear regression is about fitting the observed data to some multidimensional surface",
+        "FuncDescriptionLong": [
+                "Multivariate linear regression is about fitting the observed data to some multidimensional surface - a formula is postulated which purportedly defines how an explanatory variable is related to a response variable.   The response variable being the 'observed result/response' that the scientist hopes to model with the formula and the set of explanatory variables being the variables, which in conjunction with the formula, can be used to 'explain' the result.  "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_Multivar_Regr",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "a multivariate series - with the first payload field representing the response variable and the remainder of the payload fields representing the explanatory variables - as input"
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "varchar(120)",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(40)",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_MULTIVAR_REGR function can create a multilevel ART table.  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"
+                },
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": false,
+                        "LayerName": "ARTFITMETADATA",
+                        "ResultTableColumnTypes": [
+                                "float",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "integer",
+                                "integer",
+                                "float"
+                        ],
+                        "Description": [
+                                "The secondary result set can be accessed by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTFITMETADATA),…)",
+                                "This result set is generated in response to the FUNC_PARAMS MODEL_STATS(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 deposited in LAYER1 under the name ARTFITMETADATA."
+                        ],
+                        "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": "ARTFITRESIDUALS",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "column<N, float>",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The tertiary result set can be accessed by issuing a TD_EXTRACT_RESULTS(…,LAYER(ARTFITRESIDUALS),…)",
+                                "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.  This result set will be deposited in LAYER2 under the name ARTFITRESIDUALS.'1'.   The result set can be retrieved by invoking the TD_EXTRACT_RESULTS function against the analytical result table containing the metadata. This will be deposited in LAYER2, under the name ARTFITRESIDUALS. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "VARIABLES_COUNT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 3,
+                        "LowerBoundType": "INCLUSIVE",
+                        "Description": [
+                                "An integer indicating that 1 response variable and (N-1) explanatory variables are referenced within the <multivar-series-specification>.  The first series is always the response variable series 'Y'; the next N-1 series are the explanatory variable series named - X1, X2,  XN-1 ."
+                        ]
+                },
+                {
+                        "Name": "WEIGHTS",
+                        "Type": "integer",
+                        "Optional": false,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                " A zero (0) or one (1) integer value.  A flag indicating that the N+1 series referenced within the  <multivar-series-specification> is the weight series.  This series is to be interpreted as a series of weights that can be used to perform a weighted least squares regression solution."
+                        ]
+                },
+                {
+                        "Name": "FORMULA",
+                        "Type": "<td_formula>",
+                        "Optional": false,
+                        "Description": [
+                                "A Teradata formula string that defines the formula that is to be used in the regression operation.  As an example consider: FORMULA(Y = c + a*x1+ b*(exp(x1)*cos(x1))); in which Y is the response variable; x1 is the explanatory variable; and, a, b, and c are the coefficients that the regression is to determine.  See the Teradata Formula String subsection within the TD_GENSERIES4FUNC function section for additional information.  Note: The name of the response variable must always be Y; and, the name of the explanatory variable must always be X1.   User is free to name the coefficients whatever they wish."
+                        ]
+                },
+                {
+                        "Name": "ALGORITHM",
+                        "Type": "string",
+                        "Optional": false,
+                        "Description": [
+                                "Implementation method name.    A value of 'QR' , ALGORITHM (QR), means that QR decomposition is to be employed.  A value of 'PSI', ALGORITHM (PSI),  means that pseudo-inverse based on SVD is to be used to solve the regression."
+                        ]
+                },
+                {
+                        "Name": "COEFF_STATS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "A zero (0) or one (1) integer value.  A flag indicating that the optional coefficient statistical columns are being requests.  See the RETURNS TABLE section below, in particular the Primary Result Set, to acquire more information on the extra columns returned.   So COEFF_STATS(0), the default, means no stats are requested, whereas COEFF_STATS(1) means that stats are being requested."
+                        ]
+                },
+                {
+                        "Name": "CONF_INT_LEVEL",
+                        "Type": "double",
+                        "Optional": true,
+                        "DefaultValue": 0.9,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "A positive float between 0 and 1 exclusive. Only valid when COEFF_STATS(1).",
+                                "This is the confidence interval level value used for coefficient statistics calculation. Default value: 0.9."
+                        ]
+                },
+                {
+                        "Name": "MODEL_STATS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "A zero (0) or one (1) integer value.  A flag indicating that the optional model statistics are to be generated, and made available for retrieval via the TD_EXTRACT_RESULTS function. See the RETURNS TABLE section below, in particular the Secondary Model Statistics Result Set, to acquire more information on the extra columns returned.   So MODEL_STATS(0), the default, means no stats are requested, whereas MODEL_STATS(1) means that stats are being requested"
+                        ]
+                },
+                {
+                        "Name": "RESIDUALS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "A zero (0) or one (1) integer value.   A flag indicating that the optional residual statistics are to be generated, and made available for retrieval via the TD_EXTRACT_RESULTS function. See the RETURNS TABLE section below, in particular the Tertiary Residuals Result Set, to acquire more information on the extra columns returned.    So RESIDUALS(0), the default, means no stats are requested, whereas RESIDUALS(1) means that stats are being requested."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }