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

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

@@ -1,114 +1,114 @@
-{
-        "FuncName": "TD_PACF",
-        "FuncDescriptionShort": "Computes the Partial Auto Correlation function of a series",
-        "FuncDescriptionLong": [
-                "the TD_PACF, Partial Auto Correlation function, can be passed either a discrete series - time or spatial series (INPUT_TYPE(DATA_SERIES)) - as an input; or, alternatively, can be passed a series containing previously computed Auto Correlation coefficients - lag and magnitude (INPUT_TYPE(ACF)).   The passed in logical-runtime series is permitted to have elements which are either univariate or multivariate reals. Each input series produces a result series, which is indexed on 'LAG', and containing univariate or multivariate real number magnitudes as it result series elements.  This function provides the ability to generate 'on-demand' plots.  The generated plots can be either univariate, multivariate, or composite in nature. The chosen implementation’s output and style specification closely match Matplotlib ( https://matplotlib.org/ ), an extremely popular Python plotting library. The primary purpose for this decision is to jump start existing Matplotlib users into TD_PLOT usage.  However, the Teradata implementation is a completely independent and separate one based on C/C++."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Model Preparation and Parameter Estimation",
-        "JSONVersion": "1",
-        "FuncRName": "td_PACF",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "ART"
-                        ],
-                        "Description": [
-                                "discrete series - time or spatial series (INPUT_TYPE(DATA_SERIES)) - as an input; or, alternatively, can be passed a series containing previously computed Auto Correlation coefficients - lag and magnitude (INPUT_TYPE(ACF))"
-                        ],
-                        "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"
-                        ],
-                        "Description": [
-                                "The TD_PACF 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.",
-                                "The last three float outputs are only returned if the ALPHA parameter was set to some NON-ZERO value. "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-                {
-                        "Name": "INPUT_TYPE",
-                        "Type": "string",
-                        "Optional": true,
-                        "PermittedValues": [
-                                "DATA_SERIES",
-                                "ACF"
-                        ],
-                        "Description": [
-                                "Optional parameter. Specifies whether to source 1D array contains a data series or contains previously generated ACF results.  Default is DATA_SERIES, meaning a data series is being passed in.",
-                                "DATA_SERIES - 1D input array contains time or spatial series",
-                                "ACF - 1D input array is indexed by LAG and contains previously generated  ACF magnitudes"
-                        ]
-                },
-                {
-                        "Name": "ALGORITHM",
-                        "Type": "string",
-                        "Optional": false,
-                        "PermittedValues": [
-                                "LEVINSON_DURBIN",
-                                "OLS"
-                        ],
-                        "Description": [
-                                "Specifies algorithm that data scientist wishes to use to generate the PACF coefficients",
-                                "LEVINSON_DURBIN - Uses the set of recursive formulas devised by Levinson-Durbin to solve for PACF coefficients",
-                                "OLS - Solves incremental series of regression equations to determine the PACF coefficients"
-                        ]
-                },
-                {
-                        "Name": "MAXLAGS",
-                        "Type": "integer",
-                        "Optional": false,
-                        "LowerBound": 1,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "Positive Integer value.  Maximum number of lags at which to calculate the partial autocorrelation. Default is 10*log10(N) where N is the number of observations. Is automatically limited to one less than the number of observations in the series.  If the numLags value specified by the user exceeds this limit, the user input value is ignored and replaced with the system defined max value."
-                        ],
-                        "LangName": "max_lags"
-                },
-                {
-                        "Name": "UNBIASED",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 0,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "Only valid when INPUT_TYPE(DATA_SERIES). This effects the manner in which the auto-correlation intermediate values are calculated.",
-                                "Positive Integer value. If 0, then denominator for autocorrelation calculation is n-k (Jenkins & Watts formula), otherwise if 1, denominator for autocorrelation calculation is n (Box & Jenkins formula). Default is 0."
-                        ]
-                },
-                {
-                        "Name": "ALPHA",
-                        "Type": "float",
-                        "Optional": true,
-                        "LowerBound": 0,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "Positive Float value. If a non-zero positive number is given, the confidence intervals for the given level are returned.  For instance if alpha=.05, 95% confidence intervals are returned where the standard deviation is computed according to Bartlett’s formula.   Passing in a positive number results in a CONFINT result column being returned."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
-}
+{
+        "FuncName": "TD_PACF",
+        "FuncDescriptionShort": "Computes the Partial Auto Correlation function of a series",
+        "FuncDescriptionLong": [
+                "the TD_PACF, Partial Auto Correlation function, can be passed either a discrete series - time or spatial series (INPUT_TYPE(DATA_SERIES)) - as an input; or, alternatively, can be passed a series containing previously computed Auto Correlation coefficients - lag and magnitude (INPUT_TYPE(ACF)).   The passed in logical-runtime series is permitted to have elements which are either univariate or multivariate reals. Each input series produces a result series, which is indexed on 'LAG', and containing univariate or multivariate real number magnitudes as it result series elements.  This function provides the ability to generate 'on-demand' plots.  The generated plots can be either univariate, multivariate, or composite in nature. The chosen implementation’s output and style specification closely match Matplotlib ( https://matplotlib.org/ ), an extremely popular Python plotting library. The primary purpose for this decision is to jump start existing Matplotlib users into TD_PLOT usage.  However, the Teradata implementation is a completely independent and separate one based on C/C++."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Model Preparation and Parameter Estimation",
+        "JSONVersion": "1",
+        "FuncRName": "td_PACF",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "discrete series - time or spatial series (INPUT_TYPE(DATA_SERIES)) - as an input; or, alternatively, can be passed a series containing previously computed Auto Correlation coefficients - lag and magnitude (INPUT_TYPE(ACF))"
+                        ],
+                        "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"
+                        ],
+                        "Description": [
+                                "The TD_PACF 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.",
+                                "The last three float outputs are only returned if the ALPHA parameter was set to some NON-ZERO value. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "INPUT_TYPE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "DATA_SERIES",
+                                "ACF"
+                        ],
+                        "Description": [
+                                "Optional parameter. Specifies whether to source 1D array contains a data series or contains previously generated ACF results.  Default is DATA_SERIES, meaning a data series is being passed in.",
+                                "DATA_SERIES - 1D input array contains time or spatial series",
+                                "ACF - 1D input array is indexed by LAG and contains previously generated  ACF magnitudes"
+                        ]
+                },
+                {
+                        "Name": "ALGORITHM",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "LEVINSON_DURBIN",
+                                "OLS"
+                        ],
+                        "Description": [
+                                "Specifies algorithm that data scientist wishes to use to generate the PACF coefficients",
+                                "LEVINSON_DURBIN - Uses the set of recursive formulas devised by Levinson-Durbin to solve for PACF coefficients",
+                                "OLS - Solves incremental series of regression equations to determine the PACF coefficients"
+                        ]
+                },
+                {
+                        "Name": "MAXLAGS",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Positive Integer value.  Maximum number of lags at which to calculate the partial autocorrelation. Default is 10*log10(N) where N is the number of observations. Is automatically limited to one less than the number of observations in the series.  If the numLags value specified by the user exceeds this limit, the user input value is ignored and replaced with the system defined max value."
+                        ],
+                        "LangName": "max_lags"
+                },
+                {
+                        "Name": "UNBIASED",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Only valid when INPUT_TYPE(DATA_SERIES). This effects the manner in which the auto-correlation intermediate values are calculated.",
+                                "Positive Integer value. If 0, then denominator for autocorrelation calculation is n-k (Jenkins & Watts formula), otherwise if 1, denominator for autocorrelation calculation is n (Box & Jenkins formula). Default is 0."
+                        ]
+                },
+                {
+                        "Name": "ALPHA",
+                        "Type": "float",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Positive Float value. If a non-zero positive number is given, the confidence intervals for the given level are returned.  For instance if alpha=.05, 95% confidence intervals are returned where the standard deviation is computed according to Bartlett’s formula.   Passing in a positive number results in a CONFINT result column being returned."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
+}

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

@@ -1,119 +1,119 @@
-{
-        "FuncName": "TD_PORTMAN",
-        "FuncDescriptionShort": "The Portmanteau statistical tests are a series of tests ",
-        "FuncDescriptionLong": [
-                "They are executed against the residuals left over after a modeling fit operation and are aimed at determining whether the residuals can be classified as being “white noise” – meaning: zero mean, no evidence of serial correlation amongst the residual/error terms, and the residuals exhibit homoscedastic variance.",
-                "All these portmanteau tests treat the residuals as an input series and then use that series as an input to calculate the auto-correlation coefficients or partial auto-correlation coefficients associated with that series.  Finally, these coefficients are then used in a subsequent formula to calculate the test statistic value.",
-                "The Null Hypothesis associated with all these tests is that the ARIMA model is adequate and that there is no evidence of serial correlation amongst the residuals."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Diagnostic Statistical Test",
-        "JSONVersion": "1",
-        "FuncRName": "td_Portman",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "ART"
-                        ],
-                        "Description": [
-                                "This function requires that a series of residuals -  left over after running the original regression – be passed into the function.  These residuals may either reside within an independent table, or may exist in the form of tertiary results resident within an analytical result table (ART).   If the residual series exists as a tertiary result set within an analytical result table, then the caller merely needs to pass in the TABLE_NAME to identify the ART containing the residuals - the DBS software will perform the extraction of the 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",
-                                "varchar(16)"
-                        ],
-                        "Description": [
-                                "The TD_PORTMAN  function returns only a primary result set consisting of one row per 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 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": true,
-        "Params": [
-                {
-                        "Name": "MAXLAG",
-                        "Type": "integer",
-                        "Optional": false,
-                        "LowerBound": 0,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "An integer indicating how many explanatory variables (N) are referenced within the PAYLOAD() declaration embedded within the original series specification.  These N explanatory variable are the variables that are to be fed into the auxiliary regression."
-                        ],
-                        "LangName": "max_lags"
-                },
-                {
-                        "Name": "TEST",
-                        "Type": "string",
-                        "Optional": false,
-                        "PermittedValues": [
-                                "BP",
-                                "LB",
-                                "LM",
-                                "MQ",
-                                "ML"
-                        ],
-                        "Description": [
-                                "Chooses the desired Portmanteau diagnostic; BP : Box-Pierce Q test; LB : Ljung-Box Q test; LM : Li-McLeod Q test; MQ : Monti’s Q test; ML : McLeod-Li Q test"
-                        ]
-                },
-                {
-                        "Name": "DEGREES_FREEDOM",
-                        "Type": "integer",
-                        "Optional": false,
-                        "LowerBound": 0,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "Degrees of freedom (aka, p+q) to be subtracted from chosen MAXLAG: meaning: DFTEST = MAXLAG – DEGREES_FREEDOM "
-                        ]
-                },
-                {
-                        "Name": "PACF_METHOD",
-                        "Type": "string",
-                        "Optional": true,
-                        "PermittedValues": [
-                                "LEVINSON_DURBIN",
-                                "OLS"
-                        ],
-                        "Description": [
-                                "Only valid when the TEST(MQ), Monti’s Q test, is chosen.",
-                                "Chooses underlying algorithm that will be employed to calculate the partial auto-correlation coefficients.",
-                                "LEVINSON_DURBIN - Uses the set of recursive formulas devised by Levinson-Durbin to solve for PACF coefficients",
-                                "OLS - Solves incremental series of regression equations to determine the PACF coefficients"
-                        ]
-                },
-                {
-                        "Name": "SIGNIFICANCE_LEVEL",
-                        "Type": "double",
-                        "Optional": false,
-                        "LowerBound": 0,
-                        "UpperBound": 1,
-                        "LowerBoundType": "EXCLUSIVE",
-                        "UpperBoundType": "EXCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "The desired significance level for the test."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_PORTMAN",
+        "FuncDescriptionShort": "The Portmanteau statistical tests are a series of tests ",
+        "FuncDescriptionLong": [
+                "They are executed against the residuals left over after a modeling fit operation and are aimed at determining whether the residuals can be classified as being “white noise” – meaning: zero mean, no evidence of serial correlation amongst the residual/error terms, and the residuals exhibit homoscedastic variance.",
+                "All these portmanteau tests treat the residuals as an input series and then use that series as an input to calculate the auto-correlation coefficients or partial auto-correlation coefficients associated with that series.  Finally, these coefficients are then used in a subsequent formula to calculate the test statistic value.",
+                "The Null Hypothesis associated with all these tests is that the ARIMA model is adequate and that there is no evidence of serial correlation amongst the residuals."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Portman",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "This function requires that a series of residuals -  left over after running the original regression – be passed into the function.  These residuals may either reside within an independent table, or may exist in the form of tertiary results resident within an analytical result table (ART).   If the residual series exists as a tertiary result set within an analytical result table, then the caller merely needs to pass in the TABLE_NAME to identify the ART containing the residuals - the DBS software will perform the extraction of the 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",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_PORTMAN  function returns only a primary result set consisting of one row per 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 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": true,
+        "Params": [
+                {
+                        "Name": "MAXLAG",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "An integer indicating how many explanatory variables (N) are referenced within the PAYLOAD() declaration embedded within the original series specification.  These N explanatory variable are the variables that are to be fed into the auxiliary regression."
+                        ],
+                        "LangName": "max_lags"
+                },
+                {
+                        "Name": "TEST",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "BP",
+                                "LB",
+                                "LM",
+                                "MQ",
+                                "ML"
+                        ],
+                        "Description": [
+                                "Chooses the desired Portmanteau diagnostic; BP : Box-Pierce Q test; LB : Ljung-Box Q test; LM : Li-McLeod Q test; MQ : Monti’s Q test; ML : McLeod-Li Q test"
+                        ]
+                },
+                {
+                        "Name": "DEGREES_FREEDOM",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Degrees of freedom (aka, p+q) to be subtracted from chosen MAXLAG: meaning: DFTEST = MAXLAG – DEGREES_FREEDOM "
+                        ]
+                },
+                {
+                        "Name": "PACF_METHOD",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "LEVINSON_DURBIN",
+                                "OLS"
+                        ],
+                        "Description": [
+                                "Only valid when the TEST(MQ), Monti’s Q test, is chosen.",
+                                "Chooses underlying algorithm that will be employed to calculate the partial auto-correlation coefficients.",
+                                "LEVINSON_DURBIN - Uses the set of recursive formulas devised by Levinson-Durbin to solve for PACF coefficients",
+                                "OLS - Solves incremental series of regression equations to determine the PACF coefficients"
+                        ]
+                },
+                {
+                        "Name": "SIGNIFICANCE_LEVEL",
+                        "Type": "double",
+                        "Optional": false,
+                        "LowerBound": 0,
+                        "UpperBound": 1,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "The desired significance level for the test."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }