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

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

@@ -1,117 +1,117 @@
-{
-        "FuncName": "TD_DTW",
-        "FuncDescriptionShort": "Dynamic time warping (DTW) is used to the measure the similarity of two time series",
-        "FuncDescriptionLong": [
-                "Dynamic time warping (DTW) is used to the measure the similarity of two time series.  The generic DTW algorithm is O(n2) in both space and time.  Thus, it is not well suited for large data.  There are a lot of variant algorithms that attempt to address such limitation.  One of the most well-known algorithms is FastDTW by Stan Salvador and Philip Chan, which is O(n) in both space and time.  This algorithm can find the optimal, or a close to optimal warp path between two series, depending on the search radius used.",
-                "TD_DTW implements the algorithm from scratch using C++.  The behavior mostly matches the FastDTW Java implementation done by the original authors.  It should be noted that the Python fastdtw package has several algorithm differences with the Java version.  So, the result of TD_DTW may not match that of Python fastdtw, but it should closely match the Java implementation.",
-                "TD_DTW does have a slightly different behaviors from the Java implementation.  In Java implementation, the shrunk (i.e. reduced) series is half of the parent series.  If the parent series has odd number of elements, while most of the elements of the shrunk series are the average of two parent elements, the last element of the shrunk series is the average of the last three elements of the parent series.  TD_DTW instead chooses to have the last element to match the last element of the parent.  As the result, TD_DTW can have slightly larger size in the shrunk series in each recursion.  While there can be edge cases, this slight deviation mostly has little effect in finding the best warp path within the radius."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Series Forecasting",
-        "JSONVersion": "1",
-        "FuncRName": "td_DTW",
-        "MaxInputFiles": 2,
-        "Input": [
-                {
-                        "Type": "SERIES",
-                        "Description": [
-                                "The two series inputs must have the same number of payload columns."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                },
-                {
-                        "Type": "SERIES",
-                        "Description": [
-                                "The two series inputs must have the same number of payload columns."
-                        ],
-                        "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",
-                                "integer",
-                                "integer",
-                                "<varies>",
-                                "<varies>"
-                        ],
-                        "Description": [
-
-                                "Last two columns have types that are the same as series 1 and 2 row axis type. "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-
-                {
-                        "Name": "RADIUS",
-                        "Type": "integer",
-                        "Optional": true,
-                        "LowerBound": 0,
-                        "UpperBound": 1000,
-                        "LowerBoundType": "EXCLUSIVE",
-                        "UpperBoundType": "EXCLUSIVE",
-                        "Description": [
-                                "The search radius for the FastDTW algorithm.  It cannot be negative.  The range of the values is between 0 and 1000.",
-                                "Because of how FastDTW works, bigger radiuses can cause significant performance issues without providing a better result.  Oftentimes, small radius is good enough for finding the optimal match."
-                        ]
-                },
-                {
-                        "Name": "DISTANCE",
-                        "Type": "string",
-                        "Optional": true,
-                        "PermittedValues": [
-                                "EUCLIDEAN",
-                                "MANHATTAN",
-                                "BINARY"
-                        ],
-                        "Description": [
-                                "The distance function to be used.  The currently supported names are: 'euclidean' - for Euclidean distance function; 'manhattan' - for Manhattan distance function; 'binary' - For binary distance function. The match is case in-sensitive."
-                        ]
-                },
-                {
-                        "Name": "WARPPATH",
-                        "Type": "integer",
-                        "Optional": true,
-                        "LowerBound": 0,
-                        "UpperBound": 3,
-                        "LowerBoundType": "INCLUSIVE",
-                        "UpperBoundType": "INCLUSIVE",
-                        "Description": [
-                                "The valid values are between 0 and 3.",
-                                "'0' indicates that no warp paths should be generated.  Only the warp distance is calculated.",
-                                "'1' indicates that warp paths should be generated with 'WarpX' and 'WarpY' output columns being the path index.",
-                                "'2' indicates that warp paths should be generated with 'WarpX_I' and 'WarpY_I' being the series 1 and series 2 ROW_I values at the path index.",
-                                "'3' indicates that warp paths should be generated with both the output columns of 1 and 2."
-                        ],
-                        "LangName": "warp_path"
-                }
-        ],
-        "InputFmt": [
-                {
-                        "Name": "INPUT_MODE",
-                        "Type": "string",
-                        "Optional": false,
-                        "PermittedValues": [
-                                "MANY2ONE",
-                                "ONE2ONE",
-                                "MATCH"
-                        ],
-                        "Description": [
-                                "Specifies the input mode supported by the function."
-                        ],
-                        "LangName": "input_fmt_input_mode"
-                }
-        ],
-        "OutputFmt": false
+{
+        "FuncName": "TD_DTW",
+        "FuncDescriptionShort": "Dynamic time warping (DTW) is used to the measure the similarity of two time series",
+        "FuncDescriptionLong": [
+                "Dynamic time warping (DTW) is used to the measure the similarity of two time series.  The generic DTW algorithm is O(n2) in both space and time.  Thus, it is not well suited for large data.  There are a lot of variant algorithms that attempt to address such limitation.  One of the most well-known algorithms is FastDTW by Stan Salvador and Philip Chan, which is O(n) in both space and time.  This algorithm can find the optimal, or a close to optimal warp path between two series, depending on the search radius used.",
+                "TD_DTW implements the algorithm from scratch using C++.  The behavior mostly matches the FastDTW Java implementation done by the original authors.  It should be noted that the Python fastdtw package has several algorithm differences with the Java version.  So, the result of TD_DTW may not match that of Python fastdtw, but it should closely match the Java implementation.",
+                "TD_DTW does have a slightly different behaviors from the Java implementation.  In Java implementation, the shrunk (i.e. reduced) series is half of the parent series.  If the parent series has odd number of elements, while most of the elements of the shrunk series are the average of two parent elements, the last element of the shrunk series is the average of the last three elements of the parent series.  TD_DTW instead chooses to have the last element to match the last element of the parent.  As the result, TD_DTW can have slightly larger size in the shrunk series in each recursion.  While there can be edge cases, this slight deviation mostly has little effect in finding the best warp path within the radius."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Series Forecasting",
+        "JSONVersion": "1",
+        "FuncRName": "td_DTW",
+        "MaxInputFiles": 2,
+        "Input": [
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "The two series inputs must have the same number of payload columns."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                },
+                {
+                        "Type": "SERIES",
+                        "Description": [
+                                "The two series inputs must have the same number of payload columns."
+                        ],
+                        "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",
+                                "integer",
+                                "integer",
+                                "<varies>",
+                                "<varies>"
+                        ],
+                        "Description": [
+
+                                "Last two columns have types that are the same as series 1 and 2 row axis type. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+
+                {
+                        "Name": "RADIUS",
+                        "Type": "integer",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "UpperBound": 1000,
+                        "LowerBoundType": "EXCLUSIVE",
+                        "UpperBoundType": "EXCLUSIVE",
+                        "Description": [
+                                "The search radius for the FastDTW algorithm.  It cannot be negative.  The range of the values is between 0 and 1000.",
+                                "Because of how FastDTW works, bigger radiuses can cause significant performance issues without providing a better result.  Oftentimes, small radius is good enough for finding the optimal match."
+                        ]
+                },
+                {
+                        "Name": "DISTANCE",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "EUCLIDEAN",
+                                "MANHATTAN",
+                                "BINARY"
+                        ],
+                        "Description": [
+                                "The distance function to be used.  The currently supported names are: 'euclidean' - for Euclidean distance function; 'manhattan' - for Manhattan distance function; 'binary' - For binary distance function. The match is case in-sensitive."
+                        ]
+                },
+                {
+                        "Name": "WARPPATH",
+                        "Type": "integer",
+                        "Optional": true,
+                        "LowerBound": 0,
+                        "UpperBound": 3,
+                        "LowerBoundType": "INCLUSIVE",
+                        "UpperBoundType": "INCLUSIVE",
+                        "Description": [
+                                "The valid values are between 0 and 3.",
+                                "'0' indicates that no warp paths should be generated.  Only the warp distance is calculated.",
+                                "'1' indicates that warp paths should be generated with 'WarpX' and 'WarpY' output columns being the path index.",
+                                "'2' indicates that warp paths should be generated with 'WarpX_I' and 'WarpY_I' being the series 1 and series 2 ROW_I values at the path index.",
+                                "'3' indicates that warp paths should be generated with both the output columns of 1 and 2."
+                        ],
+                        "LangName": "warp_path"
+                }
+        ],
+        "InputFmt": [
+                {
+                        "Name": "INPUT_MODE",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "MANY2ONE",
+                                "ONE2ONE",
+                                "MATCH"
+                        ],
+                        "Description": [
+                                "Specifies the input mode supported by the function."
+                        ],
+                        "LangName": "input_fmt_input_mode"
+                }
+        ],
+        "OutputFmt": false
 }

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

@@ -1,101 +1,101 @@
-{
-        "FuncName": "TD_DURBIN_WATSON",
-        "FuncDescriptionShort": "The Durbin-Watson statistical test which is run against the residuals associated with a fitted model",
-        "FuncDescriptionLong": [
-                "It is a test which looks for the presence of serial correlation amongst the error/residual terms.  It is mainly employed to analyze the residuals produced by a univariate or multivariate regression (cross-sectional data sets).  With respect to regression models, it is expected that there would exist no serial correlation amongst the error terms in contrast, with time series, the expectation is that most likely their will exist serial correlation amongst the error terms. "
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Diagnostic Statistical Test",
-        "JSONVersion": "1",
-        "FuncRName": "td_Durbin_Watson",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "ART"
-                        ],
-                        "Description": [
-                                "The input of this function is executed against the residuals left over after running a regression.  These residuals may either reside within an independent table, or may exist in the form of tertiary results resident within an analytical result table"
-                        ],
-                        "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",
-                                "integer",
-                                "varchar(16)",
-                                "float",
-                                "float",
-                                "float",
-                                "float",
-                                "varchar(16)"
-                        ],
-                        "Description": [
-                                "The TD_DURBIN_WATSON 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 table containing the results."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": false,
-        "Params": [
-                {
-                        "Name": "EXPLANATORY_COUNT",
-                        "Type": "integer",
-                        "Optional": false,
-                        "LowerBound": 1,
-                        "LowerBoundType": "INCLUSIVE",
-                        "AllowNaN": false,
-                        "Description": [
-                                "Positive Integer value.  The number of explanatory variables in the original regression.  The number of explanatory variables plus the INCLUDE_CONSTANT information is needed to perform the lookup in the DW tables."
-                        ]
-                },
-                {
-                        "Name": "INCLUDE_CONSTANT",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 0,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "Flag indicating whether the original regression equation contained a 'constant' (an 'intercept').  A value of '0' indicates that no constant was present.  A value of '1' indicates that a constant was present.  Default is 0.  "
-                        ]
-                },
-                {
-                        "Name": "METHOD",
-                        "Type": "string",
-                        "Optional": false,
-                        "PermittedValues": [
-                                "DW_FORMULA",
-                                "ACR_LAG1"
-                        ],
-                        "Description": [
-                                "Enumerated value specifying the formula the data scientist wishes to use to calculate the DW test statistic value.  A value of 'DW_FORMULA' means use the full summation formula to calculate the value.  A value of ACR_LAG1, means execute the regression, 'μt =  ρ (μt-1) + νt ';  where  'ρ' is the estimate of the autocorrelation at lag 1, and serves the role of the DW statistic."
-                        ]
-                },
-                {
-                        "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: 0.01, 0.05, etc "
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_DURBIN_WATSON",
+        "FuncDescriptionShort": "The Durbin-Watson statistical test which is run against the residuals associated with a fitted model",
+        "FuncDescriptionLong": [
+                "It is a test which looks for the presence of serial correlation amongst the error/residual terms.  It is mainly employed to analyze the residuals produced by a univariate or multivariate regression (cross-sectional data sets).  With respect to regression models, it is expected that there would exist no serial correlation amongst the error terms in contrast, with time series, the expectation is that most likely their will exist serial correlation amongst the error terms. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Diagnostic Statistical Test",
+        "JSONVersion": "1",
+        "FuncRName": "td_Durbin_Watson",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "ART"
+                        ],
+                        "Description": [
+                                "The input of this function is executed against the residuals left over after running a regression.  These residuals may either reside within an independent table, or may exist in the form of tertiary results resident within an analytical result table"
+                        ],
+                        "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",
+                                "integer",
+                                "varchar(16)",
+                                "float",
+                                "float",
+                                "float",
+                                "float",
+                                "varchar(16)"
+                        ],
+                        "Description": [
+                                "The TD_DURBIN_WATSON 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 table containing the results."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": false,
+        "Params": [
+                {
+                        "Name": "EXPLANATORY_COUNT",
+                        "Type": "integer",
+                        "Optional": false,
+                        "LowerBound": 1,
+                        "LowerBoundType": "INCLUSIVE",
+                        "AllowNaN": false,
+                        "Description": [
+                                "Positive Integer value.  The number of explanatory variables in the original regression.  The number of explanatory variables plus the INCLUDE_CONSTANT information is needed to perform the lookup in the DW tables."
+                        ]
+                },
+                {
+                        "Name": "INCLUDE_CONSTANT",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 0,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Flag indicating whether the original regression equation contained a 'constant' (an 'intercept').  A value of '0' indicates that no constant was present.  A value of '1' indicates that a constant was present.  Default is 0.  "
+                        ]
+                },
+                {
+                        "Name": "METHOD",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "DW_FORMULA",
+                                "ACR_LAG1"
+                        ],
+                        "Description": [
+                                "Enumerated value specifying the formula the data scientist wishes to use to calculate the DW test statistic value.  A value of 'DW_FORMULA' means use the full summation formula to calculate the value.  A value of ACR_LAG1, means execute the regression, 'μt =  ρ (μt-1) + νt ';  where  'ρ' is the estimate of the autocorrelation at lag 1, and serves the role of the DW statistic."
+                        ]
+                },
+                {
+                        "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: 0.01, 0.05, etc "
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }

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

@@ -1,39 +1,39 @@
-{
-        "FuncName": "TD_EXTRACT_RESULTS",
-        "FuncDescriptionShort": "Retrieve additional result sets within the ART table.",
-        "FuncDescriptionLong": [
-                "The TD_EXTRACT_RESULTS utility function is used to retrieve auxiliary result sets stored within the ART table. "
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "General Utility",
-        "JSONVersion": "1",
-        "FuncRName": "td_Extract_Results",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": "ART",
-                        "Description": [
-                                "This AF function is passed an ART table specification, ART_SPEC. Within the ART_SPEC, the only thing that has to be passed in is the TABLE_NAME and LAYER. The PAYLOAD option can be omitted since all available payload columns need to be passed in to 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": "varies",
-                        "Description": [
-                                "The output of this function are wavelets from the specified LAYER of the ART table.",
-                                "Invoking this AF utility function retrieves all wavelets from one specified layer in the ART table. Please see the specific function’s RETURNS TABLE specification section to determine the output column descriptions for well-known layers."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_EXTRACT_RESULTS",
+        "FuncDescriptionShort": "Retrieve additional result sets within the ART table.",
+        "FuncDescriptionLong": [
+                "The TD_EXTRACT_RESULTS utility function is used to retrieve auxiliary result sets stored within the ART table. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "General Utility",
+        "JSONVersion": "1",
+        "FuncRName": "td_Extract_Results",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": "ART",
+                        "Description": [
+                                "This AF function is passed an ART table specification, ART_SPEC. Within the ART_SPEC, the only thing that has to be passed in is the TABLE_NAME and LAYER. The PAYLOAD option can be omitted since all available payload columns need to be passed in to 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": "varies",
+                        "Description": [
+                                "The output of this function are wavelets from the specified LAYER of the ART table.",
+                                "Invoking this AF utility function retrieves all wavelets from one specified layer in the ART table. Please see the specific function’s RETURNS TABLE specification section to determine the output column descriptions for well-known layers."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [],
+        "InputFmt": false,
+        "OutputFmt": false
 }