teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,142 @@
+def DickeyFuller(data=None, data_filter_expr=None, algorithm=None, 
+                 max_lags=0,
+                 **generic_arguments):
+    """
+    DESCRIPTION:
+        The DickeyFuller() function tests for the presence of one or more
+        unit roots in a series to determine if the series is non-stationary.
+        When a series contains unit roots, it is non-stationary. When a series
+        contains no unit roots, whether the series is stationary is based on
+        other factors.
+
+        The following procedure is an example of how to use DickeyFuller() function:
+            * 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.
+            Specifies a single logical-runtime series as an input or TDAnalyticResult which
+            contains ARTFITRESIDUALS layer.
+            Types: TDSeries, TDAnalyticResult
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        algorithm:
+            Required Argument.
+            Specifies the type of regression that is run for the test.
+            Permitted Values:
+                * NONE: Random walk
+                * DRIFT: Random walk with drift
+                * DRIFTNTREND: Random walk with drift and trend
+                * 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. Range is [0, 100]
+            DefaultValue: 0
+            Types: int
+
+        **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 DickeyFuller.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DickeyFuller_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","timeseriesdatasetsd4")
+
+        # Create teradataml DataFrame object.
+        df = DataFrame.from_table("timeseriesdatasetsd4")
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=df,
+                                  id="dataset_id",
+                                  row_index="seqno",
+                                  row_index_style= "SEQUENCE",
+                                  payload_field="magnitude",
+                                  payload_content="REAL")
+
+        # Example 1 : Determine whether the series is non-stationary by testing
+        #             for the presence of the unit roots using random walk with
+        #             linear trend for regression.
+        uaf_out = DickeyFuller(data=data_series_df,
+                               algorithm='DRIFT')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+    
+    """
+    

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

@@ -0,0 +1,184 @@
+def DurbinWatson(data=None, data_filter_expr=None, explanatory_count=None, 
+                 include_constant=False, method=None, 
+                 significance_level=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The DurbinWatson() function determines serial correlation between
+        residuals within an independent time series data, or in the residual result
+        of TDAnalyticResult.
+
+        The following procedure is an example of how to use DurbinWatson() function:
+            * Use LinearRegr() on the residuals.
+            * Use DurbinWatson() on the output from LinearRegr() to determine
+              if there is serial correlation.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input series or a TDAnalyticResult object
+            created over the output residual generated by the UAF function.
+            Types: TDSeries, TDAnalyticResult
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        explanatory_count:
+            Required Argument.
+            Specifies the number of explanatory variables in the original regression.
+            The number of explanatory variables along with the "include_constant"
+            information is needed to perform the lookup in the Durbin-Watson data.
+            Types: int
+
+        include_constant:
+            Optional Argument.
+            Specifies whether the original regression equation contains a constant,
+            also known as an intercept. When set to False, no constant is present,
+            otherwise constant is present.
+            Default Value: False
+            Types: bool
+
+        method:
+            Required Argument.
+            Specifies the enumerated value specifying the formula to calculate
+            the Durbin-Watson test statistic value.
+            Permitted Values:
+                * DW_FORMULA: use the full summation formula to calculate
+                              the value.
+                * ACR_LAG1: perform the regression with an autocorrelation
+                           of lag 1, and use as the role of the Durbin-Watson
+                           statistic.
+            Types: str
+
+        significance_level:
+            Required Argument.
+            Specifies the significance level for the test. Value must be greater
+            than 0 and less than 1. For example, 0.01, or 0.05.
+            Types: float
+
+        **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 DurbinWatson.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as DurbinWatson_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", ["house_values2"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("house_values2")
+
+        # Create teradataml TDSeries object.
+        linearregr_series = TDSeries(data=data,
+                                     id="cid",
+                                     row_index_style="SEQUENCE",
+                                     row_index="s_no",
+                                     payload_field=["house_value", "salary"],
+                                     payload_content="MULTIVAR_REAL"
+                                     )
+        # The LinearRegr() function fits TDSeries data to
+        # the curve mentioned in the "formula." It returns
+        # a result containing solved coefficients, model statistics,
+        # and residuals statistics.
+        linearregr_output = LinearRegr(data=linearregr_series,
+                                       variables_count=2,
+                                       weights=False,
+                                       formula="Y=B0+B1*X1",
+                                       algorithm='QR',
+                                       model_stats=True,
+                                       coeff_stats=False,
+                                       residuals=True
+                                       )
+
+        # Example 1: Determine the serial correlation using TDAnalyticResult.
+        # Create teradataml TDAnalyticResult object.
+        artspec=TDAnalyticResult(data=linearregr_output.result)
+
+        uaf_out1 = DurbinWatson(data=artspec,
+                                explanatory_count=2,
+                                method="DW_FORMULA",
+                                significance_level=0.05)
+
+        # Print the result DataFrame.
+        print(uaf_out1.result)
+
+        # Example 2: Determine the serial correlation using TDSeries.
+        # Create teradataml TDSeries object.
+        seriesspec = TDSeries(data=linearregr_output.fitresiduals,
+                              id="cid",
+                              row_index_style="SEQUENCE",
+                              row_index="ROW_I",
+                              payload_field="RESIDUAL",
+                              payload_content="REAL"
+                              )
+
+        uaf_out2 = DurbinWatson(data=seriesspec,
+                                explanatory_count=2,
+                                method="DW_FORMULA",
+                                significance_level=0.05)
+
+        # Print the result DataFrame.
+        print(uaf_out2.result)
+    
+    """
+    

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

@@ -0,0 +1,185 @@
+def ExtractResults(data=None, data_filter_expr=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The ExtractResults() function retrieves auxiliary result sets
+        stored in an ART. The auxillary layers are as follows:
+            * ARTFITRESIDUALS contains the residual series.
+            * ARTFITMETADATA contains the goodness-of-fit metrics.
+            * ARTMODEL shows the validation model context.
+            * ARTVALDATA is used for the internal validation process
+
+        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:
+
+        ------------------------------------------------------------------
+        | Function                    | Layers                           |
+        ------------------------------------------------------------------
+        | LinearRegr                  | 1. ARTPRIMARY                    |
+        |                             | 2. ARTFITMETADATA                |
+        |                             | 3. ARTFITRESIDUALS               |
+        |                             |                                  |
+        | MultivarRegr                | 1. ARTPRIMARY                    |
+        |                             | 2. ARTFITMETADATA                |
+        |                             | 3. ARTFITRESIDUALS               |
+        |                             |                                  |
+        | ArimaEstimate               | 1. ARTPRIMARY                    |
+        |                             | 2. ARTFITMETADATA                |
+        |                             | 3. ARTFITRESIDUALS               |
+        |                             | 4. ARTMODEL                      |
+        |                             | 5. ARTVALDATA                    |
+        |                             |                                  |
+        | ArimaValidate               | 1. ARTPRIMARY                    |
+        |                             | 2. ARTFITMETADATA                |
+        |                             | 3. ARTFITRESIDUALS               |
+        |                             | 4. ARTMODEL                      |
+        |                             |                                  |
+        | SeasonalNormalize           | 1. ARTPRIMARY                    |
+        |                             | 2. ARTMETADATA                   |
+        |                             |                                  |
+        | CumulPeriodogram            | 1. ARTPRIMARY                    |
+        |                             | 2. ARTCPDATA                     |
+        |                             |                                  |
+        | MAMean                      | 1. ARTPRIMARY                    |
+        |                             | 2. ARTFITMETADATA                |
+        |                             | 3. ARTFITRESIDUALS               |
+        |                             |                                  |
+        | SimpleExp                   | 1. ARTPRIMARY                    |
+        |                             | 2. ARTFITMETADATA                |
+        |                             | 3. ARTFITRESIDUALS               |
+        |                             |                                  |
+        | HoltWintersForecast         | 1. ARTPRIMARY                    |
+        |                             | 2. ARTFITMETADATA                |
+        |                             | 3. ARTSELMETRICS                 |
+        |                             | 4. ARTFITRESIDUALS               |
+        ------------------------------------------------------------------
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input data as TDAnalyticResult object
+            with "layer" argument.
+            Types: TDAnalyticResult
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        **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 ExtractResults.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as ExtractResults_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","timeseriesdatasetsd4")
+
+        # Create teradataml DataFrame object.
+        df = DataFrame.from_table("timeseriesdatasetsd4")
+
+
+        # Create teradataml TDSeries object for ArimaEstimate.
+        series_arimaestimate = TDSeries(data=df,
+                                        id="dataset_id",
+                                        row_index="seqno",
+                                        row_index_style="SEQUENCE",
+                                        payload_field="magnitude",
+                                        payload_content="REAL")
+
+        # Function outputs a result set that contains the estimated
+        # coefficients with accompanying per-coefficient statistical ratings.
+        arima_estimate = ArimaEstimate(data1=series_arimaestimate,
+                                       nonseasonal_model_order=[1,0,0],
+                                       constant=True,
+                                       algorithm='MLE',
+                                       fit_percentage=70,
+                                       coeff_stats=True,
+                                       fit_metrics=True,
+                                       residuals=True
+                                       )
+
+        # Example 1 : Extract the residuals from the ArimaEstimate function
+        #             output, by specifying the layer name 'ARTFITRESIDUALS'.
+        # Create teradataml TDAnalyticResult object.
+        art_extractresult = TDAnalyticResult(data=arima_estimate.result,
+                                             layer="ARTFITRESIDUALS")
+
+        # Execute the function ExtractResults() to extract the layer.
+        uaf_out1 = ExtractResults(data=art_extractresult)
+
+        # Print the result DataFrame.
+        print(uaf_out1.result)
+
+        # Example 2 : Extract the residuals from the ArimaEstimate function
+        #             output, by specifying the layer name 'ARTFITMETADATA'.
+        # Create teradataml TDAnalyticResult object.
+        art_extractresult = TDAnalyticResult(data=arima_estimate.result,
+                                             layer="ARTFITMETADATA")
+
+        # Execute the function ExtractResults() to extract the layer.
+        uaf_out2 = ExtractResults(data=art_extractresult)
+
+        # Print the result DataFrame.
+        print(uaf_out2.result)
+    
+    """
+    

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: int OR 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: int OR 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: int OR float
+
+        sampling_frequency:
+            Required Argument.
+            Specifies the frequency that the data to be filtered was
+            sampled. It must be greater than 0.
+            Types: int OR 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)
+    
+    """
+