teradataml 20.0.0.2__py3-none-any.whl → 20.0.0.4__py3-none-any.whl

teradataml/data/jsons/sqle/20.00/TD_VectorDistance.json

@@ -0,0 +1,278 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "1",
+  "json_content_version": "1",
+  "function_name": "TD_VectorDistance",
+  "function_version": "1.0",
+  "function_type": "fastpath",
+  "function_category": "Model Training",
+  "function_alias_name": "TD_VectorDistance",
+  "function_r_name": "aa.td_vectordistance",
+  "short_description": "fastpath function which takes a table of target vectors and a table of reference vectors(optional) and returns a table that contains the distance between the target-reference pair.",
+  "long_description": "fastpath function which takes a table of target vectors and a table of reference vectors(optional) and returns a table that contains the distance between the target-reference pair.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+        "PartitionByAny"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "TargetTable",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "The relation that contains target table vectors.",
+      "description": "The relation that contains target table vectors.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "target.table",
+      "useInR": true,
+      "rOrderNum": 1
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "ReferenceTable",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "The relation that contains reference table vectors.",
+      "description": "The relation that contains reference table vectors.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "reference.table",
+      "useInR": true,
+      "rOrderNum": 2
+    }
+  ],
+  "argument_clauses": [
+    {
+      "targetTable": [
+        "TargetTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "INTEGER"
+      ],
+      "requiredLength": 1,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "TargetIDColumn",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the name of the target table column that contains identifiers of the target table vectors.",
+      "description": "Specifies the name of the target table column that contains identifiers of the target table vectors.",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "target.id.column",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "targetTable": [
+        "TargetTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "NUMERIC","VECTOR","BYTE","VARBYTE"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "TargetFeatureColumns",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the names of the target table columns that contain features of the target table vectors.",
+      "description": "Specifies the names of the target table columns that contain features of the target table vectors.",
+      "datatype": "COLUMNS",
+      "allowsLists": true,
+      "rName": "target.feature.columns",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "targetTable": [
+        "ReferenceTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "INTEGER"
+      ],
+      "requiredLength": 1,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "RefIDColumn",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the name of the reference table column that contains identifiers of the reference table vectors.",
+      "description": "Specifies the name of the reference table column that contains identifiers of the reference table vectors.",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "ref.id.column",
+      "useInR": true,
+      "rOrderNum": 5
+    },
+    {
+      "targetTable": [
+        "ReferenceTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "NUMERIC","VECTOR","BYTE","VARBYTE"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "RefFeatureColumns",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the names of the reference table columns that contain features of the reference table vectors.",
+      "description": "Specifies the names of the reference table columns that contain features of the reference table vectors.",
+      "datatype": "COLUMNS",
+      "allowsLists": true,
+      "rName": "ref.feature.columns",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+      "permittedValues": [
+        "COSINE",
+        "EUCLIDEAN",
+        "MANHATTAN",
+	"DOTPRODUCT",
+        "MINKOWSKI"
+      ],
+      "defaultValue": "COSINE",
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "DistanceMeasure",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the distance measures that the function uses.The default value is 'cosine'.",
+      "description": "Specifies the distance measures that the function uses.The default value is 'cosine'.",
+      "datatype": "STRING",
+      "allowsLists": true,
+      "rName": "distance.measure",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "defaultValue": 10,
+      "lowerBound": 1,
+      "upperBound": 100,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "TopK",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies, for each target vector and for each measure, the maximum number of closest reference vectors to include in the output table.",
+      "description": "Specifies, for each target vector and for each measure, the maximum number of closest reference vectors to include in the output table.",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "topk",
+      "useInR": true,
+      "rOrderNum": 8
+    },
+    {
+      "defaultValue": 2,
+      "lowerBound": 1,
+      "upperBound": 2147483647,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "PValue",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify the p value for MinKowski distance.",
+      "description": "Specify the p value for MinKowski distance.",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "pvalue",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "lowerBound": -1.797693e+308,
+      "upperBound": 1.797693e+308,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "SearchThresholds",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the thresholds between a pair of target and reference vectors.",
+      "description": "Specifies the thresholds between a pair of target and reference vectors.",
+      "datatype": "NUMERIC",
+      "allowsLists": true,
+      "rName": "search.thresholds",
+      "useInR": true,
+      "rOrderNum": 10
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "defaultValue": false,
+      "name": "LargeReferenceInput",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "If the reference table is huge compared to the target table, then passing true in this syntax element will make the reference table as 'Partition By any' instead of 'Dimension'.",
+      "description": "If the reference table is huge compared to the target table, then passing true in this syntax element will make the reference table as 'Partition By any' instead of 'Dimension'.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "largereference.input",
+      "useInR": true,
+      "rOrderNum": 11
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "defaultValue": false,
+      "name": "OutputSimilarity",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify true if the user wants similarity instead of distance.",
+      "description": "Specify true if the user wants similarity instead of distance.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "output.similarity",
+      "useInR": true,
+      "rOrderNum": 12
+    },
+    {
+      "defaultValue": 1,
+      "lowerBound": 1,
+      "upperBound": 4096,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "name": "EmbeddingSize",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify the embedding size of the vectors.",
+      "description": "Specify the embedding size of the vectors.",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "embedding.size",
+      "useInR": true,
+      "rOrderNum": 13
+    }
+  ]
+}

teradataml/data/jsons/storedprocedure/17.20/TD_COPYART.json

@@ -0,0 +1,71 @@
+{
+    "FuncName": "TD_COPYART",
+    "FuncDescriptionShort": "TD_COPYART creates a copy of existing ART table.",
+    "FuncDescriptionLong": [
+        "creates a copy of existing ART table with permanet or volatile option."
+    ],
+    "FunctionVersion": "...",
+    "FunctionCategory": "General Utility",
+    "JSONVersion": "1",
+    "FuncRName": "td_Copy_Art",
+    "MaxInputFiles": 0,
+    "Input": [],
+    "Output": [],
+    "Params": [      
+        {
+            "Name": "DST_DATABASENAME",
+            "Type": "string",
+            "Optional": false,
+            "Description": [
+                    "Name of the target database.",
+                    "Must include where TGT_TABLENAME need to be created."
+            ],
+            "LangName": "database_name"
+        },
+        {
+            "Name": "DST_TABLENAME",
+            "Type": "string",
+            "Optional": false,
+            "Description": [
+                    "Name of the target table."
+            ],
+            "LangName": "table_name"
+        },
+        {
+            "Name": "DST_MAPNAME",
+            "Type": "string",
+            "Optional": false,
+            "Description": [
+                    "[Optional] If not specified, the default map is used.",
+                    "Provided name of the map to be used for the copy."
+            ],
+            "LangName": "map_name"
+        },
+        {
+            "Name": "DST_ISPERMTABLE",
+            "Type": "string",
+            "Optional": true,
+            "PermittedValues": [
+                    "T",
+                    "TRUE",
+                    "F",
+                    "FALSE",
+                    "t",
+                    "true",
+                    "'true'",
+                    "'false'",
+                    "f",
+                    "false"
+            ],
+            "Description": [
+                    "[Optional] If not specified, the default is true.",
+                    "If true, the target table is permanent.",
+                    "If false, the target table is volatile."
+            ],
+            "LangName": "permanent_table"
+        }
+    ],
+    "IsPlottable": true,
+    "InputFmt": false,
+    "OutputFmt": false
+}

teradataml/data/jsons/tableoperator/17.20/IMAGE2MATRIX.json

@@ -0,0 +1,53 @@
+{
+"json_schema_major_version": "1",
+"json_schema_minor_version": "0",
+"json_content_version": "1",
+"function_name": "TD_IMAGE2MATRIX",
+"function_version": "1.0",
+"function_type": "table_operator",
+"function_alias_name": "Image2Matrix",
+"function_r_name": "aa.td_image2matrix",
+"ref_function_r_name": "aa.td_image2matrix",
+"supports_view": false,
+"short_description": "Converts an image to a matrix.",
+"long_description": "The function takes input with BLOBs that contain JPEG or PNG images. The image size cannot be greater than (16MB - 4096 bytes), and should not exceed 4,000,000 pixels.",
+"input_tables": [
+        {
+                "requiredInputKind": [
+                   "PartitionByKey"
+                ],
+                "isOrdered": false,
+                "isLocalOrdered": true,
+                "partitionByOne": false,
+                "hashByKey": true,
+                "name": "input",
+                "alternateNames": [],
+                "isRequired": true,
+                "rDescription": "Specifies the teradataml DataFrame containing the imageTable",
+                "description": "Specifies the table containing the input imageTable",
+                "datatype": "TABLE_ALIAS",
+                "allowsLists": false,
+                "rName": "data",
+                "useInR": true,
+                "rOrderNum": 1
+        }
+],
+"argument_clauses": [
+        {
+        "defaultValue": "gray",
+        "permittedValues": ["gray", "rgb"],
+        "isOutputColumn": false,
+        "alternateNames": [],
+        "name": "OUTPUT",
+        "isRequired": false,
+        "rDescription": "If the OUTPUT option is gray, then the output columns are Y, X, and GRAY, where GRAY is the gray image value. If the OUTPUT option is rgb, then the output columns are Y, X, RED, GREEN, and BLUE.",
+        "description": "If the OUTPUT option is gray, then the output columns are Y, X, and GRAY, where GRAY is the gray image value. If the OUTPUT option is rgb, then the output columns are Y, X, RED, GREEN, and BLUE.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "rName": "output",
+        "useInR": true,
+        "rOrderNum": 2
+        }
+      ]
+}
+    

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

@@ -11,7 +11,7 @@
         "MaxInputFiles": 1,
         "Input": [
                 {
-                        "Type": "SERIES",
+                        "Type": ["SERIES", "ART"],
                         "Description": [
                                 "This section outlines the syntax associated with invoking the TD_DICKEY_FULLER function.   The function takes in a single logical-runtime series as an input.  The series is only permitted to have univariate elements.  "
                         ],
@@ -47,19 +47,15 @@
                         "PermittedValues": [
                                 "NONE",
                                 "DRIFT",
-                                "TREND",
-                                "DRIFTNTREND",
-                                "FORMULA"
+                                "SQUARED",
+                                "DRIFTNTREND"
                         ],
                         "Description": [
                                 "An enumerated type with values of:  NONE, DRIFT, TREND, DRIFTNTREND, or FORMULA, which influences the type of regression that will be run for the test.",
-                                "NONE - Random Walk",
-                                "DRIFT - Random Walk with Drift",
-                                "TREND - Random Walk with Linear Trend",
-                                "DRIFTNTREND - Random Walk with Drift and Trend",
-                                "DRIFTNTREND & MAXLAGS - Random Walk with Drift and Trend and auxiliary lags",
-                                "FORMULA & MAXLAGS - Random Walk with roll-your-own on Drift and Trend; plus auxiliary lags"
-                        ]
+                                "NONE: Random walk",
+                                "DRIFT: Random walk with drift",
+                                "DRIFTNTREND: Random walk with drift and trend",
+                                "SQUARED: Random walk with drift, trend, and quadratic trend."]
                 },
                 {
                         "Name": "MAXLAGS",
@@ -67,19 +63,14 @@
                         "Optional": true,
                         "LowerBound": 0,
                         "LowerBoundType": "INCLUSIVE",
+                        "UpperBound": 100,
+                        "UpperBoundType": "INCLUSIVE",
+                        "DefaultValue": 0,
                         "AllowNaN": false,
                         "Description": [
                                 "The presence of the MAXLAGS parameter means the data scientist wishes to run the augmented Dickey-Fuller test. This is the maximum number of lags that will be used to form the regression equation. "
                         ],
                         "LangName": "max_lags"
-                },
-                {
-                        "Name": "DRIFT_TREND_FORMULA",
-                        "Type": "<td_formula>",
-                        "Optional": true,
-                        "Description": [
-                                "A Teradata formula string that stores the formula used to represent the drift and trend portions of the regression.  The formula is only valid when used in conjunction with ALGORITHM (FORMULA).    It uses the Teradata formula syntax and is expected to be of the form:  b_1 + b_2X_1 + b_3X_1^2 + … etc; which the UAF function interprets as: :  b_1 + b_2t + b_3t^2 + … etc   "
-                        ]
                 }
         ],
         "InputFmt": false,

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

@@ -47,6 +47,7 @@
                 "GLOBAL",
                 "SLIDING"
             ],
+            "DefaultValue": "GLOBAL",
             "Description": [
                 "[Optional] If not specified, the GLOBAL type is the default.",
                 "Specifies the window type used in the SAX transformation."
@@ -56,11 +57,12 @@
             "Name": "OUTPUT_TYPE",
             "Type": "string",
             "Optional": true,
-            "PermittedValues": [                               
+            "PermittedValues": [
                 "STRING",
                 "BITMAP",
                 "O_CHARS"
             ],
+            "DefaultValue": "STRING",
             "Description": [
                 "[Optional] If not specified, the STRING type is the default.",
                 "The output format of the result can be string, char or bitmap."

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

@@ -137,12 +137,14 @@
         {
                 "Name" : "WINDOW",
                 "Type" : "record",
+                "Optional" : true,
                 "Description": "",
                 "NestedParams" :
                 [
                     {
                         "Name" : "SIZE",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -231,6 +233,7 @@
                     {
                         "Name" : "EXPONENTIAL",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -256,6 +259,7 @@
                     {
                         "Name" : "GAUSSIAN",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -272,6 +276,7 @@
                     {
                         "Name" : "GENERAL_COSINE",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -289,6 +294,7 @@
                     {
                         "Name" : "GENERAL_GAUSSIAN",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -298,7 +304,7 @@
                                 "Optional" : true,
                                 "Description": [
                                 "The gaussian shape, and the value is 1. Required parameter when WINDOW(TYPE(GENERAL_GUASSIAN) is specified."
-                        ] 
+                        ]
                             },
                             {
                                 "Name" : "SIGMA",
@@ -306,13 +312,14 @@
                                 "Optional" : true,
                                 "Description": [
                                 "The standard deviation value. Required parameter when WINDOW(TYPE(GENERAL_GUASSIAN) is specified."
-                        ] 
+                        ]
                             }
                         ]
                     },
                     {
                         "Name" : "GENERAL_HAMMING",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -322,13 +329,14 @@
                                 "Optional" : true,
                                 "Description": [
                                 "The value of the window coefficient. Required parameter when WINDOW( TYPE( GENERAL_HAMMING ) is specified."
-                        ] 
+                        ]
                             }
                         ]
                     },
                     {
                         "Name" : "KAISER",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -338,12 +346,13 @@
                                 "Optional" : true,
                                 "Description": [
                                 "The value for the shape between the main lobe width and side lobe level. Required parameter when WINDOW(TYPE(KAISER)) is specified."
-                        ] 
+                        ]
                             }
                         ]
                     },
                     {
                         "Name" : "TAYLOR",
+                        "Optional" : true,
                         "Type" : "record",
                         "Description": "",
                         "NestedParams" :
@@ -381,6 +390,7 @@
                     {
                         "Name" : "TUKEY",
                         "Type" : "record",
+                        "Optional" : true,
                         "Description": "",
                         "NestedParams" :
                         [
@@ -397,4 +407,4 @@
                 ]
         }
     ]
-}
+}