teradataml 20.0.0.8__py3-none-any.whl

teradataml/data/levenshteindistance_example.json

@@ -0,0 +1,10 @@
+{
+ "levendist_input" : {
+                  
+                  "id" : "integer",
+                  "src_text1" : "varchar(20)",
+                  "src_text2" : "varchar(20)",
+                  "tar_text" : "varchar(20)"
+                  
+        }
+}

teradataml/data/linreg_example.json

@@ -0,0 +1,10 @@
+{
+  "housing_data": {
+    "housesize" : "bigint", 
+    "lotsize" : "bigint",
+    "bedrooms" : "int",
+    "granite" : "int",
+    "upgradedbathroom" : "int",
+    "sellingprice" : "bigint"    
+  }
+}

teradataml/data/load_example_data.py

@@ -0,0 +1,350 @@
+"""
+Unpublished work.
+Copyright (c) 2018 by Teradata Corporation. All rights reserved.
+TERADATA CORPORATION CONFIDENTIAL AND TRADE SECRET
+
+Primary Owner: mounika.kotha@teradata.com
+Secondary Owner:
+
+This file implements the functionality of loading data to a table.
+"""
+
+import csv
+import json
+import os
+import datetime
+from teradataml.common.constants import TeradataReservedKeywords
+from teradataml.common.exceptions import TeradataMlException
+from teradataml.common.messages import Messages
+from teradataml.common.messagecodes import MessageCodes
+from teradataml.context.context import *
+from teradataml.dataframe.copy_to import copy_to_sql
+import pandas as pd
+import numpy as np
+from teradataml import *
+from teradataml.options import display
+from teradataml.common.utils import UtilFuncs
+from teradataml.common.sqlbundle import SQLBundle
+import teradataml.context.context as tdmlctx
+from teradataml.context.context import _get_context_temp_databasename
+from collections import OrderedDict, defaultdict
+from teradataml.telemetry_utils.queryband import collect_queryband
+
+json_data = {}
+col_types_dict = {}
+curr_dir = os.path.dirname(os.path.abspath(__file__))
+
+
+@collect_queryband(queryband='LoadData')
+def load_example_data(function_name, table_name):
+    """
+    This function loads the data to the specified table. This is only used for
+    trying examples for the analytic functions, to load the required data.
+
+    Note:
+        Database used for loading table depends on the following conditions:
+        1. If the configuration option "temp_table_database" is set, then the
+           tables are loaded in the database specified in this option.
+        2. If the configuration option "temp_table_database" is not set and
+           "temp_database_name" parameter is used while creating context, then
+           the tables are loaded in the database specified in
+           "temp_database_name" parameter.
+        3. If none of them are specified then the tables are created in the
+           connecting users' default database or the connecting database.
+
+    PARAMETERS:
+        function_name:
+            Required Argument.
+            The argument contains the prefix name of the example json file to be used to load data.
+            Note: One must use the function_name values only as specified in the load_example_data()
+                  function calls specified in the example sections of teradataml API's. If any other
+                  string is passed as prefix input an error will be raised as 'prefix_str_example.json'
+                  file not found.
+            This *_example.json file contains the schema information for the tables that can be loaded
+            using this JSON file. Sample json containing table schema is as follows. Here we can
+            load three tables 'sentiment_extract_input', 'sentiment_word' and 'restaurant_reviews', with
+            <function_name>_exmaple.json, assuming file name is <function_name>_exmaple.json
+                {
+                    "sentiment_extract_input": {
+                        "id" : "integer",
+                        "product" : "varchar(30)",
+                        "category" : "varchar(10)",
+                        "review" : "varchar(1500)"
+                    },
+                    "sentiment_word": {
+                        "word" : "varchar(10)",
+                        "opinion" : "integer"
+                    },
+                    "restaurant_reviews": {
+                        "id" : "integer",
+                        "review_text" : "varchar(500)"
+                    }
+                }
+
+            Type : str
+
+        table_name
+            Required Argument.
+            Specifies the name of the table to be created in the database.
+            Note: Table names provided here must have an equivalent datatfile (CSV) present at
+                  teradataml/data. Schema information for the same must also be present in
+                  <function_name>_example.json as shown in 'function_name' argument description.
+            Type : string or list of str
+
+    EXAMPLES:
+        >>> from teradataml import *
+
+        # Example 1: When connection is created without "temp_database_name",
+        # table is loaded in users' default database.
+        >>> con = create_context(host = 'tdhost', username='tduser', password = 'tdpassword')
+        >>> load_example_data("pack", "ville_temperature")
+        # Create a teradataml DataFrame.
+        >>> df = DataFrame("ville_temperature")
+
+        # Example 2: When connection is created with "temp_database_name"
+        # parameter, tables are loaded in the database specified in
+        # "temp_database_name" parameter. This example also demonstrates loading
+        # multiple tables in a single function call.
+        >>> con = create_context(host = 'tdhost', username='tduser', password = 'tdpassword',
+                                temp_database_name = "temp_db")
+        >>> load_example_data("GLM", ["admissions_train", "housing_train"])
+        # Create teradataml DataFrames.
+        >>> admission_train = DataFrame(in_schema("temp_db", "admissions_train"))
+        >>> housing_train = DataFrame(in_schema("temp_db", "housing_train"))
+
+        # Example 3: When connection is created with "temp_database_name"
+        # parameter and configuration option "temp_table_database" is also
+        # specified, then the table is created in the database specified in the
+        # configuration option.
+        >>> con = create_context(host = 'tdhost', username='tduser', password = 'tdpassword',
+                                temp_database_name = "temp_db")
+        >>> configure.temp_table_database = "temp_db1"
+        >>> load_example_data("pack", "ville_temperature")
+        # Create a teradataml DataFrame.
+        >>> df = DataFrame(in_schema("temp_db1", "ville_temperature"))
+
+    RETURNS:
+        None.
+        
+    RAISES:
+        TeradataMlException - If table load fails.
+        FileNotFoundError - If invalid function_name is provided.
+    
+    """
+    # Check if context is created or not.
+    if get_connection() is None:
+        raise TeradataMlException(Messages.get_message(MessageCodes.INVALID_CONTEXT_CONNECTION),
+                                  MessageCodes.INVALID_CONTEXT_CONNECTION)
+
+    example_filename = os.path.join(curr_dir, "{}_example.json".format(function_name.lower()))
+    global json_data
+    
+    #Read json file to get table columns and datatypes
+    with open(format(example_filename)) as json_input:
+        json_data = json.load(json_input, object_pairs_hook = OrderedDict)
+
+    if isinstance(table_name, list) :
+        for table in table_name:
+            try:
+                __create_table_insert_data(table)
+            except TeradataMlException as err:
+                if err.code == MessageCodes.TABLE_ALREADY_EXISTS:
+                    # TODO - Use the improved way of logging messages when the right tools for it are built in
+                    print("WARNING: Skipped loading table {} since it already exists in the database.".format(table))
+                else:
+                    raise
+    else:
+        try:
+            __create_table_insert_data(table_name)
+        except TeradataMlException as err:
+            if err.code == MessageCodes.TABLE_ALREADY_EXISTS:
+                # TODO - Use the improved way of logging messages when the right tools for it are built in
+                print("WARNING: Skipped loading table {} since it already exists in the database.".format(table_name))
+            else:
+                raise
+
+    json_input.close()
+
+def __create_table_insert_data(tablename):
+    """
+    Function creates table and inserts data from csv into the table.
+    
+    PARAMETERS:
+        tablename:
+            Required Argument.
+            Specifies the name of the table to be created in the database.
+            Type : str
+     
+    EXAMPLES:
+         __create_table_insert_data("ville_temperature")
+         
+    RETURNS:
+         None.
+        
+    RAISES:
+         TeradataMlException - If table already exists in database.
+     """
+    csv_file = os.path.join(curr_dir, "{}.csv".format(tablename))
+    col_types_dict  = json_data[tablename]
+    column_dtypes = ''
+    date_time_varbyte = {}
+    pti_table = False
+    pti_clause = ""
+    td_number_of_columns= ''
+    column_names = ''
+    
+    '''
+    Create column datatype string required to create a table.
+    EXAMPLE:
+        id integer,model varchar(30)
+    '''
+    for column in col_types_dict.keys():
+        if column in ["TD_TIMECODE", "TD_SEQNO"]:
+            td_number_of_columns += '?,'
+            column_names += f"{column},"
+            continue
+
+        if column == "<PTI_CLAUSE>":
+            pti_table = True
+            pti_clause = col_types_dict[column]
+            continue
+
+        # Create a dictionary with column names as list of values which has 
+        # datatype as date, timestamp and varbyte.
+        # EXAMPLE : date_time_varbyte_columns = {'date':['orderdate']}
+        for column_type in ["date", "timestamp", "varbyte"]:
+            if column_type in col_types_dict[column]:
+                date_time_varbyte.setdefault(column_type, []).append(column)
+        quoted_column = f'"{column}"' if column.upper()  in TeradataReservedKeywords.TERADATA_RESERVED_WORDS.value  else column
+        column_dtypes ="{0}{1} {2},\n" .format(column_dtypes, quoted_column, col_types_dict[column])
+        if "PERIOD" in col_types_dict[column].upper() and tablename in ["Employee", "Employee_roles", "Employee_Address"]:
+            # Extract the type passed in PERIOD, e.g., PERIOD(DATE), PERIOD(TIMESTAMP)
+            if "AS TRANSACTIONTIME" in col_types_dict[column].upper():
+                continue
+            period_type = col_types_dict[column].upper().split("PERIOD(")[1].rsplit(")", 1)[0]
+            td_number_of_columns += f'PERIOD(CAST(? AS {period_type}),CAST(? AS {period_type})),'
+        else:
+            td_number_of_columns += '?,'
+
+         # Dynamically build column_names
+        if column != "<PTI_CLAUSE>" and "AS TRANSACTIONTIME" not in col_types_dict[column].upper():
+            column_names += f"{quoted_column},"
+    
+    column_names = column_names.rstrip(',')
+    # Deriving global connection using context.get_context()
+    con = get_connection()
+    # Get temporary database.
+    temp_db = _get_context_temp_databasename(table_type=
+                                             TeradataConstants.TERADATA_TABLE)
+    table_exists = con.dialect.has_table(con, tablename, schema=temp_db,
+                                         table_only=True)
+    if table_exists:
+        raise TeradataMlException(Messages.get_message(MessageCodes.TABLE_ALREADY_EXISTS, tablename),
+                                              MessageCodes.TABLE_ALREADY_EXISTS)   
+    else:
+        tablename = "{}.{}".format(UtilFuncs._teradata_quote_arg(_get_context_temp_databasename
+                                                                 (table_type=TeradataConstants.TERADATA_TABLE), "\"", False),
+                                   UtilFuncs._teradata_quote_arg(tablename, "\"", False))
+        if pti_table:
+            UtilFuncs._create_table_using_columns(tablename, column_dtypes[:-2], pti_clause)
+        else:
+            UtilFuncs._create_table_using_columns(tablename, column_dtypes[:-2])
+
+        try:
+            __insert_into_table_from_csv(tablename, td_number_of_columns[:-1], csv_file, date_time_varbyte, column_names)
+        except:
+            # Drop the table, as we have created the same.
+            UtilFuncs._drop_table(tablename)
+            raise
+
+
+def __insert_into_table_from_csv(tablename, column_markers, file, date_time_varbyte_columns, column_names):
+        """
+        Builds and executes a prepared statement with parameter markers for a table. 
+        
+        PARAMETERS:
+            tablename:
+                Required Argument.
+                Table name to insert data into.
+                Types: str
+
+            column_markers
+                Required Argument.
+                The parameter markers for the insert prepared statement.
+                Types: str
+
+            file
+                Required Argument.
+                csv file which contains data to be loaded into table.
+                Types: str
+
+            date_time_varbyte_columns
+                Required Argument.
+                Dictionary containing date, time and varbyte columns.
+                Types: Dictionary
+
+            column_names
+                Required Argument.
+                Comma separated string of column names to be inserted into table.
+                Types: str
+            
+        EXAMPLES:
+            date_time_varbyte_columns = {'date':['orderdate']}
+            preparedstmt = __insert_into_table_from_csv(
+                            'mytab', '?, ?','file.csv', date_time_varbyte_columns, column_names)
+
+        RETURNS:
+             None
+
+        RAISES:
+            Database error if an error occurred while executing the DDL statement.
+        
+        """
+        insert_stmt = SQLBundle._build_insert_into_table_records(tablename, column_markers, column_names)
+
+        # Defining the formatter.
+        formatter = {
+            "date": lambda op: datetime.datetime.strptime(op, '%Y-%m-%d'),
+            "timestamp": lambda op: datetime.datetime.strptime(op, '%Y-%m-%d %H:%M:%S'),
+            "timestamp(6)": lambda op: datetime.datetime.strptime(op, '%Y-%m-%d %H:%M:%S.%f'),
+            "varbyte": lambda op: bytes.fromhex(op)
+        }
+
+        if tdmlctx.td_connection is not None:
+            try:
+                with open (file, 'r') as f:
+                    reader = csv.reader(f)
+                    # Read headers of csv file
+                    headers = next(reader)
+
+                    insert_list = []
+                    for row in reader :
+                        # For NULL values, entries in csv are ""
+                        # Handling table with NULL values
+                        new_row = [] # Row with None when element is empty
+                        for element in row:
+                            if element == "":
+                                new_row.append(None)
+                            else:
+                                new_row.append(element)
+                        '''
+                        The data in the row is converted from string to date or 
+                        timestamp format, which is required to insert data into
+                        table for date or timestamp columns.
+                        '''
+                        for key, value in date_time_varbyte_columns.items():
+                            for val in value:
+                                if val in headers and new_row[headers.index(val)] is not None:
+                                    try:
+                                        new_row[headers.index(val)] = formatter[key](new_row[headers.index(val)])
+                                    except ValueError:
+                                        pass
+
+                        insert_list.append(tuple(new_row))
+                    # Batch Insertion (using DBAPI's executeMany) used here to insert list of dictionaries
+                    execute_sql(insert_stmt, insert_list)
+
+            except:
+                raise
+        else:
+            raise TeradataMlException(Messages.get_message(MessageCodes.CONNECTION_FAILURE), MessageCodes.CONNECTION_FAILURE)

teradataml/data/loan_prediction.csv

@@ -0,0 +1,295 @@
+"model_id","seq_id","seq_vertex_id","observed_id"
+1,1,0,"   1"
+1,1,1,"   1"
+1,1,2,"   1"
+1,1,3,"   1"
+1,1,4,"   1"
+1,1,5,"   1"
+1,1,6,"   1"
+1,1,7,"   1"
+1,1,8,"   1"
+1,1,9,"   1"
+1,1,10,"   1"
+1,1,11,"   1"
+1,1,12,"   4"
+1,1,13,"   5"
+1,1,14,"   6"
+1,1,15,"   6"
+1,1,16,"   6"
+1,1,17,"   7"
+1,2,0,"   1"
+1,2,1,"   1"
+1,2,2,"   1"
+1,2,3,"   1"
+1,2,4,"   1"
+1,2,5,"   1"
+1,2,6,"   1"
+1,2,7,"   1"
+1,2,8,"   1"
+1,2,9,"   1"
+1,2,10,"   3"
+1,2,11,"   4"
+1,2,12,"   5"
+1,2,13,"   6"
+1,2,14,"   6"
+1,2,15,"   6"
+1,2,16,"   6"
+1,2,17,"   6"
+1,2,18,"   6"
+1,2,19,"   6"
+1,2,20,"   6"
+1,2,21,"   6"
+1,2,22,"   6"
+1,2,23,"   7"
+1,3,0,"   1"
+1,3,1,"   1"
+1,3,2,"   2"
+1,3,3,"   4"
+1,3,4,"   5"
+1,3,5,"   6"
+1,3,6,"   6"
+1,3,7,"   6"
+1,3,8,"   7"
+1,4,0,"   1"
+1,4,1,"   1"
+1,4,2,"   1"
+1,4,3,"   1"
+1,4,4,"   1"
+1,4,5,"   1"
+1,4,6,"   1"
+1,4,7,"   1"
+1,4,8,"   2"
+1,4,9,"   4"
+1,4,10,"   4"
+1,4,11,"   4"
+1,4,12,"   6"
+1,4,13,"   7"
+1,5,0,"   1"
+1,5,1,"   1"
+1,5,2,"   1"
+1,5,3,"   1"
+1,5,4,"   1"
+1,5,5,"   1"
+1,5,6,"   1"
+1,5,7,"   1"
+1,5,8,"   3"
+1,5,9,"   4"
+1,5,10,"   5"
+1,5,11,"   6"
+1,5,12,"   6"
+1,5,13,"   6"
+1,5,14,"   6"
+1,5,15,"   7"
+1,6,0,"   1"
+1,6,1,"   1"
+1,6,2,"   1"
+1,6,3,"   1"
+1,6,4,"   2"
+1,6,5,"   4"
+1,6,6,"   5"
+1,6,7,"   6"
+1,6,8,"   6"
+1,6,9,"   6"
+1,6,10,"   6"
+1,6,11,"   6"
+1,6,12,"   6"
+1,6,13,"   6"
+1,6,14,"   6"
+1,6,15,"   6"
+1,6,16,"   7"
+1,7,0,"   1"
+1,7,1,"   1"
+1,7,2,"   3"
+1,7,3,"   1"
+1,7,4,"   3"
+1,7,5,"   4"
+1,7,6,"   5"
+1,7,7,"   6"
+1,7,8,"   6"
+1,7,9,"   6"
+1,7,10,"   6"
+1,7,11,"   7"
+1,8,0,"   1"
+1,8,1,"   1"
+1,8,2,"   1"
+1,8,3,"   1"
+1,8,4,"   1"
+1,8,5,"   3"
+1,8,6,"   4"
+1,8,7,"   5"
+1,8,8,"   6"
+1,8,9,"   6"
+1,8,10,"   6"
+1,8,11,"   6"
+1,8,12,"   6"
+1,8,13,"   6"
+1,8,14,"   6"
+1,8,15,"   6"
+1,8,16,"   6"
+1,8,17,"   6"
+1,8,18,"   6"
+1,8,19,"   7"
+1,9,0,"   1"
+1,9,1,"   1"
+1,9,2,"   1"
+1,9,3,"   3"
+1,9,4,"   4"
+1,9,5,"   5"
+1,9,6,"   6"
+1,9,7,"   6"
+1,9,8,"   7"
+1,10,0,"   1"
+1,10,1,"   1"
+1,10,2,"   1"
+1,10,3,"   1"
+1,10,4,"   1"
+1,10,5,"   1"
+1,10,6,"   1"
+1,10,7,"   1"
+1,10,8,"   1"
+1,10,9,"   1"
+1,10,10,"   1"
+1,10,11,"   1"
+1,10,12,"   1"
+1,10,13,"   1"
+1,10,14,"   1"
+1,10,15,"   1"
+1,10,16,"   1"
+1,10,17,"   1"
+1,10,18,"   3"
+1,10,19,"   4"
+1,10,20,"   5"
+1,10,21,"   7"
+2,1,0,"   1"
+2,1,1,"   1"
+2,1,2,"   1"
+2,1,3,"   1"
+2,1,4,"   1"
+2,1,5,"   1"
+2,1,6,"   1"
+2,1,7,"   1"
+2,1,8,"   1"
+2,1,9,"   1"
+2,1,10,"   1"
+2,1,11,"   1"
+2,1,12,"   8"
+2,60,0,"   1"
+2,60,1,"   1"
+2,60,2,"   1"
+2,60,3,"   1"
+2,60,4,"   1"
+2,60,5,"   1"
+2,60,6,"   2"
+2,60,7,"   8"
+2,61,0,"   1"
+2,61,1,"   1"
+2,61,2,"   1"
+2,61,3,"   1"
+2,61,4,"   1"
+2,61,5,"   1"
+2,61,6,"   1"
+2,61,7,"   3"
+2,61,8,"   4"
+2,61,9,"   3"
+2,61,10,"   4"
+2,61,11,"   5"
+2,61,12,"   8"
+2,105,0,"   1"
+2,105,1,"   1"
+2,105,2,"   1"
+2,105,3,"   1"
+2,105,4,"   1"
+2,105,5,"   1"
+2,105,6,"   1"
+2,105,7,"   1"
+2,105,8,"   1"
+2,105,9,"   1"
+2,105,10,"   1"
+2,105,11,"   3"
+2,105,12,"   1"
+2,105,13,"   1"
+2,105,14,"   1"
+2,105,15,"   1"
+2,105,16,"   1"
+2,105,17,"   1"
+2,105,18,"   1"
+2,105,19,"   1"
+2,105,20,"   1"
+2,105,21,"   1"
+2,105,22,"   8"
+2,115,0,"   1"
+2,115,1,"   1"
+2,115,2,"   1"
+2,115,3,"   1"
+2,115,4,"   1"
+2,115,5,"   1"
+2,115,6,"   1"
+2,115,7,"   1"
+2,115,8,"   1"
+2,115,9,"   1"
+2,115,10,"   8"
+2,2791,0,"   1"
+2,2791,1,"   1"
+2,2791,2,"   1"
+2,2791,3,"   1"
+2,2791,4,"   1"
+2,2791,5,"   1"
+2,2791,6,"   1"
+2,2791,7,"   1"
+2,2791,8,"   1"
+2,2791,9,"   1"
+2,2791,10,"   1"
+2,2791,11,"   1"
+2,2791,12,"   1"
+2,2791,13,"   1"
+2,2791,14,"   1"
+2,2791,15,"   2"
+2,2791,16,"   4"
+2,2791,17,"   8"
+2,2798,0,"   1"
+2,2798,1,"   1"
+2,2798,2,"   1"
+2,2798,3,"   1"
+2,2798,4,"   1"
+2,2798,5,"   1"
+2,2798,6,"   1"
+2,2798,7,"   1"
+2,2798,8,"   1"
+2,2798,9,"   3"
+2,2798,10,"   4"
+2,2798,11,"   1"
+2,2798,12,"   3"
+2,2798,13,"   4"
+2,2798,14,"   5"
+2,2798,15,"   6"
+2,2798,16,"   6"
+2,2798,17,"   6"
+2,2798,18,"   3"
+2,2798,19,"   8"
+2,2976,0,"   1"
+2,2976,1,"   1"
+2,2976,2,"   1"
+2,2976,3,"   1"
+2,2976,4,"   1"
+2,2976,5,"   1"
+2,2976,6,"   1"
+2,2976,7,"   1"
+2,2976,8,"   1"
+2,2976,9,"   1"
+2,2976,10,"   1"
+2,2976,11,"   1"
+2,2976,12,"   1"
+2,2976,13,"   1"
+2,2976,14,"   1"
+2,2976,15,"   1"
+2,2976,16,"   1"
+2,2976,17,"   1"
+2,2976,18,"   1"
+2,2976,19,"   1"
+2,2976,20,"   1"
+2,2976,21,"   2"
+2,2976,22,"   4"
+2,2976,23,"   5"
+2,2976,24,"   1"
+2,2976,25,"   3"
+2,2976,26,"   8"