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

teradataml/analytics/mle/SVMSparsePredict.py

@@ -1,553 +0,0 @@
-#!/usr/bin/python
-# ################################################################## 
-# 
-# Copyright 2018 Teradata. All rights reserved.
-# TERADATA CONFIDENTIAL AND TRADE SECRET
-# 
-# Primary Owner: Pankaj Purandare (pankajvinod.purandare@teradata.com)
-# Secondary Owner: Rohit Agrawal (rohit.agrawal@teradata.com)
-# 
-# Version: 1.2
-# Function Version: 1.7
-# 
-# ################################################################## 
-
-import inspect
-import time
-from teradataml.common.wrapper_utils import AnalyticsWrapperUtils
-from teradataml.common.utils import UtilFuncs
-from teradataml.context.context import *
-from teradataml.dataframe.dataframe import DataFrame
-from teradataml.common.aed_utils import AedUtils
-from teradataml.analytics.analytic_query_generator import AnalyticQueryGenerator
-from teradataml.common.exceptions import TeradataMlException
-from teradataml.common.messages import Messages
-from teradataml.common.messagecodes import MessageCodes
-from teradataml.common.constants import TeradataConstants
-from teradataml.dataframe.dataframe_utils import DataFrameUtils as df_utils
-from teradataml.options.display import display
-from teradataml.analytics.mle.SVMSparse import SVMSparse
-
-class SVMSparsePredict:
-    
-    def __init__(self,
-        object = None,
-        newdata = None,
-        sample_id_column = None,
-        attribute_column = None,
-        value_column = None,
-        accumulate_label = None,
-        output_response_probdist = True,
-        output_responses = None,
-        output_class_num = None,
-        newdata_sequence_column = None,
-        object_sequence_column = None,
-        newdata_partition_column = None,
-        newdata_order_column = None,
-        object_order_column = None):
-        """
-        DESCRIPTION:
-            The SVMSparsePredictor function takes the model generated by the
-            SVMSparse, a trainer function and a set of test samples (in sparse
-            format) and outputs a prediction for each sample.
-         
-            Note: This function is available only when teradataml is connected to
-                  Vantage 1.1 or later versions.
-         
-        PARAMETERS:
-            object:
-                Required Argument.
-                Specifies the teradataml DataFrame containing the model data
-                generated by SVMSparse or instance of SVMSparse, which contains
-                the model.
-            
-            object_order_column:
-                Optional Argument.
-                Specifies Order By columns for object.
-                Values to this argument can be provided as a list, if multiple
-                columns are used for ordering.
-                Types: str OR list of Strings (str)
-            
-            newdata:
-                Required Argument.
-                Specifies the teradataml DataFrame containing the input test data.
-            
-            newdata_partition_column:
-                Required Argument.
-                Specifies Partition By columns for newdata.
-                Values to this argument can be provided as a list, if multiple columns
-                are used for partition.
-                Types: str OR list of Strings (str)
-            
-            newdata_order_column:
-                Optional Argument.
-                Specifies Order By columns for newdata.
-                Values to this argument can be provided as a list, if multiple
-                columns are used for ordering.
-                Types: str OR list of Strings (str)
-            
-            sample_id_column:
-                Required Argument.
-                Specifies the name of the column in newdata, teradataml DataFrame
-                that contains the identifiers of the test samples. The data
-                must be partitioned by this column.
-                Types: str
-            
-            attribute_column:
-                Required Argument.
-                Specifies the name of the column in newdata, teradataml DataFrame
-                that contains the attributes of the test samples.
-                Types: str
-            
-            value_column:
-                Optional Argument.
-                Specifies the name of the column in newdata, teradataml DataFrame
-                that contains the attribute values. By default, each attribute
-                has the value 1.
-                Types: str
-            
-            accumulate_label:
-                Optional Argument.
-                Specifies the name of the column in newdata, teradataml DataFrame
-                to copy to the output table.
-                Types: str OR list of Strings (str)
-            
-            output_response_probdist:
-                Optional Argument.
-                Specifies whether to display output probability for the predicted 
-                category.
-                Note: "output_response_probdist" argument support is only available when
-                      teradataml is connected to Vantage 1.1.1 or later versions.
-                Default Value: True
-                Types: bool
-            
-            output_responses:
-                Optional Argument.
-                Specifies responses in the input table.
-                This argument can only be used when output_response_probdist is True.
-                Note:
-                    1. "output_responses" argument support is only available when teradataml is
-                       connected to Vantage 1.1.1 or later versions.
-                    2. "output_responses" can not be specified along with "output_class_num".
-                    3. This argument requires the "output_response_probdist" argument to be set to True.
-                Types: str OR list of Strings (str)
-            
-            output_class_num:
-                Optional Argument.
-                Valid only for multiple-class models. Specifies the number of class
-                labels to appear in the output table, with its corresponding
-                prediction confidence.
-                Note:
-                    1. With Vantage version prior to 1.1.1, the argument defaults to
-                       the value 1.
-                    2. "output_class_num" cannot be specified along with "output_responses".
-                Types: int
-            
-            newdata_sequence_column:
-                Optional Argument.
-                Specifies the list of column(s) that uniquely identifies each row of
-                the input argument "newdata". The argument is used to ensure
-                deterministic results for functions which produce results that vary
-                from run to run.
-                Types: str OR list of Strings (str)
-            
-            object_sequence_column:
-                Optional Argument.
-                Specifies the list of column(s) that uniquely identifies each row of
-                the input argument "object". The argument is used to ensure
-                deterministic results for functions which produce results that vary
-                from run to run.
-                Types: str OR list of Strings (str)
-         
-        RETURNS:
-            Instance of SVMSparsePredict.
-            Output teradataml DataFrames can be accessed using attribute
-            references, such as SVMSparsePredictObj.<attribute_name>.
-            Output teradataml DataFrame attribute name is: result
-         
-         
-        RAISES:
-            TeradataMlException
-         
-         
-        EXAMPLES:
-            # Load the data to run the example.
-            load_example_data("SVMSparsePredict",["svm_iris_input_train","svm_iris_input_test"])
-         
-            # Create teradataml DataFrame
-            svm_iris_input_train = DataFrame.from_table("svm_iris_input_train")
-            svm_iris_input_test = DataFrame.from_table("svm_iris_input_test")
-         
-            # Create SparseSVMTrainer object.
-            # SVMSparse takes training data, svm_iris_input_train, which contains four iris attributes
-            # (sepal length, sepal width, petal length, and petal width), grouped into three categories
-            # (setosa, versicolor, and virginica)  and outputs a predictive model.
-            svm_train = SVMSparse(data=svm_iris_input_train,
-                                sample_id_column='id',
-                                attribute_column='attribute',
-                                label_column='species',
-                                value_column='value1',
-                                max_step=150,
-                                seed=0,
-                                )
-         
-            # Example 1 - This example takes the model, svm_train, generated by the function SVMSparse
-            # and a set of test samples, svm_iris_input_test, and outputs a prediction for each sample.
-            svm_sparse_predict_result = SVMSparsePredict(newdata=svm_iris_input_test,
-                                                         newdata_partition_column=['id'],
-                                                         object=svm_train,
-                                                         attribute_column='attribute',
-                                                         sample_id_column='id',
-                                                         value_column='value1',
-                                                         accumulate_label='species'
-                                                         )
-         
-            # Print the result DataFrame
-            print(svm_sparse_predict_result.result)
-        
-        """
-        
-        # Start the timer to get the build time
-        _start_time = time.time()
-        
-        self.object  = object 
-        self.newdata  = newdata 
-        self.sample_id_column  = sample_id_column 
-        self.attribute_column  = attribute_column 
-        self.value_column  = value_column 
-        self.accumulate_label  = accumulate_label 
-        self.output_response_probdist  = output_response_probdist 
-        self.output_responses  = output_responses 
-        self.output_class_num  = output_class_num 
-        self.newdata_sequence_column  = newdata_sequence_column 
-        self.object_sequence_column  = object_sequence_column 
-        self.newdata_partition_column  = newdata_partition_column 
-        self.newdata_order_column  = newdata_order_column 
-        self.object_order_column  = object_order_column 
-        
-        # Create TeradataPyWrapperUtils instance which contains validation functions.
-        self.__awu = AnalyticsWrapperUtils()
-        self.__aed_utils = AedUtils()
-        
-        # Create argument information matrix to do parameter checking
-        self.__arg_info_matrix = []
-        self.__arg_info_matrix.append(["object", self.object, False, (DataFrame)])
-        self.__arg_info_matrix.append(["object_order_column", self.object_order_column, True, (str,list)])
-        self.__arg_info_matrix.append(["newdata", self.newdata, False, (DataFrame)])
-        self.__arg_info_matrix.append(["newdata_partition_column", self.newdata_partition_column, False, (str,list)])
-        self.__arg_info_matrix.append(["newdata_order_column", self.newdata_order_column, True, (str,list)])
-        self.__arg_info_matrix.append(["sample_id_column", self.sample_id_column, False, (str)])
-        self.__arg_info_matrix.append(["attribute_column", self.attribute_column, False, (str)])
-        self.__arg_info_matrix.append(["value_column", self.value_column, True, (str)])
-        self.__arg_info_matrix.append(["accumulate_label", self.accumulate_label, True, (str,list)])
-        self.__arg_info_matrix.append(["output_response_probdist", self.output_response_probdist, True, (bool)])
-        self.__arg_info_matrix.append(["output_responses", self.output_responses, True, (str,list)])
-        self.__arg_info_matrix.append(["output_class_num", self.output_class_num, True, (int)])
-        self.__arg_info_matrix.append(["newdata_sequence_column", self.newdata_sequence_column, True, (str,list)])
-        self.__arg_info_matrix.append(["object_sequence_column", self.object_sequence_column, True, (str,list)])
-        
-        if inspect.stack()[1][3] != '_from_model_catalog':
-            # Perform the function validations
-            self.__validate()
-            # Generate the ML query
-            self.__form_tdml_query()
-            # Execute ML query
-            self.__execute()
-            # Get the prediction type
-            self._prediction_type = self.__awu._get_function_prediction_type(self)
-        
-        # End the timer to get the build time
-        _end_time = time.time()
-        
-        # Calculate the build time
-        self._build_time = (int)(_end_time - _start_time)
-        
-    def __validate(self):
-        """
-        Function to validate sqlmr function arguments, which verifies missing 
-        arguments, input argument and table types. Also processes the 
-        argument values.
-        """
-        if isinstance(self.object, SVMSparse):
-            self.object = self.object._mlresults[0]
-
-        # Cannot use output_responses and output_class_num together
-        if self.output_responses is not None and self.output_class_num is not None:
-            raise TeradataMlException(
-                Messages.get_message(MessageCodes.EITHER_THIS_OR_THAT_ARGUMENT, "output_responses",
-                                     "output_class_num"),
-                MessageCodes.EITHER_THIS_OR_THAT_ARGUMENT)
-
-        # To use output_responses, output_response_probdist must be set to True
-        if self.output_response_probdist is False and self.output_responses is not None:
-            raise TeradataMlException(Messages.get_message(MessageCodes.DEPENDENT_ARG_MISSING,
-                                                           'output_response_probdist=True',
-                                                           'output_responses'),
-                                      MessageCodes.DEPENDENT_ARG_MISSING)
-
-        # Make sure that a non-NULL value has been supplied for all mandatory arguments
-        self.__awu._validate_missing_required_arguments(self.__arg_info_matrix)
-        
-        # Make sure that a non-NULL value has been supplied correct type of argument
-        self.__awu._validate_argument_types(self.__arg_info_matrix)
-
-        # Check to make sure input table types are strings or data frame objects or of valid type.
-        self.__awu._validate_input_table_datatype(self.newdata, "newdata", None)
-        self.__awu._validate_input_table_datatype(self.object, "object", SVMSparse)
-        
-        # Check whether the input columns passed to the argument are not empty.
-        # Also check whether the input columns passed to the argument valid or not.
-        self.__awu._validate_input_columns_not_empty(self.attribute_column, "attribute_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.attribute_column, "attribute_column", self.newdata, "newdata", False)
-        
-        self.__awu._validate_input_columns_not_empty(self.sample_id_column, "sample_id_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.sample_id_column, "sample_id_column", self.newdata, "newdata", False)
-        
-        self.__awu._validate_input_columns_not_empty(self.value_column, "value_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.value_column, "value_column", self.newdata, "newdata", False)
-        
-        self.__awu._validate_input_columns_not_empty(self.accumulate_label, "accumulate_label")
-        self.__awu._validate_dataframe_has_argument_columns(self.accumulate_label, "accumulate_label", self.newdata, "newdata", False)
-        
-        self.__awu._validate_input_columns_not_empty(self.newdata_sequence_column, "newdata_sequence_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.newdata_sequence_column, "newdata_sequence_column", self.newdata, "newdata", False)
-        
-        self.__awu._validate_input_columns_not_empty(self.object_sequence_column, "object_sequence_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.object_sequence_column, "object_sequence_column", self.object, "object", False)
-        
-        self.__awu._validate_input_columns_not_empty(self.newdata_partition_column, "newdata_partition_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.newdata_partition_column, "newdata_partition_column", self.newdata, "newdata", True)
-        
-        self.__awu._validate_input_columns_not_empty(self.newdata_order_column, "newdata_order_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.newdata_order_column, "newdata_order_column", self.newdata, "newdata", False)
-        
-        self.__awu._validate_input_columns_not_empty(self.object_order_column, "object_order_column")
-        self.__awu._validate_dataframe_has_argument_columns(self.object_order_column, "object_order_column", self.object, "object", False)
-        
-        
-    def __form_tdml_query(self):
-        """
-        Function to generate the analytical function queries. The function defines 
-        variables and list of arguments required to form the query.
-        """
-        
-        # Output table arguments list
-        self.__func_output_args_sql_names = []
-        self.__func_output_args = []
-        
-        # Model Cataloging related attributes.
-        self._sql_specific_attributes = {}
-        self._sql_formula_attribute_mapper = {}
-        self._target_column = None
-        self._algorithm_name = None
-        
-        # Generate lists for rest of the function arguments
-        self.__func_other_arg_sql_names = []
-        self.__func_other_args = []
-        self.__func_other_arg_json_datatypes = []
-        
-        self.__func_other_arg_sql_names.append("AttributeColumn")
-        self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(UtilFuncs._teradata_quote_arg(self.attribute_column, "\""), "'"))
-        self.__func_other_arg_json_datatypes.append("COLUMNS")
-        
-        self.__func_other_arg_sql_names.append("SampleIdColumn")
-        self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(UtilFuncs._teradata_quote_arg(self.sample_id_column, "\""), "'"))
-        self.__func_other_arg_json_datatypes.append("COLUMNS")
-        
-        if self.value_column is not None:
-            self.__func_other_arg_sql_names.append("ValueColumn")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(UtilFuncs._teradata_quote_arg(self.value_column, "\""), "'"))
-            self.__func_other_arg_json_datatypes.append("COLUMNS")
-        
-        if self.accumulate_label is not None:
-            self.__func_other_arg_sql_names.append("AccumulateLabel")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(UtilFuncs._teradata_quote_arg(self.accumulate_label, "\""), "'"))
-            self.__func_other_arg_json_datatypes.append("COLUMNS")
-        
-        if self.output_class_num is not None:
-            self.__func_other_arg_sql_names.append("OutputClassNum")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.output_class_num, "'"))
-            self.__func_other_arg_json_datatypes.append("INTEGER")
-        
-        if self.output_response_probdist is not None and self.output_response_probdist != True:
-            self.__func_other_arg_sql_names.append("OutputProb")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.output_response_probdist, "'"))
-            self.__func_other_arg_json_datatypes.append("BOOLEAN")
-        
-        if self.output_responses is not None:
-            self.__func_other_arg_sql_names.append("Responses")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.output_responses, "'"))
-            self.__func_other_arg_json_datatypes.append("STRING")
-        
-        # Generate lists for rest of the function arguments
-        sequence_input_by_list = []
-        if self.newdata_sequence_column is not None:
-            sequence_input_by_list.append("input:" + UtilFuncs._teradata_collapse_arglist(self.newdata_sequence_column, ""))
-        
-        if self.object_sequence_column is not None:
-            sequence_input_by_list.append("model:" + UtilFuncs._teradata_collapse_arglist(self.object_sequence_column, ""))
-        
-        if len(sequence_input_by_list) > 0:
-            self.__func_other_arg_sql_names.append("SequenceInputBy")
-            sequence_input_by_arg_value = UtilFuncs._teradata_collapse_arglist(sequence_input_by_list, "'")
-            self.__func_other_args.append(sequence_input_by_arg_value)
-            self.__func_other_arg_json_datatypes.append("STRING")
-            self._sql_specific_attributes["SequenceInputBy"] = sequence_input_by_arg_value
-        
-        
-        # Declare empty lists to hold input table information.
-        self.__func_input_arg_sql_names = []
-        self.__func_input_table_view_query = []
-        self.__func_input_dataframe_type = []
-        self.__func_input_distribution = []
-        self.__func_input_partition_by_cols = []
-        self.__func_input_order_by_cols = []
-        
-        # Process newdata
-        self.newdata_partition_column = UtilFuncs._teradata_collapse_arglist(self.newdata_partition_column, "\"")
-        self.__table_ref = self.__awu._teradata_on_clause_from_dataframe(self.newdata, False)
-        self.__func_input_distribution.append("FACT")
-        self.__func_input_arg_sql_names.append("input")
-        self.__func_input_table_view_query.append(self.__table_ref["ref"])
-        self.__func_input_dataframe_type.append(self.__table_ref["ref_type"])
-        self.__func_input_partition_by_cols.append(self.newdata_partition_column)
-        self.__func_input_order_by_cols.append(UtilFuncs._teradata_collapse_arglist(self.newdata_order_column, "\""))
-        
-        # Process object
-        self.__table_ref = self.__awu._teradata_on_clause_from_dataframe(self.object, False)
-        self.__func_input_distribution.append("DIMENSION")
-        self.__func_input_arg_sql_names.append("model")
-        self.__func_input_table_view_query.append(self.__table_ref["ref"])
-        self.__func_input_dataframe_type.append(self.__table_ref["ref_type"])
-        self.__func_input_partition_by_cols.append("NA_character_")
-        self.__func_input_order_by_cols.append(UtilFuncs._teradata_collapse_arglist(self.object_order_column, "\""))
-        
-        function_name = "SVMSparsePredict"
-        # Create instance to generate SQLMR.
-        self.__aqg_obj = AnalyticQueryGenerator(function_name, 
-                self.__func_input_arg_sql_names, 
-                self.__func_input_table_view_query, 
-                self.__func_input_dataframe_type, 
-                self.__func_input_distribution, 
-                self.__func_input_partition_by_cols, 
-                self.__func_input_order_by_cols, 
-                self.__func_other_arg_sql_names, 
-                self.__func_other_args, 
-                self.__func_other_arg_json_datatypes, 
-                self.__func_output_args_sql_names, 
-                self.__func_output_args, 
-                engine="ENGINE_ML")
-        # Invoke call to SQL-MR generation.
-        self.sqlmr_query = self.__aqg_obj._gen_sqlmr_select_stmt_sql()
-        
-        # Print SQL-MR query if requested to do so.
-        if display.print_sqlmr_query:
-            print(self.sqlmr_query)
-        
-        # Set the algorithm name for Model Cataloging.
-        self._algorithm_name = self.__aqg_obj._get_alias_name_for_function(function_name)
-        
-    def __execute(self):
-        """
-        Function to execute SQL-MR queries. 
-        Create DataFrames for the required SQL-MR outputs.
-        """
-        # Generate STDOUT table name and add it to the output table list.
-        sqlmr_stdout_temp_tablename = UtilFuncs._generate_temp_table_name(prefix="td_sqlmr_out_", use_default_database=True, gc_on_quit=True, quote=False)
-        try:
-            # Generate the output.
-            UtilFuncs._create_view(sqlmr_stdout_temp_tablename, self.sqlmr_query)
-        except Exception as emsg:
-            raise TeradataMlException(Messages.get_message(MessageCodes.TDMLDF_EXEC_SQL_FAILED, str(emsg)), MessageCodes.TDMLDF_EXEC_SQL_FAILED)
-        
-        # Update output table data frames.
-        self._mlresults = []
-        self.result = self.__awu._create_data_set_object(df_input=UtilFuncs._extract_table_name(sqlmr_stdout_temp_tablename), source_type="table", database_name=UtilFuncs._extract_db_name(sqlmr_stdout_temp_tablename))
-        self._mlresults.append(self.result)
-        
-    def show_query(self):
-        """
-        Function to return the underlying SQL query.
-        When model object is created using retrieve_model(), then None is returned.
-        """
-        return self.sqlmr_query
-        
-    def get_prediction_type(self):
-        """
-        Function to return the Prediction type of the algorithm.
-        When model object is created using retrieve_model(), then the value returned is 
-        as saved in the Model Catalog.
-        """
-        return self._prediction_type
-        
-    def get_target_column(self):
-        """
-        Function to return the Target Column of the algorithm.
-        When model object is created using retrieve_model(), then the value returned is 
-        as saved in the Model Catalog.
-        """
-        return self._target_column
-        
-    def get_build_time(self):
-        """
-        Function to return the build time of the algorithm in seconds.
-        When model object is created using retrieve_model(), then the value returned is 
-        as saved in the Model Catalog.
-        """
-        return self._build_time
-        
-    def _get_algorithm_name(self):
-        """
-        Function to return the name of the algorithm.
-        """
-        return self._algorithm_name
-        
-    def _get_sql_specific_attributes(self):
-        """
-        Function to return the dictionary containing the SQL specific attributes of the algorithm.
-        """
-        return self._sql_specific_attributes
-        
-    @classmethod
-    def _from_model_catalog(cls,
-        result = None,
-        **kwargs):
-        """
-        Classmethod is used by Model Cataloging, to instantiate this wrapper class.
-        """
-        kwargs.pop("result", None)
-        
-        # Model Cataloging related attributes.
-        target_column = kwargs.pop("__target_column", None)
-        prediction_type = kwargs.pop("__prediction_type", None)
-        algorithm_name = kwargs.pop("__algorithm_name", None)
-        build_time = kwargs.pop("__build_time", None)
-
-        # Let's create an object of this class.
-        obj = cls(**kwargs)
-        obj.result  = result 
-        
-        # Initialize the sqlmr_query class attribute.
-        obj.sqlmr_query = None
-        
-        # Initialize the SQL specific Model Cataloging attributes.
-        obj._sql_specific_attributes = None
-        obj._target_column = target_column
-        obj._prediction_type = prediction_type
-        obj._algorithm_name = algorithm_name
-        obj._build_time = build_time
-        
-        # Update output table data frames.
-        obj._mlresults = []
-        obj.result = obj.__awu._create_data_set_object(df_input=UtilFuncs._extract_table_name(obj.result), source_type="table", database_name=UtilFuncs._extract_db_name(obj.result))
-        obj._mlresults.append(obj.result)
-        return obj
-        
-    def __repr__(self):
-        """
-        Returns the string representation for a SVMSparsePredict class instance.
-        """
-        repr_string="############ STDOUT Output ############"
-        repr_string = "{}\n\n{}".format(repr_string,self.result)
-        return repr_string
-