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

teradataml/data/jsons/sqle/17.20/TD_TFIDF.json

@@ -0,0 +1,162 @@
+{
+    "json_schema_major_version": "1",
+    "json_schema_minor_version": "1",
+    "json_content_version": "1",
+    "function_name": "TD_TFIDF",
+    "function_version": "1.0",
+    "function_type": "fastpath",
+    "function_category": "Feature Engineering Transform",
+    "function_alias_name": "TD_TFIDF",
+    "function_r_name": "td.tfidf",
+    "short_description": "This function is used to take any document set and compute the Term Frequency (TF), Inverse Document Frequency (IDF), and Term Frequency * Inverse Document Frequency (TF-IDF) scores for each term.",
+    "long_description": "This function is used to take any document set and compute the Term Frequency (TF), Inverse Document Frequency (IDF), and Term Frequency * Inverse Document Frequency (TF-IDF) scores for each term.",
+    "input_tables": [
+      {
+        "requiredInputKind": [
+          "PartitionByAny"
+        ],
+        "isOrdered": false,
+        "partitionByOne": false,
+        "name": "InputTable",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "The table that contains the document id and the term.",
+        "description": "The table that contains the document id and the term.",
+        "datatype": "TABLE_ALIAS",
+        "allowsLists": false,
+        "rName": "data",
+        "useInR": true,
+        "rOrderNum": 1
+      }
+    ],
+    "argument_clauses": [
+      {
+        "targetTable": [
+          "InputTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": [],
+        "allowedTypeGroups": [
+          "INTEGER"
+        ],
+        "requiredLength": 1,
+        "matchLengthOfArgument": "",
+        "allowPadding": true,
+        "name": "DocIdColumn",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "Specifies the name of the input table column that contains the document identifier.",
+        "description": "Specifies the name of the input table column that contains the document identifier.",
+        "datatype": "COLUMN_NAMES",
+        "allowsLists": false,
+        "rName": "doc.id.column",
+        "useInR": true,
+        "rOrderNum": 2
+      },
+      {
+        "targetTable": [
+          "InputTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": [],
+        "allowedTypeGroups": [
+          "STRING"
+        ],
+        "requiredLength": 1,
+        "matchLengthOfArgument": "",
+        "allowPadding": true,
+        "name": "TokenColumn",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "Specifies the name of the input table column that contains the tokens.",
+        "description": "Specifies the name of the input table column that contains the tokens.",
+        "datatype": "COLUMN_NAMES",
+        "allowsLists": false,
+        "rName": "token.column",
+        "useInR": true,
+        "rOrderNum": 3
+      },
+      {
+        "permittedValues": [
+          "BOOL",
+          "COUNT",
+          "NORMAL",
+          "LOG",
+          "AUGMENT"
+        ],
+        "defaultValue": "NORMAL",
+        "isOutputColumn": false,
+        "name": "TFNormalization",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specifies the normalization method for calculating the term frequency (TF). Default: 'NORMAL'.",
+        "description": "Specifies the normalization method for calculating the term frequency (TF). Default: 'NORMAL'.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "rName": "tf.normalization",
+        "useInR": true,
+        "rOrderNum": 4
+      },
+      {
+        "permittedValues": [
+          "UNARY",
+          "LOG",
+          "LOGNORM",
+          "SMOOTH"
+        ],
+        "defaultValue": "LOG",
+        "isOutputColumn": false,
+        "name": "IDFNormalization",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specifies the normalization method for calculating the inverse document frequency (IDF). Default: 'LOG'.",
+        "description": "Specifies the normalization method for calculating the inverse document frequency (IDF). Default: 'LOG'.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "rName": "idf.normalization",
+        "useInR": true,
+        "rOrderNum": 5
+      },
+      {
+        "permittedValues": [
+          "L2",
+          "L1",
+          "NONE"
+        ],
+        "defaultValue": "NONE",
+        "isOutputColumn": false,
+        "name": "Regularization",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specifies the regularization method for calculating the TF-IDF score. Default: 'NONE'.",
+        "description": "Specifies the regularization method for calculating the TF-IDF score. Default: 'NONE'.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "rName": "regularization",
+        "useInR": true,
+        "rOrderNum": 6
+      },
+      {
+        "targetTable": [
+          "InputTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": [],
+        "allowedTypeGroups": [
+          "ALL"
+        ],
+        "matchLengthOfArgument": "",
+        "allowPadding": true,
+        "name": "Accumulate",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specifies the names of the input table columns to copy to the output table.",
+        "description": "Specifies the names of the input table columns to copy to the output table.",
+        "datatype": "COLUMNS",
+        "allowsLists": true,
+        "rName": "accumulate",
+        "useInR": true,
+        "rOrderNum": 7
+      }
+    ]
+  }

teradataml/data/jsons/sqle/17.20/TD_Unpivoting.json

@@ -0,0 +1,235 @@
+{
+    "json_schema_major_version": "1",
+    "json_schema_minor_version": "1",
+    "json_content_version": "1",
+    "function_name": "TD_Unpivoting",
+    "function_version": "1.0",
+    "function_alias_name": "TD_Unpivoting",
+    "function_type": "fastpath",
+    "function_category": "Feature Engineering Transform",
+    "function_r_name": "aa.td.unpivoting",
+    "short_description": "This function is used to unpivot the data i.e. change the data from dense format to sparse format.",
+    "long_description": "This function is used to unpivot the data i.e. change the data from dense format to sparse format.",
+    "input_tables": [
+      {
+        "requiredInputKind": [
+          "PartitionByAny"
+        ],
+        "isOrdered": false,
+        "partitionByOne": false,
+        "name": "InputTable",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "Specifies the table containing the input data to be unpivoted.",
+        "description": "Specifies the table containing the input data to be unpivoted.",
+        "datatype": "TABLE_ALIAS",
+        "allowsLists": false,
+        "rName": "data",
+        "useInR": true,
+        "rOrderNum": 1
+      }
+    ],
+    "argument_clauses": [
+      {
+        "targetTable": [
+          "InputTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": [],
+        "allowedTypeGroups": [
+          "ALL"
+        ],
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "name": "IDColumn",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "Specify the column which contains the input data identifier.",
+        "description": "Specify the column which contains the input data identifier.",
+        "datatype": "COLUMNS",
+        "allowsLists": false,
+        "rName": "id.column",
+        "useInR": true,
+        "rOrderNum": 2
+      },
+      {
+        "targetTable": [
+          "InputTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": [],
+        "allowedTypeGroups": [
+          "ALL"
+        ],
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "name": "TargetColumns",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "Specify the columns from the input table which contains the data for unpivoting.",
+        "description": "Specify the columns from the input table which contains the data for unpivoting.",
+        "datatype": "COLUMNS",
+        "allowsLists": true,
+        "rName": "target.columns",
+        "useInR": true,
+        "rOrderNum": 3
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": false,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "name": "AttributeAliasList",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify alternate names for the values in the AttributeName output column.",
+        "description": "Specify alternate names for the values in the AttributeName output column.",
+        "datatype": "STRING",
+        "allowsLists": true,
+        "rName": "alias.names",
+        "useInR": true,
+        "rOrderNum": 4
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": true,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "defaultValue": "AttributeName",
+        "name": "AttributeColName",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify output column name for AttributeName column.",
+        "description": "Specify output column name for AttributeName column.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "rName": "attribute.column",
+        "useInR": true,
+        "rOrderNum": 5
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": true,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "defaultValue": "AttributeValue",
+        "name": "ValueColName",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify output column name for AttributeValue column.",
+        "description": "Specify output column name for AttributeValue column.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "rName": "value.column",
+        "useInR": true,
+        "rOrderNum": 6
+      },
+      {
+        "targetTable": [
+          "InputTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": [],
+        "allowedTypeGroups": [
+          "ALL"
+        ],
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "name": "Accumulate",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specifies the input table columns to copy to the output table. By default, the function copies no input table columns to the output table.",
+        "description": "Specifies the input table columns to copy to the output table. By default, the function copies no input table columns to the output table.",
+        "datatype": "COLUMNS",
+        "allowsLists": true,
+        "rName": "accumulate",
+        "useInR": true,
+        "rOrderNum": 7
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": false,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "defaultValue": false,
+        "name": "IncludeNulls",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify whether or not to include nulls in the transformation.",
+        "description": "Specify whether or not to include nulls in the transformation.",
+        "datatype": "BOOLEAN",
+        "allowsLists": false,
+        "rName": "include.nulls",
+        "useInR": true,
+        "rOrderNum": 8
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": false,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "defaultValue": false,
+        "name": "InputTypes",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify true, if instead of one column for all attribute values, need multiple columns corresponding to data type groups.",
+        "description": "Specify true, if instead of one column for all attribute values, need multiple columns corresponding to data type groups.",
+        "datatype": "BOOLEAN",
+        "allowsLists": false,
+        "rName": "input.types",
+        "useInR": true,
+        "rOrderNum": 9
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": false,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "defaultValue": false,
+        "name": "OutputVarchar",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify true if there is a need to output the AttributeValue column in varchar format irrespective of it's data type.",
+        "description": "Specify true if there is a need to output the AttributeValue column in varchar format irrespective of it's data type.",
+        "datatype": "BOOLEAN",
+        "allowsLists": false,
+        "rName": "output.varchar",
+        "useInR": true,
+        "rOrderNum": 10
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": false,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "defaultValue": false,
+        "name": "IndexedAttribute",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify true if there is a need to output the column indexes instead of column names in AttributeName column",
+        "description": "Specify true if there is a need to output the column indexes instead of column names in AttributeName column",
+        "datatype": "BOOLEAN",
+        "allowsLists": false,
+        "rName": "indexed.attribute",
+        "useInR": true,
+        "rOrderNum": 11
+      },
+      {
+        "permittedValues": [],
+        "isOutputColumn": false,
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "defaultValue": false,
+        "name": "IncludeDataTypes",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify true to output the original data type name.",
+        "description": "Specify true to output the original data type name.",
+        "datatype": "BOOLEAN",
+        "allowsLists": false,
+        "rName": "include.datatypes",
+        "useInR": true,
+        "rOrderNum": 12
+      }
+    ]
+  }

teradataml/data/jsons/sqle/17.20/TD_XGBoost.json

@@ -1,9 +1,9 @@
 {
   "json_schema_major_version": "1",
-  "json_schema_minor_version": "3",
+  "json_schema_minor_version": "4",
   "json_content_version": "1",
   "function_name": "TD_XGBoost",
-  "function_version": "1.3",
+  "function_version": "1.4",
   "function_type": "fastpath",
   "function_category": "Model Training",
   "function_alias_name": "TD_XGBoost",
@@ -145,7 +145,7 @@
       "rName": "min.node.size",
       "useInR": true,
       "rOrderNum": 5
-    },    
+    },
     {
       "defaultValue": 1,
       "lowerBound": -2147483648,
@@ -166,7 +166,7 @@
     },
     {
       "permittedValues": [
-        "REGRESSION", 
+        "REGRESSION",
         "CLASSIFICATION"
       ],
       "defaultValue": "REGRESSION",
@@ -219,7 +219,7 @@
       "rOrderNum": 9
     },
     {
-      "defaultValue": 100000,
+      "defaultValue": 1,
       "lowerBound": 0,
       "upperBound": 100000,
       "lowerBoundType": "INCLUSIVE",
@@ -237,7 +237,7 @@
       "rOrderNum": 10
     },
     {
-      "defaultValue": 0.1,
+      "defaultValue": 0.5,
       "lowerBound": 1e-10,
       "upperBound": 1,
       "lowerBoundType": "INCLUSIVE",
@@ -307,6 +307,24 @@
       "rName": "tree.size",
       "useInR": true,
       "rOrderNum": 14
+    },
+    {
+      "defaultValue": 0,
+      "lowerBound": -1e50,
+      "upperBound": 1e50,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "name": "BaseScore",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify the initial prediction value for all data points.",
+      "description": "Specify the initial prediction value for all data points.",
+      "datatype": "DOUBLE",
+      "allowsLists": false,
+      "rName": "base.score",
+      "useInR": true,
+      "rOrderNum": 15
     }
   ]
-}
+}

teradataml/data/jsons/sqle/17.20/TD_XGBoostPredict.json

@@ -79,7 +79,7 @@
       "lowerBoundType": "EXCLUSIVE",
       "upperBoundType": "INCLUSIVE",
       "allowNaN": false,
-      "name": "NumBoostedTrees",
+      "name": "NumParallelTrees",
       "alternateNames": [], 
       "isRequired": false,
       "defaultValue": 1000,
@@ -97,10 +97,10 @@
       "lowerBoundType": "EXCLUSIVE",
       "upperBoundType": "INCLUSIVE",
       "allowNaN": false,
-      "name": "IterNum",
+      "name": "NumBoostRounds",
       "alternateNames": [], 
       "isRequired": false,
-      "defaultValue": 3,
+      "defaultValue": 10,
       "rDescription": "Specify number of iterations within a boosted trees to be loaded from model table", 
       "description": "Specify number of iterations within a boosted trees to be loaded from model table",
       "datatype": "NUMERIC",
@@ -177,6 +177,19 @@
       "rName": "output.responses",
       "useInR": true,
       "rOrderNum": 9
+    },
+    {
+      "defaultValue": false,
+      "name": "Detailed",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether to output detailed information of each prediction.",
+      "description": "Specifies whether to output detailed information of each prediction.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "detailed",
+      "useInR": true,
+      "rOrderNum": 10
     }
   ]
-}
+}