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

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

@@ -1,90 +1,90 @@
-{
-        "FuncName": "TD_SELECTION_CRITERIA",
-        "FuncDescriptionShort": "The TD_SELECTION_CRITERIA function calculates a number of metrics ",
-        "FuncDescriptionLong": [
-                "The TD_SELECTION_CRITERIA function calculates a number of metrics against the residuals left over from a model validation exercise.  The produced metrics can be used by the data scientist to make an intelligent choice as to which forecast model candidates to select to pursue for their forecast modeling project. "
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Diagnostic Statistical Test",
-        "JSONVersion": "1",
-        "FuncRName": "td_Selection_Criteria",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "ART"
-                        ],
-                        "Description": [
-                                "This section outlines the syntax associated with invoking the TD_SELECTION_CRITERIA function.   This function can accept either a single multivariate series as an input, or alternatively can accept an ART table containing the residual results from a previously run regression operation. ",
-                                "For the case in which the input is a single multivariate series, the fields in the SERIES_SPEC(PAYLOAD(FIELDS(). CONTENT(MULTIVAR_REAL)) must consists of: First field referenced is the original series value; Second field referenced is the calculated series value produced by the model; Third field is the calculated residual: original_value minus calculated_value",
-                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
-                        ],
-                        "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",
-                                "integer",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-                                "The TD_SELECTION_CRITERIA  function returns only a primary result set consisting of one row per unique series acted upon.   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 result table (ART) 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": "VAR_COUNT",
-                        "Type": "integer",
-                        "Optional": false,
-                        "LowerBound": 0,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "For an ARIMA(p,d,q) model, this is an integer indicating the total number of parameters: VAR_COUNT = p + q +1(CONSTANT(1)); present in the model. "
-                        ]
-                },
-                {
-                        "Name": "CONSTANT",
-                        "Type": "integer",
-                        "Optional": false,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "If  the ARIMA model has the constant part when fit the model. 0 is no constant and 1 is with constant"
-                        ]
-                },
-                {
-                        "Name": "USE_LIKELIHOOD",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 0,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "If the calculation of those selection criteria values like AIC are based on the max log-likelihood provided during the model fitting stage. Only available when input table is art generated from TD_ARIMAESTIMATE.",
-                                "If throwing regular input or art from TD_ARIMAVALIDATE, function will error out.",
-                                "0 is using RSS, and 1 is using log-likelihood. Default value is 0 - using residuals."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_SELECTION_CRITERIA",
+        "FuncDescriptionShort": "The TD_SELECTION_CRITERIA function calculates a number of metrics ",
+        "FuncDescriptionLong": [
+                "The TD_SELECTION_CRITERIA function calculates a number of metrics against the residuals left over from a model validation exercise.  The produced metrics can be used by the data scientist to make an intelligent choice as to which forecast model candidates to select to pursue for their forecast modeling project. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Selection_Criteria",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This section outlines the syntax associated with invoking the TD_SELECTION_CRITERIA function.   This function can accept either a single multivariate series as an input, or alternatively can accept an ART table containing the residual results from a previously run regression operation. ",
+                                "For the case in which the input is a single multivariate series, the fields in the SERIES_SPEC(PAYLOAD(FIELDS(). CONTENT(MULTIVAR_REAL)) must consists of: First field referenced is the original series value; Second field referenced is the calculated series value produced by the model; Third field is the calculated residual: original_value minus calculated_value",
+                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
+                        ],
+                        "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",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_SELECTION_CRITERIA  function returns only a primary result set consisting of one row per unique series acted upon.   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 result table (ART) 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": "VAR_COUNT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "For an ARIMA(p,d,q) model, this is an integer indicating the total number of parameters: VAR_COUNT = p + q +1(CONSTANT(1)); present in the model. "
+                        ]
+                },
+                {
+                        "Name": "CONSTANT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "If  the ARIMA model has the constant part when fit the model. 0 is no constant and 1 is with constant"
+                        ]
+                },
+                {
+                        "Name": "USE_LIKELIHOOD",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "If the calculation of those selection criteria values like AIC are based on the max log-likelihood provided during the model fitting stage. Only available when input table is art generated from TD_ARIMAESTIMATE.",
+                                "If throwing regular input or art from TD_ARIMAVALIDATE, function will error out.",
+                                "0 is using RSS, and 1 is using log-likelihood. Default value is 0 - using residuals."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }

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

@@ -1,80 +1,80 @@
-{
-        "FuncName": "TD_SIGNIF_PERIODICITIES",
-        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
-        "FuncDescriptionLong": [
-                "The Significance of Periodicities statistical test aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the 'model fitting' exercise; and, the second portion to be used for the 'model validation' exercise.  The TD_SIGNIF_PERIODICITIES function is usually executed against the residuals produced during the second 'model validation' exercise, meaning against the 'in-sample' forecasted data points."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Diagnostic Statistical Test",
-        "JSONVersion": "1",
-        "FuncRName": "td_Signif_Periodicities",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "ART"
-                        ],
-                        "Description": [
-                                "This section outlines the syntax associated with invoking the TD_SIGNIF_PERIODICITIES function.   This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (TD_ARIMAVALIDATE) operation. ",
-                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
-                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
-                        ],
-                        "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",
-                                "integer",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "varchar(16)"
-                        ],
-                        "Description": [
-                                "The TD_SIGNIF_PERIODICITIES function returns only a primary result set consisting of one row per unique periodicity acted upon.   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 result table (ART) containing the results."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-                {
-                        "Name": "SIGNIFICANCE_LEVEL",
-                        "Type": "double",
-                        "Optional": false,
-                        "LowerBound": 0,
-                        "UpperBound": 1,
-                        "LowerBoundType": "EXCLUSIVE",
-                        "UpperBoundType": "EXCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "The significance level for the statistical F-test"
-                        ]
-                },
-                {
-                        "Name": "PERIODICITIES",
-                        "Type": "list",
-                        "ListType": "double",
-                        "Optional": false,
-                        "AllowNaN": false,
-                        "CheckDuplicates": false,
-                        "Description": [
-                                "A list containing one or more floating point values; representing significant periodicities: w1, w2, ..., wd. ; in terms of wk.  Where   wk = 2pi / P"
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_SIGNIF_PERIODICITIES",
+        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
+        "FuncDescriptionLong": [
+                "The Significance of Periodicities statistical test aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the 'model fitting' exercise; and, the second portion to be used for the 'model validation' exercise.  The TD_SIGNIF_PERIODICITIES function is usually executed against the residuals produced during the second 'model validation' exercise, meaning against the 'in-sample' forecasted data points."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Signif_Periodicities",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This section outlines the syntax associated with invoking the TD_SIGNIF_PERIODICITIES function.   This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (TD_ARIMAVALIDATE) operation. ",
+                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
+                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
+                        ],
+                        "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",
+                                "integer",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_SIGNIF_PERIODICITIES function returns only a primary result set consisting of one row per unique periodicity acted upon.   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 result table (ART) containing the results."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The significance level for the statistical F-test"
+                        ]
+                },
+                {
+                        "Name": "PERIODICITIES",
+                        "Type": "list",
+                        "ListType": "double",
+                        "Optional": false,
+                        "AllowNaN": false,
+                        "CheckDuplicates": false,
+                        "Description": [
+                                "A list containing one or more floating point values; representing significant periodicities: w1, w2, ..., wd. ; in terms of wk.  Where   wk = 2pi / P"
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }

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

@@ -1,68 +1,68 @@
-{
-        "FuncName": "TD_SIGNIF_RESIDMEAN",
-        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
-        "FuncDescriptionLong": [
-                "The Significance of Residual Mean statistical test is aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the “model fitting” exercise; and, the second portion to be used for the “model validation” exercise.  The TD_SIGNIF_RESIDMEAN function is usually executed against the residuals produced during the second “model validation” exercise, meaning against the “in-sample” forecasted data points."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Diagnostic Statistical Test",
-        "JSONVersion": "1",
-        "FuncRName": "td_Signif_Residmean",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "ART"
-                        ],
-                        "Description": [
-                                "This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (TD_ARIMAVALIDATE) operation. ",
-                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
-                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
-                        ],
-                        "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",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-                                "The TD_SIGNIF_RESIDMEAN  function returns only a primary result set consisting of one row per unique series acted upon.   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 result table (ART) containing the results.",
-                                "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": false,
-        "Params": [
-                {
-                        "Name": "SIGNIFICANCE_LEVEL",
-                        "Type": "double",
-                        "Optional": false,
-                        "LowerBound": 0,
-                        "UpperBound": 1,
-                        "LowerBoundType": "EXCLUSIVE",
-                        "UpperBoundType": "EXCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "The significance level for the statistical t-test"
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_SIGNIF_RESIDMEAN",
+        "FuncDescriptionShort": "Help selecting the model which best describes the data modeled",
+        "FuncDescriptionLong": [
+                "The Significance of Residual Mean statistical test is aimed at assisting the data scientist in selecting the model candidate which is the best choice for the data they are modeling.  The test which works off the residuals generated during the model validation / model selection processing phase.  As mentioned previously, typically the data scientists divide their series sample set into two portions: the first portion to be used for the “model fitting” exercise; and, the second portion to be used for the “model validation” exercise.  The TD_SIGNIF_RESIDMEAN function is usually executed against the residuals produced during the second “model validation” exercise, meaning against the “in-sample” forecasted data points."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Signif_Residmean",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This function can accept either a single univariate series (containing the in-sample generated residuals) as an input, or alternatively can accept an ART table containing the residual results from a previously run validation (TD_ARIMAVALIDATE) operation. ",
+                                "For the case in which the input is a univariate series, the payload should contain a reference to a single field containing the residuals: the single field references the calculated residual: original_value minus calculated_value",
+                                "For the scenario in which the residuals reside within the tertiary result set associated with an ART table, then the caller merely needs to pass in the TABLE_NAME identify the ART containing the residuals - the DBS software will perform the extraction of the original series, calculated series, and residuals as part of the execution of this function."
+                        ],
+                        "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",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The TD_SIGNIF_RESIDMEAN  function returns only a primary result set consisting of one row per unique series acted upon.   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 result table (ART) containing the results.",
+                                "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": false,
+        "Params": [
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The significance level for the statistical t-test"
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }