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

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,214 @@
+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")
+
+        # Example 1: 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)
+
+    """
+    

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

@@ -28,7 +28,7 @@ def DurbinWatson(data=None, data_filter_expr=None, explanatory_count=None,
         explanatory_count:
             Required Argument.
             Specifies the number of explanatory variables in the original regression.
-            The number of explanatory variables along with the "include_contant"
+            The number of explanatory variables along with the "include_constant"
             information is needed to perform the lookup in the Durbin-Watson data.
             Types: int
 

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

@@ -10,7 +10,7 @@ def ExtractResults(data=None, data_filter_expr=None, **generic_arguments):
 
         The functions that have multiple layers are shown in the table.
         Layers of each function can be extracted from the function output,
-        i.e. "result" attribute, using the layer name specified below:
+        i.e., "result" attribute, using the layer name specified below:
 
         ------------------------------------------------------------------
         | Function                    | Layers                           |

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

@@ -0,0 +1,160 @@
+def FilterFactory1d(filter_id=None, filter_type=None,
+                    window_type=None, filter_length=None,
+                    transition_bandwidth=None, low_cutoff=None, 
+                    high_cutoff=None, sampling_frequency=None, 
+                    filter_description=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        FilterFactory1d() function creates finite impulse response (FIR)
+        filter coefficients. The filters are based on certain parameters
+        and stored into a common table for reuse.
+        Note:
+            User needs EXECUTE PROCEDURE privelge on SYSLIB
+
+    PARAMETERS:
+        filter_id:
+            Required Argument.
+            Specifies the filter identifier, based on filter coefficients
+            stored in the table.
+            Types: int
+
+        filter_type:
+            Required Argument.
+            Specifies the type of filter to generate.
+            Permitted Values:
+                * LOWPASS - To remove frequencies above low_cutoff.
+                * HIGHPASS - To remove frequencies below high_cutoff.
+                * BANDPASS - To remove frequencies below low_cutoff and
+                             above high_cutoff.
+                * BANDSTOP - To remove frequencies between low_cutoff
+                  and high_cutoff.
+            Types: str
+
+        window_type:
+            Optional Argument.
+            Specifies the window function to the filter that maintains a
+            smooth drop-off to zero, and avoids extra artifacts in the
+            frequency domain. The default is to leave the filter
+            coefficients as they are, and not apply any windowing function.
+            Permitted Values: BLACKMAN, HAMMING, HANNING, BARTLETT
+            Types: str
+
+        filter_length:
+            Optional Argument.
+            Specifies the length of the filter to generate.
+            Overrides "transition_bandwidth" argument if both are supplied,
+            and renders the other an optional argument.
+            Default is approximately 4/("transition_bandwidth"/
+            "sampling_frequency").
+            Types: int
+
+        transition_bandwidth:
+            Optional Argument.
+            Specifies the maximum allowed size for the range of
+            frequencies for filter transitions between a passband and stopband.
+            This also determines the number of coefficients to be generated.
+            Value must be greater than 0.
+            A smaller value produces faster drop off at the cost of more coefficients.
+            Not used when "filter_length" is supplied.
+            Default is bandwidth from "filter_length".
+            Types: float
+
+        low_cutoff:
+            Optional Argument.
+            Specifies  the lower frequency that change between a passband
+            and stopband occurs. It must be greater
+            than 0. It is not used by default with 'HIGHPASS' filter.
+            Types: float
+
+        high_cutoff:
+            Optional Argument.
+            Specifies the higher frequency that change
+            between a passband and stopband occurs. It must be greater
+            than 0 and not used by default with 'LOWPASS' filter.
+            Types: float
+
+        sampling_frequency:
+            Required Argument.
+            Specifies the frequency that the data to be filtered was
+            sampled. It must be greater than 0.
+            Types: float
+
+        filter_description:
+            Optional Argument.
+            Specifies the description for the filter coefficients
+            that contain the same filter ID. Description is only
+            written to one row for each filter generated, and 
+            ROW_I is 0. Default is a string describing parameters.
+            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
+
+    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 FilterFactory1d.
+        from teradataml import FilterFactory1d
+
+        # Example 1: Create finite impulse response (FIR) filter coefficients.
+        res = FilterFactory1d(filter_id = 33,
+                              filter_type = 'lowpass',
+                              window_type = 'blackman',
+                              transition_bandwidth = 20.0,
+                              low_cutoff = 40.0,
+                              sampling_frequency = 200)
+        print(res.result)
+    
+    """
+    

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

@@ -19,7 +19,7 @@ def GenseriesSinusoids(data=None, data_filter_expr=None, periodicities=None,
               exclude from the data set.
             * Use the BinarySeriesOp() function to subtract the generated series
               from the original series using "mathop" argument value as 'SUB'.
-            * User the PowerSpec() function to verify that target periodicities
+            * Use the PowerSpec() function to verify that target periodicities
               have been removed from the original series.