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

teradataml/analytics/mle/LDATopicSummary.py

@@ -1,464 +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: Mounika Kotha (mounika.kotha@teradata.com)
-# 
-# Version: 1.2
-# Function Version: 1.4
-# 
-# ################################################################## 
-
-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.LDA import LDA
-
-class LDATopicSummary:
-    
-    def __init__(self,
-        object = None,
-        summary = False,
-        out_topicwordnum = "all",
-        word_weight = False,
-        word_count = False,
-        out_byword = True,
-        object_sequence_column = None,
-        object_order_column = None):
-        """
-        DESCRIPTION:
-            The LDATopicSummary function displays in readable form information
-            from the binary model teradataml DataFrame generated by the function
-            LDA.
-         
-         
-        PARAMETERS:
-            object:
-                Required Argument.
-                Specifies the name of the model teradataml DataFrame generated
-                by the function LDA or instance of LDA, which contains the
-                model.
-         
-            object_order_column:
-                Required Argument.
-                Specifies Order By columns for "object".
-                Values to this argument can be provided as list, if multiple
-                columns are used for ordering.
-                Types: str OR list of Strings (str)
-         
-            summary:
-                Optional Argument.
-                Specifies whether to display only a summary of the information
-                in the model table.
-                Default Value: False
-                Types: bool
-         
-            out_topicwordnum:
-                Optional Argument.
-                Specifies the number of top topic words and their topic identifiers
-                to include in the output teradataml DataFrame for each training
-                document. The value out_topicwordnum must be either a positive
-                integer or the string "all". The value "all", specifies all
-                topic words and their topic identifiers.
-                Default Value: "all"
-                Types: str
-         
-            word_weight:
-                Optional Argument.
-                Specifies whether to display the weight (probability of occurrence)
-                of each unique word in each topic. The weights for the unique words
-                in each topic are normalized to 1.
-                Default Value: False
-                Types: bool
-         
-            word_count:
-                Optional Argument.
-                Specifies whether to display the count (number of occurrences)
-                of each unique word in each topic. Topic distribution is
-                factored into word counts.
-                Default Value: False
-                Types: bool
-         
-            out_byword:
-                Optional Argument.
-                Specifies whether to display each topic-word pair in its own row. If
-                you specify "false", each row contains a unique topic and all words
-                that occur in that topic, separated by commas.
-                Default Value: True
-                Types: bool
-         
-            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 LDATopicSummary.
-            Output teradataml DataFrames can be accessed using attribute
-            references, such as LDATopicSummaryObj.<attribute_name>.
-            Output teradataml DataFrame attribute name is:
-                result
-         
-         
-        RAISES:
-            TeradataMlException
-         
-         
-        EXAMPLES:
-            # Load example data.
-            load_example_data("LDATopicSummary", "complaints_traintoken")
-         
-            # Create teradataml DataFrame objects.
-            complaints_traintoken = DataFrame.from_table("complaints_traintoken")
-         
-            # Example 1 - Build a model using LDA and use it's output as direct
-            # input to LDATopicSummary
-            lda_out = LDA(data = complaints_traintoken,
-                          topic_num = 5,
-                          docid_column = "doc_id",
-                          word_column = "token",
-                          count_column = "frequency",
-                          maxiter = 30,
-                          convergence_delta = 1e-3,
-                          seed = 2
-                          )
-         
-            LDATopicSummary_out1 = LDATopicSummary(object=lda_out,
-                                     summary=False,
-                                     out_topicwordnum='all',
-                                     word_weight=False,
-                                     word_count=False,
-                                     out_byword=True,
-                                     object_sequence_column='topicid'
-                                     )
-         
-            # Print the result teradataml DataFrame.
-            print(LDATopicSummary_out1)
-         
-            # Persist the model table generated by the LDA function.
-            copy_to_sql(lda_out.model_table, "model_lda_out")
-         
-            # Create teradataml DataFrame objects.
-            model_lda_out = DataFrame.from_table("model_lda_out")
-         
-            # Example 2 - summary argument True.
-            LDATopicSummary_out2 = LDATopicSummary(object = model_lda_out,
-                                                  summary = True
-                                                  )
-         
-            # Print the result teradataml DataFrame.
-            print(LDATopicSummary_out2.result)
-         
-            # Example 3 - out_byword is False.
-            LDATopicSummary_out3 = LDATopicSummary(object = model_lda_out,
-                                                  out_topicwordnum = 'all',
-                                                  out_byword = False
-                                                  )
-         
-            # Print the result teradataml DataFrame.
-            print(LDATopicSummary_out3)
-         
-            # Example 4 - Arguments word_weight and word_count are True.
-            LDATopicSummary_out4 = LDATopicSummary(object = model_lda_out,
-                                                  word_weight = True,
-                                                  word_count = True,
-                                                  out_byword = True
-                                                  )
-         
-            # Print the result teradataml DataFrame.
-            print(LDATopicSummary_out4)
-        
-        """
-        
-        # Start the timer to get the build time
-        _start_time = time.time()
-        
-        self.object  = object 
-        self.summary  = summary 
-        self.out_topicwordnum  = out_topicwordnum 
-        self.word_weight  = word_weight 
-        self.word_count  = word_count 
-        self.out_byword  = out_byword 
-        self.object_sequence_column  = object_sequence_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(["summary", self.summary, True, (bool)])
-        self.__arg_info_matrix.append(["out_topicwordnum", self.out_topicwordnum, True, (str)])
-        self.__arg_info_matrix.append(["word_weight", self.word_weight, True, (bool)])
-        self.__arg_info_matrix.append(["word_count", self.word_count, True, (bool)])
-        self.__arg_info_matrix.append(["out_byword", self.out_byword, True, (bool)])
-        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, LDA):
-            self.object = self.object._mlresults[0]
-        
-        # 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.object, "object", LDA)
-        
-        # 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.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.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 = []
-        
-        if self.summary is not None and self.summary != False:
-            self.__func_other_arg_sql_names.append("SummaryOutput")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.summary, "'"))
-            self.__func_other_arg_json_datatypes.append("BOOLEAN")
-        
-        if self.out_topicwordnum is not None and self.out_topicwordnum != "all":
-            self.__func_other_arg_sql_names.append("OutputTopicWordNum")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.out_topicwordnum, "'"))
-            self.__func_other_arg_json_datatypes.append("STRING")
-        
-        if self.word_weight is not None and self.word_weight != False:
-            self.__func_other_arg_sql_names.append("WordWeight")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.word_weight, "'"))
-            self.__func_other_arg_json_datatypes.append("BOOLEAN")
-        
-        if self.word_count is not None and self.word_count != False:
-            self.__func_other_arg_sql_names.append("WordCount")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.word_count, "'"))
-            self.__func_other_arg_json_datatypes.append("BOOLEAN")
-        
-        if self.out_byword is not None and self.out_byword != True:
-            self.__func_other_arg_sql_names.append("OutputByWord")
-            self.__func_other_args.append(UtilFuncs._teradata_collapse_arglist(self.out_byword, "'"))
-            self.__func_other_arg_json_datatypes.append("BOOLEAN")
-        
-        # Generate lists for rest of the function arguments
-        sequence_input_by_list = []
-        if self.object_sequence_column is not None:
-            sequence_input_by_list.append("input:" + 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 object
-        self.__table_ref = self.__awu._teradata_on_clause_from_dataframe(self.object, 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("1")
-        self.__func_input_order_by_cols.append(UtilFuncs._teradata_collapse_arglist(self.object_order_column, "\""))
-        
-        function_name = "LDATopicSummary"
-        # 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 LDATopicSummary class instance.
-        """
-        repr_string="############ STDOUT Output ############"
-        repr_string = "{}\n\n{}".format(repr_string,self.result)
-        return repr_string
-