teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,180 @@
+def DTW(data1=None, data1_filter_expr=None, data2=None, 
+        data2_filter_expr=None, radius=None, distance=None, 
+        warp_path=None, input_fmt_input_mode=None,
+        **generic_arguments):
+    """
+    DESCRIPTION:
+        The DTW() function measures the similarity of two time series.
+        The Dynamics Time Warping (DTW) algorithm is used for space and
+        time. The underlying algorithm used by DTW() function is the FastDTW
+        algorithm. It is not recommended for large datasets. This algorithm
+        can find the optimal, or a close to optimal warp path between two
+        series, depending on the search radius used.
+
+
+    PARAMETERS:
+        data1:
+            Required Argument.
+            Specifies the first series input out of two.
+            Note:
+                The input series specified in "data1" and "data2" must
+                have the same number of payload columns.
+            Types: TDSeries
+
+        data1_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data1".
+            Types: ColumnExpression
+
+        data2:
+            Required Argument.
+            Specifies the second series input out of two.
+            Note:
+                The input series specified in "data1" and "data2" must
+                have the same number of payload columns.
+            Types: TDSeries
+
+        data2_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data2".
+            Types: ColumnExpression
+
+        radius:
+            Optional Argument.
+            Specifies the search radius for the FastDTW algorithm.
+            This value should be a positive integer within the range
+            0 to 1000. Using a small radius is sufficient for finding
+            the optimal match. Larger value of radius can cause significant
+            performance issues without providing a better result.
+            Types: int
+
+        distance:
+            Optional Argument.
+            Specifies the distance function to be used.
+            Permitted Values:
+                * EUCLIDEAN - Euclidean distance function.
+                * MANHATTAN - Manhattan distance function.
+                * BINARY - Binary distance function.
+            Types: str
+
+        warp_path:
+            Optional Argument.
+            Specifies the type of warp paths.
+            Permitted Values:
+                * 0 - No warp paths to be generated.
+                      Only the warp distance is calculated.
+                * 1 - Warp paths to be generated with WarpX and
+                      WarpY output columns as the path index.
+                * 2 - Warp paths to be generated with WarpX_I and
+                      WarpY_I using the series 1 and series 2
+                      ROW_I values at the path index.
+                * 3 - Warp paths to be generated with both the
+                      output columns 1 and 2.
+            Types: int
+
+        input_fmt_input_mode:
+            Required Argument.
+            Specifies the input mode supported by the function.
+            Permitted Values: MANY2ONE, ONE2ONE, MATCH
+            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 DTW.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DTW_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", ["dtw_t1", "dtw_t2"])
+
+        # Create teradataml DataFrame objects.
+        data1 = DataFrame.from_table("dtw_t1")
+        data2 = DataFrame.from_table("dtw_t2")
+
+        # Create teradataml TDSeries objects.
+        data_series_df = TDSeries(data=data1,
+                                  id="id",
+                                  row_index="seq",
+                                  row_index_style= "TIMECODE",
+                                  payload_field="v",
+                                  payload_content="REAL")
+
+        data2_series_df = TDSeries(data=data2,
+                                  id="id",
+                                  row_index="seq",
+                                  row_index_style= "TIMECODE",
+                                  payload_field="v",
+                                  payload_content="REAL")
+
+        # Example 1 : Execute DTW() function to measure the
+        #             similarity between two time series.
+        uaf_out = DTW(data1=data_series_df,
+                      data2=data2_series_df,
+                      input_fmt_input_mode='MANY2ONE',
+                      warp_path=2,
+                      radius=1,
+                      data2_filter_expr=data2_series_df.id==1)
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+    
+    """
+    

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

@@ -0,0 +1,235 @@
+def DWT(data1=None, data1_filter_expr=None, data2=None, 
+        data2_filter_expr=None, wavelet=None, mode="symmetric", 
+        level=1, part=None, input_fmt_input_mode=None, 
+        output_fmt_index_style="NUMERICAL_SEQUENCE", 
+        **generic_arguments):
+    """
+    DESCRIPTION:
+        DWT() is a function that performs discrete wavelet
+        transform (DWT).
+
+    PARAMETERS:
+        data1:
+            Required Argument.
+            Specifies the series to be used as an input.
+            Multiple payloads are supported, and each payload column is
+            transformed independently. Only REAL or MULTIVAR_REAL
+            payload content types are supported.
+            Types: TDSeries
+
+        data1_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data1".
+            Types: ColumnExpression
+
+        data2:
+            Optional Argument.
+            Specifies the series to be used as an input. The
+            series specifies the filter. It should have two payload
+            columns corresponding to low and high pass 
+            filters. Only MULTIVAR_REAL payload content type is
+            supported.
+            Types: TDSeries
+
+        data2_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data2".
+            Types: ColumnExpression
+
+        wavelet:
+            Optional Argument.
+            Specifies the name of the wavelet.
+            Option families and names are:
+                * Daubechies: 'db1' or 'haar', 'db2', 'db3', .... ,'db38'
+                * Coiflets: 'coif1', 'coif2', ... , 'coif17'
+                * Symlets: 'sym2', 'sym3', ... ,' sym20'
+                * Discrete Meyer: 'dmey'
+                * Biorthogonal: 'bior1.1', 'bior1.3', 'bior1.5',
+                                'bior2.2', 'bior2.4', 'bior2.6',
+                                'bior2.8', 'bior3.1', 'bior3.3',
+                                'bior3.5', 'bior3.7', 'bior3.9',
+                                'bior4.4', 'bior5.5', 'bior6.8'
+                * Reverse Biorthogonal: 'rbio1.1', 'rbio1.3',
+                                        'rbio1.5' 'rbio2.2',
+                                        'rbio2.4', 'rbio2.6',
+                                        'rbio2.8', 'rbio3.1',
+                                        'rbio3.3', 'rbio3.5',
+                                        'rbio3.7','rbio3.9',
+                                        'rbio4.4', 'rbio5.5',
+                                        'rbio6.8'
+            Note:
+                * If 'wavelet' is specified, do not include a second
+                  input series for the function. Otherwise, include
+                  a second input series to provide the filter.
+                * Data type is case-sensitive.
+            Types: str
+
+        mode:
+            Optional Argument.
+            Specifies the signal extension mode. Data type is
+            case-insensitive.
+            Permitted Values:
+                * symmetric, sym, symh
+                * reflect, symw
+                * smooth, spd, sp1
+                * constant, sp0
+                * zero, zpd
+                * periodic, ppd
+                * periodization, per
+                * antisymmetric, asym, asymh
+                * antireflect, asymw
+            Default Value: symmetric
+            Types: str
+
+        level:
+            Optional Argument.
+            Specifies the level of decomposition.
+            Valid values are [1,15].
+            Default Value: 1
+            Types: int
+
+        part:
+            Optional Argument.
+            Specifies the indicator that the input is partial decomposition
+            result.
+            Note:
+                Data type is case-insensitive.
+            Permitted Values:
+                * a - the approximation
+                * d - the detail of decomposition of result.
+            Types: str
+
+        input_fmt_input_mode:
+            Optional Argument.
+            Specifies the input mode supported by the function.
+            When there are two input series, then the input_fmt_input_mode
+            specification is mandatory.
+            Permitted Values:
+            The input_fmt_input_mode parameter has the following options:
+                * ONE2ONE: Both the primary and secondary series
+                           specifications contain a series name which
+                           identifies the two series in the function.
+                * MANY2ONE: The MANY specification is the primary series
+                            declaration. The secondary series specification
+                            contains a series name that identifies the single
+                            secondary series.
+                * MATCH: Both series are defined by their respective series
+                         specification instance name declarations.
+            Types: str
+
+        output_fmt_index_style:
+            Optional Argument.
+            Specifies the index style of the output format.
+            Permitted Values: NUMERICAL_SEQUENCE
+            Default Value: NUMERICAL_SEQUENCE
+            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 DWT.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DWT_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 DWT.
+        from teradataml import DWT
+
+        # Load the example data.
+        load_example_data("uaf", ["dwt_dataTable", "dwt_filterTable"])
+
+        # Create teradataml DataFrame objects.
+        data1 = DataFrame.from_table("dwt_dataTable")
+        data2 = DataFrame.from_table("dwt_filterTable")
+
+        # Create teradataml TDSeries objects.
+        data1_series_df = TDSeries(data=data1,
+                                   id="id",
+                                   row_index="rowi",
+                                   row_index_style="SEQUENCE",
+                                   payload_field="v",
+                                   payload_content="REAL")
+
+        data2_series_df = TDSeries(data=data2,
+                                   id="id",
+                                   row_index="seq",
+                                   row_index_style="SEQUENCE",
+                                   payload_field=["lo", "hi"],
+                                   payload_content="MULTIVAR_REAL")
+
+        # Example 1: Perform discrete wavelet transform using two series as input.
+        uaf_out = DWT(data1=data1_series_df,
+                      data2=data2_series_df,
+                      data2_filter_expr=data2_series_df.id==1,
+                      input_fmt_input_mode='MANY2ONE')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+       # Example 2: Perform discrete wavelet transform using single series as input and the wavelet parameter.
+        uaf_out = DWT(data1=data1_series_df,
+                      wavelet='haar')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+    
+    """
+    

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

@@ -0,0 +1,217 @@
+def DWT2D(data1=None, data1_filter_expr=None, data2=None, 
+          data2_filter_expr=None, wavelet=None, mode="symmetric", 
+          level=1, input_fmt_input_mode=None, 
+          output_fmt_index_style="NUMERICAL_SEQUENCE", 
+          **generic_arguments):
+    """
+    DESCRIPTION:
+        DWT2D() function performs discrete wavelet transform (DWT) for
+        two-dimensional data. The algorithm is applied first
+        vertically by column axis, then horizontally by row axis.
+
+
+    PARAMETERS:
+        data1:
+            Required Argument.
+            Specifies the input matrix. Multiple payloads are supported,
+            and each payload column is transformed independently.
+            Only REAL or MULTIVAR_REAL payload content types are supported.
+            Types: TDMatrix
+
+        data1_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data1".
+            Types: ColumnExpression
+
+        data2:
+            Optional Argument.
+            Specifies the input series. The series specifies the filter.
+            It should have two payload columns corresponding to low and high
+            pass filters. Only MULTIVAR_REAL payload content type is supported.
+            Types: TDSeries
+
+        data2_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data2".
+            Types: ColumnExpression
+
+        wavelet:
+            Optional Argument.
+            Specifies the name of the wavelet.
+            Permitted families and names are:
+                * Daubechies: 'db1' or 'haar', 'db2', 'db3', .... ,'db38'
+                * Coiflets: 'coif1', 'coif2', ... , 'coif17'
+                * Symlets: 'sym2', 'sym3', ... ,' sym20'
+                * Discrete Meyer: 'dmey'
+                * Biorthogonal: 'bior1.1', 'bior1.3', 'bior1.5', 'bior2.2',
+                                'bior2.4', 'bior2.6', 'bior2.8', 'bior3.1',
+                                'bior3.3', 'bior3.5', 'bior3.7', 'bior3.9',
+                                'bior4.4', 'bior5.5', 'bior6.8'
+                * Reverse Biorthogonal: 'rbio1.1', 'rbio1.3', 'rbio1.5'
+                                        'rbio2.2', 'rbio2.4', 'rbio2.6',
+                                        'rbio2.8', 'rbio3.1', 'rbio3.3',
+                                        'rbio3.5', 'rbio3.7','rbio3.9',
+                                        'rbio4.4', 'rbio5.5', 'rbio6.8'
+            Note:
+                * If 'wavelet' is specified, do not include a second
+                  input series for the function. Otherwise, include
+                  a second input series to provide the filter.
+                * Data type is case-sensitive.
+            Types: str
+
+        mode:
+            Optional Argument.
+            Specifies the signal extension mode. Data type is case-insensitive.
+            Permitted Values:
+                * symmetric, sym, symh
+                * reflect, symw
+                * smooth, spd, sp1
+                * constant, sp0
+                * zero, zpd
+                * periodic, ppd
+                * periodization, per
+                * antisymmetric, asym, asymh
+                * antireflect, asymw
+            Default Value: symmetric
+            Types: str
+
+        level:
+            Optional Argument.
+            Specifies the level of decomposition. Valid values are [1,15].
+            Default Value: 1
+            Types: int
+
+        input_fmt_input_mode:
+            Optional Argument.
+            Specifies the input mode supported by the function.
+            When there are two input series, then the "input_fmt_input_mode"
+            specification is mandatory.
+            Permitted Values:
+                * ONE2ONE: Both the primary and secondary series specifications
+                           contain a series name which identifies the two series
+                           in the function.
+                * MANY2ONE: The MANY specification is the primary series
+                            declaration. The secondary series specification
+                            contains a series name that identifies the single
+                            secondary series.
+                * MATCH: Both series are defined by their respective series
+                         specification instance name declarations.
+            Types: str
+
+        output_fmt_index_style:
+            Optional Argument.
+            Specifies the index style of the output format.
+            Permitted Values: NUMERICAL_SEQUENCE
+            Default Value: NUMERICAL_SEQUENCE
+            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 DWT2D.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DWT2D_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")
+
+        # Load the example data.
+        load_example_data("uaf", ["dwt2d_dataTable", "dwt_filterTable"])
+
+        # Create teradataml DataFrame objects.
+        data1 = DataFrame.from_table("dwt2d_dataTable")
+        data2 = DataFrame.from_table("dwt_filterTable")
+
+        # Create teradataml TDSeries object.
+        data2_series_df = TDSeries(data=data2,
+                                   id="id",
+                                   row_index="seq",
+                                   row_index_style="SEQUENCE",
+                                   payload_field=["lo", "hi"],
+                                   payload_content="MULTIVAR_REAL")
+
+        # Create teradataml TDMatrix object.
+        data1_matrix_df = TDMatrix(data=data1,
+                                   id="id",
+                                   row_index="y",
+                                   row_index_style="SEQUENCE",
+                                   column_index="x",
+                                   column_index_style="SEQUENCE",
+                                   payload_field="v",
+                                   payload_content="REAL")
+
+        # Example 1: Perform discrete wavelet transform (DWT) for two-dimensional data using both inputs.
+        uaf_out = DWT2D(data1=data1_matrix_df,
+                        data2=data2_series_df,
+                        data2_filter_expr=data2.id==1,
+                        input_fmt_input_mode="MANY2ONE")
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+        # Example 2: Perform discrete wavelet transform (DWT) for two-dimensional data
+        #            using only one matrix as input and wavelet as 'haar'.
+        uaf_out = DWT2D(data1=data1_matrix_df,
+                        wavelet='haar')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+    """
+