teradataml 20.0.0.1__py3-none-any.whl → 20.0.0.3__py3-none-any.whl

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/DickeyFuller.py

@@ -1,5 +1,5 @@
 def DickeyFuller(data=None, data_filter_expr=None, algorithm=None, 
-                 max_lags=None, drift_trend_formula=None, 
+                 max_lags=0,
                  **generic_arguments):
     """
     DESCRIPTION:
@@ -10,18 +10,23 @@ def DickeyFuller(data=None, data_filter_expr=None, algorithm=None,
         other factors.
 
         The following procedure is an example of how to use DickeyFuller() function:
-            * Run regression tests.
-            * Determine the algorithm for Dickey Fuller statistic data.
-            * Run DickeyFuller() function using the algorithm.
-            * (Result shows series contains unit roots) Use DIFF() and
-              SeasonalNormalize() functions to remove unit roots.
+            * Run DickeyFuller() on the time series being modeled.
+            * Retrieve the results of the DickeyFuller() test to determine if the
+              time series contains any unit roots.
+            * If unit roots are present, use a technique such as differencing such as Diff()
+              or seasonal normalization, such as SeasonalNormalize(), to create a new series,
+              then rerun the DickeyFuller() test to verify that the differenced or
+              seasonally-normalized series unit root are removed.
+            * If the result shows unit roots, use Diff() and SeasonalNormalize()
+              to remove unit roots.
 
 
     PARAMETERS:
         data:
             Required Argument.
-            Speciifes a single logical-runtime series as an input.
-            Types: TDSeries
+            Specifies a single logical-runtime series as an input or TDAnalyticResult which
+            contains ARTFITRESIDUALS layer.
+            Types: TDSeries, TDAnalyticResult
 
         data_filter_expr:
             Optional Argument.
@@ -34,26 +39,18 @@ def DickeyFuller(data=None, data_filter_expr=None, algorithm=None,
             Permitted Values:
                 * NONE: Random walk
                 * DRIFT: Random walk with drift
-                * TREND: Random walk with linear trend
                 * DRIFTNTREND: Random walk with drift and trend
-                * FORMULA: Random walk with selected drift, trend and
-                           auxiliary lags
+                * SQUARED: Random walk with drift, trend, and
+                           quadratic trend.
             Types: str
 
         max_lags:
             Optional Argument.
             Specifies the maximum number of lags to use with the regression
-            equation.
+            equation. Range is [0, 100]
+            DefaultValue: 0
             Types: int
 
-        drift_trend_formula:
-            Optional Argument.
-            Specifies the formula used to represent the drift and trend portions
-            of the regression.
-            Note:
-                * Valid only when "algorithm" is set to 'formula'.
-            Types: str
-
         **generic_arguments:
             Specifies the generic keyword arguments of UAF functions.
             Below are the generic keyword arguments:
@@ -136,7 +133,7 @@ def DickeyFuller(data=None, data_filter_expr=None, algorithm=None,
         #             for the presence of the unit roots using random walk with
         #             linear trend for regression.
         uaf_out = DickeyFuller(data=data_series_df,
-                               algorithm='TREND')
+                               algorithm='DRIFT')
 
         # 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.
 
 

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

@@ -1,6 +1,6 @@
 def GoldfeldQuandt(data=None, data_filter_expr=None, 
-                   orig_regr_paramcnt=None, weights=False, formula=None, 
-                   algorithm=None, start_idx=None, omit=None, 
+                   const_term=True, algorithm=None,
+                   start_idx=None, omit=None,
                    significance_level=None, test="GREATER",
                    **generic_arguments):
     """
@@ -24,35 +24,15 @@ def GoldfeldQuandt(data=None, data_filter_expr=None,
             Specifies the filter expression for "data".
             Types: ColumnExpression
 
-        orig_regr_paramcnt:
-            Required Argument.
-            Specifies the number of responses and explanatory variables
-            present in the original regression.
-            Types: int
-
-        weights:
+        const_term:
             Optional Argument.
-            Specifies whether the last series found in the payload
-            is to be interpreted as a series of weights that can
-            be used to perform a weighted least squares regression
-            solution. When set to True, the last series is interpreted
-            as series of weights, otherwise not.
-            Default Value: False
+            Specifies the indicator of whether the regression performed should
+            use a Y-intercept coefficient.
+            When set to True, means the regression is performed on “Y=C+aX1+bX2+…”.
+            When set to False, means the regression is performed on “Y=aX1+bX2+…”.
+            Default Value: True
             Types: bool
 
-        formula:
-            Required Argument.
-            Specifies the formula used in the regression operation.
-            The name of the response variable must always be Y,
-            and the name of the explanatory variable must always be X1.
-            For example, "Y = B0 + B1 * X1".
-            Notes:
-                * The "formula" argument must be specified along with the 
-                  "algorithm" argument.
-                * Use the following link to refer the formula rules:
-                  "https://docs.teradata.com/r/Enterprise_IntelliFlex_VMware/Teradata-VantageTM-Unbounded-Array-Framework-Time-Series-Reference-17.20/Mathematic-Operators-and-Functions/Formula-Rules"
-            Types: str
-
         algorithm:
             Required Argument.
             Specifies the algorithm used for the regression.
@@ -205,12 +185,10 @@ def GoldfeldQuandt(data=None, data_filter_expr=None,
                                  payload_field=["y1", "x1"],
                                  payload_content="MULTIVAR_REAL")
 
-        # Execute GoldfeldQuandt for TDGenSeries.
+        # Execute GoldfeldQuandt.
         uaf_out = GoldfeldQuandt(data=data_series_df,
-                                 formula="Y = B0 + B1*X1",
                                  omit=2.0,
                                  significance_level=0.05,
-                                 orig_regr_paramcnt=2,
                                  algorithm="QR")
 
         # Print the result DataFrame.

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

@@ -1,5 +1,5 @@
 def HoltWintersForecaster(data=None, data_filter_expr=None, forecast_periods=None,
-                          alpha=None, beta=None, gamma=None, seasonal_periods=1,
+                          alpha=None, beta=None, gamma=None, seasonal_periods=None,
                           init_level=None, init_trend=None, init_season=None,
                           model=None, fit_percentage=100,
                           prediction_intervals="BOTH", fit_metrics=False,
@@ -67,7 +67,6 @@ def HoltWintersForecaster(data=None, data_filter_expr=None, forecast_periods=Non
             parameter is 3. Value must be greater than or equal to 1.
             Note:
                 Required when "gamma" or "init_season" is specified.
-            Default Value: 1
             Types: int
 
         init_level:
@@ -248,10 +247,13 @@ def HoltWintersForecaster(data=None, data_filter_expr=None, forecast_periods=Non
 
         # Print the result DataFrames.
         print(uaf_out.result)
+
         # Print the model statistics result.
         print(uaf_out.fitmetadata)
+
         # Print the selection metrics result.
         print(uaf_out.selmetrics)
+        
         # Print the residuals statistics result.
         print(uaf_out.fitresiduals)
     

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

@@ -1,5 +1,5 @@
 def IDFFT2(data=None, data_filter_expr=None, human_readable=True,
-           output_fmt_content=None, output_fmt_row_major=1,
+           output_fmt_content=None,
            **generic_arguments):
     """
     DESCRIPTION:
@@ -71,13 +71,6 @@ def IDFFT2(data=None, data_filter_expr=None, human_readable=True,
                               MULTIVAR_AMPL_PHASE
             Types: str
 
-        output_fmt_row_major:
-            Optional Argument.
-            Specifies whether the matrix output should be in a row-major-centric
-            or column-major-centric manner.
-            Default Value: True
-            Types: bool
-
         **generic_arguments:
             Specifies the generic keyword arguments of UAF functions.
             Below are the generic keyword arguments: