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

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

@@ -12,6 +12,10 @@
   "long_description": "fastpath function to generate required statistics and scaling parameters to be used by TD_ScaleTransform for scaling the input data.",
   "input_tables": [
     {
+      "requiredInputKind": [
+        "PartitionByAny",
+        "PartitionByKey"
+      ],
       "isOrdered": false,
       "partitionByOne": false,
       "name": "InputTable",
@@ -24,6 +28,40 @@
       "rName": "data",
       "useInR": true,
       "rOrderNum": 1
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "ParameterTable",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "The relation that contains parameters.",
+      "description": "The relation that contains parameters.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "parameter.table",
+      "useInR": true,
+      "rOrderNum": 2
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "AttributeTable",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "The relation that contains input data.",
+      "description": "The relation that contains input data.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "attribute.table",
+      "useInR": true,
+      "rOrderNum": 3
     }
   ],
   "output_tables": [
@@ -39,7 +77,7 @@
       "allowsLists": false,
       "rName": "output.table",
       "useInR": true,
-      "rOrderNum": 2
+      "rOrderNum": 4
     }
   ],
   "argument_clauses": [
@@ -56,16 +94,16 @@
       "allowPadding": false,
       "name": "TargetColumns",
       "alternateNames": [],
-      "isRequired": true,
-      "rDescription": "Specifies the input table columns for which scaling parameters and statistics will be generated.",
-      "description": "Specifies the input table columns for which scaling parameters and statistics will be generated.",
+      "isRequired": false,
+      "rDescription": "Specifies the input table columns (for dense input) for which scaling parameters and statistics will be generated.",
+      "description": "Specifies the input table columns (for dense input) for which scaling parameters and statistics will be generated.",
       "datatype": "COLUMNS",
       "allowsLists": true,
       "rName": "target.columns",
       "useInR": true,
-      "rOrderNum": 3
+      "rOrderNum": 5
     },
-	{
+    {
       "permittedValues": [],
       "isOutputColumn": false,
       "matchLengthOfArgument": "",
@@ -79,9 +117,9 @@
       "allowsLists": true,
       "rName": "scale.method",
       "useInR": true,
-      "rOrderNum": 4
+      "rOrderNum": 6
     },
-	{
+    {
       "permittedValues": [
         "KEEP",
         "ZERO",
@@ -100,9 +138,9 @@
       "allowsLists": false,
       "rName": "miss.value",
       "useInR": true,
-      "rOrderNum": 5
+      "rOrderNum": 7
     },
-	{
+    {
       "defaultValue": false,
       "name": "GlobalScale",
       "alternateNames": [],
@@ -113,9 +151,9 @@
       "allowsLists": false,
       "rName": "global.scale",
       "useInR": true,
-      "rOrderNum": 6
+      "rOrderNum": 8
     },
-	{
+    {
       "permittedValues": [],
       "defaultValue": [
         "1"
@@ -132,9 +170,9 @@
       "allowsLists": true,
       "rName": "multiplier",
       "useInR": true,
-      "rOrderNum": 7
+      "rOrderNum": 9
     },
-	{
+    {
       "permittedValues": [],
       "defaultValue": [
         "0"
@@ -151,7 +189,122 @@
       "allowsLists": true,
       "rName": "intercept",
       "useInR": true,
-      "rOrderNum": 8
+      "rOrderNum": 10
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "ALL"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "PartitionColumns",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify the name of the input table columns on which to partition the input.",
+      "description": "Specify the name of the input table columns on which to partition the input.",
+      "datatype": "COLUMNS",
+      "allowsLists": true,
+      "rName": "partition.columns",
+      "useInR": true,
+      "rOrderNum": 11
+    },
+    {
+      "defaultValue": false,
+      "name": "IgnoreInvalidLocationScale",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify whether to ignore invalid values of location and scale parameters.",
+      "description": "Specify whether to ignore invalid values of location and scale parameters.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "ignoreinvalid.locationscale",
+      "useInR": true,
+      "rOrderNum": 12
+    },
+    {
+      "permittedValues": [
+        "UNSCALED",
+        "NULLIFY"
+      ],
+      "defaultValue": "UNSCALED",
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "UnusedAttributes",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify whether to emit out unused attributes of different partitions as unscaled values or NULLs (for dense input).",
+      "description": "Specify whether to emit out unused attributes of different partitions as unscaled values or NULLs (for dense input).",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "unused.attributes",
+      "useInR": true,
+      "rOrderNum": 13
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "CHAR", "VARCHAR"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "AttributeNameColumn",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the input table column which contains attribute names (required for sparse input).",
+      "description": "Specifies the input table column which contains attribute names (required for sparse input).",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "attribute.name.column",
+      "useInR": true,
+      "rOrderNum": 14
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "NUMERIC"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "AttributeValueColumn",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the input table column which contains attribute values (required for sparse input).",
+      "description": "Specifies the input table column which contains attribute values (required for sparse input).",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "attribute.value.column",
+      "useInR": true,
+      "rOrderNum": 15
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "TargetAttributes",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "A list of attributes for which scaling should be performed (for sparse input).",
+      "description": "A list of attributes for which scaling should be performed (for sparse input).",
+      "datatype": "STRING",
+      "allowsLists": true,
+      "rName": "target.attributes",
+      "useInR": true,
+      "rOrderNum": 16
     }
   ]
 }

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

@@ -13,6 +13,10 @@
   "long_description": "fastpath function to scale/standardize numeric columns.",
   "input_tables": [
     {
+      "requiredInputKind": [
+        "PartitionByAny",
+        "PartitionByKey"
+      ],
       "isOrdered": false,
       "partitionByOne": false,
       "name": "InputTable",
@@ -28,7 +32,8 @@
     },
     {
       "requiredInputKind": [
-        "Dimension"
+        "Dimension",
+        "PartitionByKey"
       ],
       "isOrdered": false,
       "partitionByOne": false,
@@ -66,6 +71,50 @@
       "rName": "accumulate",
       "useInR": true,
       "rOrderNum": 3
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "CHAR", "VARCHAR"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "AttributeNameColumn",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the input table column which contains attribute names (required for sparse input).",
+      "description": "Specifies the input table column which contains attribute names (required for sparse input).",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "attribute.name.column",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "NUMERIC"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "AttributeValueColumn",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the input table column which contains attribute values (required for sparse input).",
+      "description": "Specifies the input table column which contains attribute values (required for sparse input).",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "attribute.value.column",
+      "useInR": true,
+      "rOrderNum": 5
     }
   ]
 }

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

@@ -0,0 +1,222 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "1",
+  "json_content_version": "1",
+  "function_name": "TD_Shap",
+  "function_version": "1.0",
+  "commence_db_version": "",
+  "change_db_version": "",
+  "function_type": "fastpath",
+  "function_category": "Model Interpretation",
+  "function_alias_name": "TD_Shap",
+  "function_r_name": "aa.TD_Shap",
+  "ref_function_r_name": "aa.td_glm, aa.td_decisionforest, aa.td_xgboost",
+  "short_description": "Fast path function to get explanation for individual predictions (feature contributions) in a machine learning model",
+  "long_description": "Fast path function to get explanation for individual predictions (feature contributions) in a machine learning model based on the cooperative game theory optimal Shapley values.",
+  "input_tables": [
+    {
+      "name": "InputTable",
+      "isRequired": true,
+      "datatype": "TABLE_ALIAS",
+      "partitionByOne": false,
+      "isOrdered": false,
+      "omitPossible": false,
+      "alternateNames": [],
+      "rDescription": "Specifies the name of the table that contains input dataset.",
+      "description": "Specifies the name of the table that contains input dataset.",
+      "allowsLists": false,
+      "rName": "data",
+      "useInR": true,
+      "rOrderNum": 1
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "name": "ModelTable",
+      "isRequired": true,
+      "datatype": "TABLE_ALIAS",
+      "isOrdered": false,
+      "partitionByOne": false,
+      "rDescription": "Specifies the table containing the model data.",
+      "description": "Specifies the table containing the model data.",
+      "allowsLists": false,
+      "rName": "object",
+      "useInR": true,
+      "rFormulaUsage": false,
+      "rOrderNum": 2
+    }
+  ],
+    "output_tables": [
+    {
+      "name": "GlobalExplanation",
+      "isRequired": false,
+      "datatype": "TABLE_NAME",
+      "isOutputTable": true,
+      "omitPossible": false,
+      "alternateNames": [],
+      "rDescription": "Specifies the mean absolute shapley values for each input feature.",
+      "description": "Specifies the mean absolute shapley values for each input feature.",
+      "allowsLists": false,
+      "rName": "output.table",
+      "useInR": true,
+      "rOrderNum": 3
+    }
+  ],
+  "argument_clauses": [
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "NUMERIC"
+      ],
+      "name": "IDColumn",
+      "isRequired": true,
+      "datatype": "COLUMNS",
+      "requiredLength": 1,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "alternateNames": [],
+      "rDescription": "Specifies the name of the input table column that contains the IDColumn.",
+      "description": "Specify the name of the InputTable column that contains the unique value to identify the each sample.",
+      "allowsLists": false,
+      "rName": "id.column",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "permittedValues": [
+        "TD_GLM",
+        "TD_DECISIONFOREST",
+        "TD_XGBOOST"
+      ],
+      "name": "TrainingFunction",
+      "isRequired": true,
+      "datatype": "STRING",
+      "defaultValue": "TD_GLM",
+      "isOutputColumn": false,
+      "alternateNames": [],
+      "rDescription": "Specifies the model type name.",
+      "description": "Specifies the model type name on which we want to get explaination for individual predictions (feature contributions).",
+      "allowsLists": false,
+      "rName": "training.function",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "permittedValues": [
+        "REGRESSION",
+        "CLASSIFICATION"
+      ],
+      "name": "ModelType",
+      "isRequired": true,
+      "datatype": "STRING",
+      "defaultValue": "Regression",
+      "isOutputColumn": false,
+      "alternateNames": [],
+      "rDescription": "specifies the operation to be performed on input table.",
+      "description": "specifies the operation to be performed on input table based on target column",
+      "allowsLists": false,
+      "rName": "model.type",
+      "useInR": true,
+      "rOrderNum": 5
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "NUMERIC"
+      ],
+      "name": "InputColumns",
+      "isRequired": true,
+      "datatype": "COLUMNS",
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "alternateNames": [],
+      "rDescription": "Specify the names of the input table columns that need to be used for training the model (predictors, features or independent variables).",
+      "description": "Specify the names of the input table columns that need to be used for training the model (predictors, features or independent variables).",
+      "allowsLists": true,
+      "rName": "input.columns",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+      "name": "Detailed",
+      "isRequired": false,
+      "datatype": "BOOLEAN",
+      "isOutputColumn": false,
+      "defaultValue": false,
+      "alternateNames": [],
+      "rDescription": "Specifies whether to output detailed shap information about the forest trees.",
+      "description": "Specifies whether to output detailed shap information about the forest trees i.e. the decision tree and the specific tree information.",
+      "allowsLists": false,
+      "rName": "detailed",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "ALL"
+      ],
+      "name": "Accumulate",
+      "isRequired": false,
+      "datatype": "COLUMNS",
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "alternateNames": [],
+      "rDescription": "Specifies the names of the input columns to copy to the output table.",
+      "description": "Specifies the names of the input columns to copy to the output table.",
+      "allowsLists": true,
+      "rName": "accumulate",
+      "useInR": true,
+      "rOrderNum": 8
+    },
+    {
+      "name": "NumParallelTrees",
+      "isRequired": false,
+      "datatype": "INTEGER",
+      "defaultValue": 1000,
+      "lowerBound": 1,
+      "upperBound": 10000,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "alternateNames": [],
+      "rDescription": "Specify the number of parallel boosted trees.Each boosted tree operates on a sample of data that fits in an AMP's memory. By default, NumBoostedTrees is chosen equal to the number of AMPs with data.",
+      "description": "Specify the number of parallel boosted trees.Each boosted tree operates on a sample of data that fits in an AMP's memory. By default, NumBoostedTrees is chosen equal to the number of AMPs with data.",
+      "allowsLists": false,
+      "rName": "num.parallel.trees",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "name": "NumBoostRounds",
+      "isRequired": false,
+      "datatype": "INTEGER",
+      "defaultValue": 10,
+      "lowerBound": 1,
+      "upperBound": 100000,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "alternateNames": [],
+      "rDescription": "Specifies the number of iterations to boost the weak classifiers. The iterations must be an INTEGER in the range [1, 100000].",
+      "description": "Specifies the number of iterations to boost the weak classifiers. The iterations must be an INTEGER in the range [1, 100000].",
+      "allowsLists": false,
+      "rName": "num.boost.rounds",
+      "useInR": true,
+      "rOrderNum": 10
+    }
+  ]
+}