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

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/20.00/TD_KMeans.json

@@ -0,0 +1,250 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "1",
+  "json_content_version": "1",
+  "function_name": "TD_KMeans",
+  "function_version": "1.0",
+  "function_type": "fastpath",
+  "function_category": "Model Training",
+  "function_alias_name": "TD_KMeans",
+  "function_r_name": "aa.td_kmeans",
+  "short_description": "fastpath function to generate clustering model using KMeans algorithm.",
+  "long_description": "fastpath function to generate clustering model containing cluster centroids using KMeans algorithm.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+        "PartitionByAny"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "InputTable",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "The relation that contains input data.",
+      "description": "The relation that contains input data.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data",
+      "useInR": true,
+      "rOrderNum": 1
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "InitialCentroidsTable",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "The relation that contains set of initial centroids.",
+      "description": "The relation that contains set of initial centroids.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "centroids.table",
+      "useInR": true,
+      "rOrderNum": 2
+    }
+  ],
+  "output_tables": [
+    {
+      "isOutputTable": true,
+      "omitPossible": true,
+      "name": "ModelTable",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the name of the table in which the generated KMeans model can be stored.",
+      "description": "Specifies the name of the table in which the generated KMeans model can be stored.",
+      "datatype": "TABLE_NAME",
+      "allowsLists": false,
+      "rName": "model.table",
+      "useInR": true,
+      "rOrderNum": 3
+    }
+  ],
+  "argument_clauses": [
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "ALL"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "IdColumn",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the column which is unique identifier of input row.",
+      "description": "Specifies the column which is unique identifier of input row.",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "id.column",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "targetTable": [
+        "InputTable"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "NUMERIC","AIVECTOR","BYTE","VARBYTE"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "TargetColumns",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the columns/features to be used to cluster the data.",
+      "description": "Specifies the columns/features to be used to cluster the data.",
+      "datatype": "COLUMNS",
+      "allowsLists": true,
+      "rName": "target.columns",
+      "useInR": true,
+      "rOrderNum": 5
+    },
+    {
+      "lowerBound": 1,
+      "upperBound": 2147483647,
+      "lowerBoundType": "EXCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "name": "NumClusters",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the number of clusters to be produced. This argument is not allowed with InitialCentroidsTable provided.",
+      "description": "Specifies the number of clusters to be produced. This argument is not allowed with InitialCentroidsTable provided.",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "num.clusters",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+      "lowerBound": 0,
+      "upperBound": 2147483647,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "name": "Seed",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify the random seed the algorithm uses for repeatable results. The algorithm uses the seed to randomly sample the input table rows as initial clusters.",
+      "description": "Specify the random seed the algorithm uses for repeatable results. The algorithm uses the seed to randomly sample the input table rows as initial clusters.",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "seed",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "defaultValue": 0.0395,
+      "lowerBound": 0,
+      "upperBound": 1.797e+308,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "name": "StopThreshold",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify the convergence threshold. When the centroids move by less than this amount, the algorithm has converged.",
+      "description": "Specify the convergence threshold. When the centroids move by less than this amount, the algorithm has converged.",
+      "datatype": "DOUBLE",
+      "allowsLists": false,
+      "rName": "threshold",
+      "useInR": true,
+      "rOrderNum": 8
+    },
+    {
+      "defaultValue": 10,
+      "lowerBound": 1,
+      "upperBound": 2147483647,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "name": "MaxIterNum",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specify the maximum number of iterations that the algorithm runs before quitting if the convergence threshold has not been met.",
+      "description": "Specify the maximum number of iterations that the algorithm runs before quitting if the convergence threshold has not been met.",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "iter.max",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "defaultValue": 1,
+      "lowerBound": 1,
+      "upperBound": 2147483647,
+      "lowerBoundType": "INCLUSIVE",
+      "upperBoundType": "INCLUSIVE",
+      "allowNaN": false,
+      "name": "NumInit",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "The number of times, the k-means algorithm will be run with different initial centroid seeds. The function will emit out the model having the least value of Total Within Cluster Squared Sum.",
+      "description": "The number of times, the k-means algorithm will be run with different initial centroid seeds. The function will emit out the model having the least value of Total Within Cluster Squared Sum.",
+      "datatype": "INTEGER",
+      "allowsLists": false,
+      "rName": "num.init",
+      "useInR": true,
+      "rOrderNum": 10
+    },
+    {
+      "defaultValue": false,
+      "name": "OutputClusterAssignment",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies whether to output Cluster Assignment.",
+      "description": "Specifies whether to output Cluster Assignment.",
+      "datatype": "BOOLEAN",
+      "allowsLists": false,
+      "rName": "output.cluster.assignment",
+      "useInR": true,
+      "rOrderNum": 11
+    },
+    {
+      "permittedValues": [
+        "RANDOM",
+        "KMEANS++"
+      ],
+      "defaultValue": "RANDOM",
+      "isOutputColumn": false,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "InitialCentroidsMethod",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Specifies the initialization method to be used for selecting initial set of centroids.",
+      "description": "Specifies the initialization method to be used for selecting initial set of centroids.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "initialcentroids.method",
+      "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
+    }
+  ]
+}