teradataml 20.0.0.8__py3-none-any.whl

teradataml/data/docs/uaf/docs_17_20/Convolve.py

@@ -0,0 +1,230 @@
+def Convolve(data1=None, data1_filter_expr=None, data2=None, 
+             data2_filter_expr=None, algorithm=None, 
+             input_fmt_input_mode=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The Convolve() function applies a series representing a
+        digital filter to a time series by convolving the two series. 
+        The digital filter can be of any type such as low-pass, band-pass,
+        band-reject, high-pass, and so on.
+
+        User can use digital filters to separate time series that
+        have been combined and to restore time series that have 
+        become distorted.
+
+
+    PARAMETERS:
+        data1:
+            Required Argument.
+            Specifies the time series to be filtered.
+            The time series have the following TDSeries characteristics.
+                1. "payload_content" must have one of these values:
+                    * REAL
+                    * COMPLEX
+                    * MULTIVAR_REAL
+                    * MULTIVAR_COMPLEX
+                2. The two time series must have the same "payload_content" value
+                   and number of payload fields, with these exceptions:
+                    * One can have "payload_content" value 'MULTIVAR_REAL' and
+                      multiple payload fields and the other can have
+                      "payload_content" value REAL and one payload field.
+                    * When both have the "payload_content" value 'MULTIVAR_COMPLEX',
+                      one can have multiple pairs of payload fields and
+                      the other can have a single pair of payload fields.
+            Types: TDSeries
+
+        data1_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data1".
+            Types: ColumnExpression
+
+        data2:
+            Required Argument.
+            Specifies the actual filter kernel.
+            The time series have the following TDSeries characteristics.
+                1. "payload_content" must have one of these values:
+                    * REAL
+                    * COMPLEX
+                    * MULTIVAR_REAL
+                    * MULTIVAR_COMPLEX
+                2. The two time series must have the same "payload_content" value
+                   and number of payload fields, with these exceptions:
+                    * One can have "payload_content" value 'MULTIVAR_REAL' and
+                      multiple payload fields and the other can have
+                      "payload_content" value REAL and one payload field.
+                    * When both have the "payload_content" value 'MULTIVAR_COMPLEX',
+                      one can have multiple pairs of payload fields and
+                      the other can have a single pair of payload fields.
+            Types: TDSeries
+
+        data2_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data2".
+            Types: ColumnExpression
+
+        algorithm:
+            Optional Argument.
+            Specifies the options to use for convolving.
+            By default, the function selects the best option based
+            on the number of entries present in the two inputs,
+            and their types ( REAL, COMPLEX, and so on.)
+            CONV_SUMMATION only supports:
+                * REAL, REAL
+                * REAL, MULTIVAR_REAL
+                * MULTIVAR_REAL, REAL
+                * MULTIVAR_REAL, MULTIVAR_REAL
+            Note:
+                * This parameter is usually used for testing.
+                  If this parameter is not included, the internal
+                  planning logic selects the best option based on
+                  the number of entries present in the two inputs,
+                  and their types ( REAL, COMPLEX, and so on.)
+            Permitted Values: CONV_SUMMATION, CONV_DFFT
+            Types: str
+
+        input_fmt_input_mode:
+            Required Argument.
+            Specifies the input mode supported by the function.
+            Permitted Values: 
+                1. ONE2ONE: Both the data1 and data2 series
+                   specifications contain a series name which identifies
+                   the two series in the function.
+                2. MANY2ONE: The MANY specification is the data1 series
+                   declaration. The data2 series specification contains
+                   a series name that identifies the single data2 series.
+                3. MATCH: Both series are defined by their respective
+                   series specification instance name declarations.
+            Types: str
+
+        **generic_arguments:
+            Specifies the generic keyword arguments of UAF functions.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the
+                    function in a table or not. When set to True,
+                    results are persisted in a table; otherwise,
+                    results are garbage collected at the end of the
+                    session.
+                    Note that, when UAF function is executed, an 
+                    analytic result table (ART) is created.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile ART or not. When set to
+                    True, results are stored in a volatile ART,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+                output_table_name:
+                    Optional Argument.
+                    Specifies the name of the table to store results. 
+                    If not specified, a unique table name is internally 
+                    generated.
+                    Types: str
+
+                output_db_name:
+                    Optional Argument.
+                    Specifies the name of the database to create output 
+                    table into. If not specified, table is created into 
+                    database specified by the user at the time of context 
+                    creation or configuration parameter. Argument is ignored,
+                    if "output_table_name" is not specified.
+                    Types: str
+
+
+    RETURNS:
+        Instance of Convolve.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as Convolve_obj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            1. result
+
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Check the list of available UAF analytic functions.
+        display_analytic_functions(type="UAF")
+
+        # Load the example data.
+        load_example_data("uaf", ["xconvolve_complex_leftmulti", "hconvolve_complex_rightmulti",
+                                  "xconvolve_complex_left", "hconvolve_complex_right"])
+
+        # Create teradataml DataFrame objects.
+        data1 = DataFrame.from_table("xconvolve_complex_leftmulti")
+        data2 = DataFrame.from_table("hconvolve_complex_rightmulti")
+        data3 = DataFrame.from_table("xconvolve_complex_left")
+        data4 = DataFrame.from_table("hconvolve_complex_right")
+
+        # Example 1: Execute Convolve() function to convolve two series into new time series using "CONV_DFFT" 
+        #            algorithm. 
+        #            Note:
+        #               The two input time series "payload_content" are 'MULTIVAR_COMPLEX' and the resultant
+        #               time series "payload_content" is 'MULTIVAR_COMPLEX'.
+
+        # Create teradataml TDSeries objects for "payload_content" with the value 'MULTIVAR_COMPLEX'.
+        data1_series_df = TDSeries(data=data1,
+                                   id="id",
+                                   row_index_style="sequence",
+                                   row_index="seq",
+                                   payload_field=["a_real", "a_imag", "b_real", "b_imag", "c_real", "c_imag"],
+                                   payload_content="MULTIVAR_COMPLEX")
+        data2_series_df = TDSeries(data=data2,
+                                   id="id",
+                                   row_index_style="sequence",
+                                   row_index="seq",
+                                   payload_field=["a_real", "a_imag", "b_real", "b_imag", "c_real", "c_imag"],
+                                   payload_content="MULTIVAR_COMPLEX")
+        # Convolve the "data1_series_df" and "data2_series_df" series using the Convolve() function.
+        uaf_out1 = Convolve(data1=data1_series_df,
+                            data2=data2_series_df,
+                            algorithm="CONV_DFFT",
+                            input_fmt_input_mode="MATCH")
+
+        # Print the result DataFrame.
+        print(uaf_out1.result)
+
+        # Example 2: Execute Convolve() function to convolve two series into new time series using "CONV_SUMMATION" 
+        #            algorithm.
+        #            Note:
+        #               The two input time series "payload_content" are 'MULTIVAR_REAL' and the resultant
+        #               time series "payload_content" is 'MULTIVAR_COMPLEX'.
+
+        # Create teradataml TDSeries objects for "payload_content" with the value 'MULTIVAR_REAL'.
+        data3_series_df = TDSeries(data=data3,
+                                   id="id",
+                                   row_index_style="sequence",
+                                   row_index="seq",
+                                   payload_field=["a_real", "a_imag"],
+                                   payload_content="MULTIVAR_REAL")
+
+        data4_series_df = TDSeries(data=data4,
+                                   id="id",
+                                   row_index_style="sequence",
+                                   row_index="seq",
+                                   payload_field=["a_real", "a_imag"],
+                                   payload_content="MULTIVAR_REAL")
+        # Convolve the "data3_series_df" and "data4_series_df" series using the Convolve() function.
+        uaf_out2 = Convolve(data1=data3_series_df,
+                            data2=data4_series_df,
+                            algorithm="CONV_SUMMATION",
+                            input_fmt_input_mode="MATCH")
+
+        # Print the result DataFrame.
+        print(uaf_out2.result)
+    """
+    

teradataml/data/docs/uaf/docs_17_20/Convolve2.py

@@ -0,0 +1,218 @@
+def Convolve2(data1=None, data1_filter_expr=None, data2=None, 
+              data2_filter_expr=None,
+              input_fmt_input_mode=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The Convolve2() function uses two matrices as input. One matrix is
+        the image in pixels, and the other matrix is the filter.
+        Smaller images with results sets smaller than 128 by 128
+        use summation. Larger images use the Discrete Fast Fourier
+        Transform (DFFT) method.
+
+
+    PARAMETERS:
+        data1:
+            Required Argument.
+            Specifies the matrix for the image to be filtered.
+            The matrices have the following characteristics:
+                1. The matrix can have any supported payload content as mentioned below:
+                    * REAL
+                    * COMPLEX
+                    * MULTIVAR_REAL
+                    * MULTIVAR_COMPLEX
+                2. The following combinations are supported for
+                   MULTIVAR varieties:
+                    * For all MULTIVAR types: Both multivariate matrixes
+                      are of the same content type, and both matrixes have 
+                      the same number of payload fields.
+                    * For MULTIVAR_REAL: One input is a MULTIVAR content matrix
+                      having greater than one payload field, and the other matrix
+                      is a REAL content series having just one payload field.
+                    * For the MULTIVAR_COMPLEX: One input is a MULTIVAR content
+                      matrix having greater than one pair of fields, and
+                      the other matrix is a MULTIVAR content of the same 
+                      type having just one pair of payload fields.
+            Types: TDMatrix
+
+        data1_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data1".
+            Types: ColumnExpression
+
+        data2:
+            Required Argument.
+            Specifies the actual filter kernel matrix for filtering image.
+            The matrices have the following characteristics:
+                1. The matrix can have any supported payload content as mentioned below:
+                    * REAL
+                    * COMPLEX
+                    * MULTIVAR_REAL
+                    * MULTIVAR_COMPLEX
+                2. The following combinations are supported for
+                   MULTIVAR varieties:
+                    * For all MULTIVAR types: Both multivariate matrixes
+                      are of the same content type, and both matrixes have 
+                      the same number of payload fields.
+                    * For MULTIVAR_REAL: One input is a MULTIVAR content matrix
+                      having greater than one payload field, and the other matrix
+                      is a REAL content series having just one payload field.
+                    * For the MULTIVAR_COMPLEX: One input is a MULTIVAR content
+                      matrix having greater than one pair of fields, and
+                      the other matrix is a MULTIVAR content of the same 
+                      type having just one pair of payload fields.
+            Types: TDMatrix
+
+        data2_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data2".
+            Types: ColumnExpression
+
+        input_fmt_input_mode:
+            Required Argument.
+            Specifies the input mode supported by the function.
+            Permitted Values:
+                1. ONE2ONE: Both the primary and secondary matrix
+                   specifications contain a matrix name which identifies
+                   the two matrixes in the function.
+                2. MANY2ONE: The MANY specification is the primary matrix
+                   declaration. The secondary matrix specification contains
+                   a matrix name that identifies the single secondary matrix.
+                3. MATCH: Both matrixes are defined by their respective
+                   matrix specification MATRIX_ID declarations.
+            Types: str
+
+        **generic_arguments:
+            Specifies the generic keyword arguments of UAF functions.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the
+                    function in a table or not. When set to True,
+                    results are persisted in a table; otherwise,
+                    results are garbage collected at the end of the
+                    session.
+                    Note that, when UAF function is executed, an 
+                    analytic result table (ART) is created.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile ART or not. When set to
+                    True, results are stored in a volatile ART,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+                output_table_name:
+                    Optional Argument.
+                    Specifies the name of the table to store results. 
+                    If not specified, a unique table name is internally 
+                    generated.
+                    Types: str
+
+                output_db_name:
+                    Optional Argument.
+                    Specifies the name of the database to create output 
+                    table into. If not specified, table is created into 
+                    database specified by the user at the time of context 
+                    creation or configuration parameter. Argument is ignored,
+                    if "output_table_name" is not specified.
+                    Types: str
+
+
+    RETURNS:
+        Instance of Convolve2.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as Convolve2_obj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            1. result
+
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Check the list of available UAF analytic functions.
+        display_analytic_functions(type="UAF")
+
+        # Load the example data.
+        load_example_data("uaf", ["Convolve2ValidLeft", "Convolve2RealsLeft"])
+
+        # Create teradataml DataFrame objects.
+        data1 = DataFrame.from_table("Convolve2ValidLeft")
+        data2 = DataFrame.from_table("Convolve2ValidLeft")
+        data3 = DataFrame.from_table("Convolve2RealsLeft")
+        data4 = DataFrame.from_table("Convolve2RealsLeft")
+
+        # Example 1: Apply the Convolve2() function when payload fields of two matrices
+        #            are the different to convolve two matrices into a new source 
+        #            image matrix.
+
+        # Create teradataml TDMatrix objects with different payload fields.
+        data1_matrix_df = TDMatrix(data=data1,
+                                   id='id',
+                                   row_index_style="sequence",
+                                   row_index='row_i',
+                                   column_index_style="sequence",
+                                   column_index='column_i',
+                                   payload_field=["B"],
+                                   payload_content="REAL")
+
+        data2_matrix_df = TDMatrix(data=data2,
+                                   id='id',
+                                   row_index_style="sequence",
+                                   row_index='row_i',
+                                   column_index_style="sequence",
+                                   column_index='column_i',
+                                   payload_field=["A"],
+                                   payload_content="REAL")
+
+        # Convolve the "data1_matrix_df" and "data2_matrix_df" matrices using the Convolve2() function.
+        uaf_out1 = Convolve2(data1=data1_matrix_df,
+                             data2=data2_matrix_df,
+                             input_fmt_input_mode="MATCH")
+
+        # Print the result DataFrame.
+        print(uaf_out1.result)
+
+        # Example 2: Apply the Convolve2() function when payload fields of two matrices
+        #            are the same to convolve two matrices into a new source image matrix 
+
+        # Create teradataml TDMatrix objects with same payload fields.
+        data3_matrix_df = TDMatrix(data=data3,
+                                   id='id',
+                                   row_index_style="sequence",
+                                   row_index='row_seq',
+                                   column_index_style="sequence",
+                                   column_index='col_seq',
+                                   payload_field=["A"],
+                                   payload_content="REAL")
+
+        data4_matrix_df = TDMatrix(data=data4,
+                                   id='id',
+                                   row_index_style="sequence",
+                                   row_index='row_seq',
+                                   column_index_style="sequence",
+                                   column_index='col_seq',
+                                   payload_field=["A"],
+                                   payload_content="REAL")
+                                   
+        # Convolve the "data3_matrix_df" and "data4_matrix_df" matrices using the Convolve2() function.
+        uaf_out2 = Convolve2(data1=data3_matrix_df,
+                             data2=data4_matrix_df,
+                             input_fmt_input_mode="MATCH")
+
+        # Print the result DataFrame.
+        print(uaf_out2.result)
+    """
+    

teradataml/data/docs/uaf/docs_17_20/CopyArt.py

@@ -0,0 +1,145 @@
+def CopyArt(data=None, database_name = None,
+            table_name = None, map_name = None,
+            **generic_arguments):
+    """
+    DESCRIPTION:
+        CopyArt() function creates a copy of an existing analytics result table (ART).
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the ART data to be copied.
+            Types: DataFrame
+
+        database_name:
+            Required Argument.
+            Specifies the name of the destination database for copied ART.
+            Types: str
+
+        table_name:
+            Required Argument.
+            Specifies the name of the destination table for copied ART.
+            Types: str
+
+        map_name:
+            Optional Argument.
+            Specifies the name of the map for the destination ART.
+            By default, it refers to the map of the 'data'.
+            Types: str
+
+        **generic_arguments:
+            Specifies the generic keyword arguments of UAF functions.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the
+                    function in a table or not. When set to True,
+                    results are persisted in a table; otherwise,
+                    results are garbage collected at the end of the
+                    session.
+                    Note that, when UAF function is executed, an
+                    analytic result table (ART) is created.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile ART or not. When set to
+                    True, results are stored in a volatile ART,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+                output_table_name:
+                    Optional Argument.
+                    Specifies the name of the table to store results.
+                    If not specified, a unique table name is internally
+                    generated.
+                    Types: str
+
+                output_db_name:
+                    Optional Argument.
+                    Specifies the name of the database to create output
+                    table into. If not specified, table is created into
+                    database specified by the user at the time of context
+                    creation or configuration parameter. Argument is ignored,
+                    if "output_table_name" is not specified.
+                    Types: str
+    
+    RETURNS:
+        Instance of CopyArt.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as obj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            1. result
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage, before importing the
+        #        function in user space.
+        #     2. User can import the function, if it is available on
+        #        Vantage user is connected to.
+        #     3. To check the list of UAF analytic functions available
+        #        on Vantage user connected to, use
+        #        "display_analytic_functions()".
+
+        # Check the list of available UAF analytic functions.
+        display_analytic_functions(type="UAF")
+
+        # Import function CopyArt.
+        from teradataml import CopyArt, AutoArima
+
+        # Load the example data.
+        load_example_data("uaf", ["blood2ageandweight"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("blood2ageandweight")
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=data,
+                                  id="PatientID",
+                                  row_index="SeqNo",
+                                  row_index_style="SEQUENCE",
+                                  payload_field="BloodFat",
+                                  payload_content="REAL")
+
+        # Execute AutoArima function to create ART.
+        uaf_out = AutoArima(data=data_series_df,
+                            start_pq_nonseasonal=[1, 1],
+                            seasonal=False,
+                            constant=True,
+                            algorithm="MLE",
+                            fit_percentage=80,
+                            stepwise=True,
+                            nmodels=7,
+                            fit_metrics=True,
+                            residuals=True)
+
+        # Example 1: Execute CopyArt function to copy ART to a destination table name
+        #            with persist option.
+        res = CopyArt(data=uaf_out.result,
+                      database_name="alice",
+                      table_name="copied_table",
+                      persist=True)
+        print(res.result)
+
+        # Example 2: Execute CopyArt function to copy ART to a destination table name.
+        res = CopyArt(data=uaf_out.result,
+                      database_name="alice",
+                      table_name="copied_table2")
+
+        # Print the result DataFrame.
+        print(res.result)
+
+        # Example 3: Copy ART to a destination table name using uaf object.
+        res = uaf_out.copy(database_name="alice",
+                           table_name="copied_table3")
+
+        # Print the result DataFrame.
+        print(res.result)
+
+    """