teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,172 @@
+def FitMetrics(data=None, data_filter_expr=None, var_count=None,
+               fstat=False, significance_level=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The FitMetrics() takes the original series, the model-predicted series,
+        the original series mean and the modeling residuals to generate the
+        goodness-of-fit of the modeling exercise.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies a single multivariate series as an input or a
+            TDAnalyticResult object over the residual results from
+            a previously run regression operation.
+            When multivariate series is the input, the three fields
+            should be the original series, predicted series,
+            and residuals from the original regression.
+            Types: TDSeries, TDAnalyticResult
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        var_count:
+            Required Argument.
+            Specifies an integer indicating how many explanatory variables
+            including the constant are used while calculating the fitness
+            metrics.
+            Types: int
+
+        fstat:
+            Optional Argument.
+            Specifies whether to include F-test related
+            statistics in the final result.
+            When set to True, results are included otherwise,
+            results are not included.
+            Default Value: False
+            Types: bool
+
+        significance_level:
+            Optional Argument.
+            Specifies the significance level for the test.
+            Value should be between 0 and 1.
+            Note:
+                Valid only when "fstat" is set to True.
+            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 FitMetrics.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as FitMetrics_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.
+        data = DataFrame.from_table("timeseriesdatasetsd4")
+
+        # Execute ArimaEstimate() function to estimate the coefficients
+        # and statistical ratings corresponding to an ARIMA model.
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=data,
+                                  id="dataset_id",
+                                  row_index="seqno",
+                                  row_index_style="SEQUENCE",
+                                  payload_field="magnitude",
+                                  payload_content="REAL")
+
+        # Execute ArimaEstimate function.
+        arima_estimate_op = ArimaEstimate(data1=data_series_df,
+                                          nonseasonal_model_order=[2,0,0],
+                                          constant=False,
+                                          algorithm="MLE",
+                                          coeff_stats=True,
+                                          fit_metrics=True,
+                                          residuals=True,
+                                          fit_percentage=80)
+
+        # Example 1: Generate goodness of fit metrics by using TDAnalyticResult
+        #            object over the result attribute of 'arima_estimate_op'
+        #            with 'ARTFITRESIDUALS' layer as input.
+        # Create teradataml TDAnalyticResult object.
+        data_art_df = TDAnalyticResult(data=arima_estimate_op.result,
+                                       layer="ARTFITRESIDUALS")
+
+        uaf_out = FitMetrics(data=data_art_df,
+                             var_count=5,
+                             fstat=True,
+                             significance_level=0.05)
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+        # Example 2: Generate goodness of fit metrics by using TDSeries over
+        #            the 'fitresiduals' attribute of 'arima_estimate_op'
+        #            as input.
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=arima_estimate_op.fitresiduals,
+                                  id="dataset_id",
+                                  row_index="ROW_I",
+                                  row_index_style="SEQUENCE",
+                                  payload_field=["RESIDUAL", "ACTUAL_VALUE",
+                                                 "CALC_VALUE"],
+                                  payload_content="MULTIVAR_REAL")
+
+        uaf_out = FitMetrics(data=data_series_df, var_count=5)
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+    """

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

@@ -0,0 +1,206 @@
+def GenseriesFormula(data=None, data_filter_expr=None, formula=None, 
+                     estimate_mode=False, 
+                     output_fmt_index_style="NUMERICAL_SEQUENCE", 
+                     **generic_arguments):
+    """
+    DESCRIPTION:
+        The GenseriesFormula() function allows you to define and apply
+        a formula to generate a time series. This function has many use
+        cases, including the ability to generate a series that is 
+        subtracted from a non-stationary series to make it stationary,
+        and to estimate beyond the sample data points.
+
+        The following procedure is an example of how to use the
+        GenseriesFormula() function:
+            * Determine that the series to be modeled includes
+              a trend.
+            * Use LinearRegr() function to remove the trend from 
+              the series.
+            * Use the "fitmetadata" attribute from the function output,
+              to determine the trend by fitting the data set.
+            * Use GenseriesFormula() function to generate a
+              trend series.
+            * Use BinarySeriesOp() function to subtract the
+              generated trend from the original series.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input time series or self-generating
+            time series.
+            Notes:
+                * Series specification is a time series or 
+                  spatial series. Series can be REAL or MULTIVAR_REAL.
+                * Generated series specification uses a self-generated series.
+            Types: TDSeries, TDGenseries
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        formula:
+            Required Argument.
+            Specifies the formula to apply to the input time series.
+            The formula represents the trend or periodicity in the input time 
+            series and conforms to formula rules.
+            
+            If you specify generated series, TDGenSeries, the formula
+            can have only one explanatory variable. The function assigns
+            the starting value to the explanatory variable.
+            Note:
+                Use the following link to refer the formula rules in
+                Teradata document:
+                "https://docs.teradata.com/r/Teradata-VantageTM-Unbounded-Array-Framework-Time-Series-Reference/Mathematic-Operators-and-Functions/Formula-Rules"
+            Types: str
+
+        estimate_mode:
+            Optional Argument.
+            Specifies whether to include the input parameters in the results.
+            When set to True, function includes input parameters in the results,
+            otherwise does not include.
+            Default Value: False
+            Types: bool
+
+        output_fmt_index_style:
+            Optional Argument.
+            Specifies the index style of the output format.            
+            Permitted Values: NUMERICAL_SEQUENCE, FLOW_THROUGH
+            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 GenseriesFormula.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as GenseriesFormula_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")
+
+        from teradataml import FLOAT, INTEGER
+
+        # Load the example data.
+        load_example_data("uaf", ["production_data2"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("production_data2")
+
+        # Example 1: Execute the GenseriesFormula() function on TDSeries input 
+        #            for index style 'FLOW_THROUGH' to generate a time series.
+        #            New time series with the same type as the series
+        #            specification payload content value.
+        # Create teradataml TDSeries object.
+        data_series_df_1 = TDSeries(data=data,
+                                    id="product_id",
+                                    row_index="TD_TIMECODE",
+                                    payload_field="beer_sales",
+                                    payload_content="REAL")
+
+        # Execute GenseriesFormula for TDSeries.
+        uaf_out_1 =  GenseriesFormula(data=data_series_df_1,
+                                      formula="Y = 2.0*X1 + SIN(X1)",
+                                      output_fmt_index_style='FLOW_THROUGH')
+
+        # Print the result DataFrame.
+        print(uaf_out_1.result)
+
+        # Example 2: Execute the GenseriesFormula() function on TDGenSeries input 
+        #            for index style value 'NUMERICAL_SEQUENCE' and TDGenSeries
+        #            data types as FLOAT to generate a time series.
+        #            Functions returns new time series with the same type as 
+        #            the generated series specification payload content value.
+        #            TDGenSeries datatypes is float.
+        # Create teradataml TDGenSeries object.
+        data_series_df_2 = TDGenSeries(instances = {"BuoyID": 3},
+                                       data_types = FLOAT(),
+                                       start=0.0,
+                                       offset=1.0,
+                                       num_entries=5)
+
+        # Execute GenseriesFormula for TDGenSeries.
+        uaf_out_2 =  GenseriesFormula(data=data_series_df_2,
+                                      formula="Y = 3.0 + 8.0*X1",
+                                      output_fmt_index_style='NUMERICAL_SEQUENCE')
+
+        # Print the result DataFrame.
+        print(uaf_out_2.result)
+
+        # Example 3: Execute the GenseriesFormula() function on TDGenSeries input 
+        #            for index style value 'NUMERICAL_SEQUENCE' and TDGenSeries
+        #            data types as INTEGER to generate a time series.
+        #            Functions returns new time series with the same type as 
+        #            the generated series specification payload content value.
+        #            TDGenSeries datatypes is integer.
+        # Create teradataml TDGenSeries object.
+        data_series_df_3 = TDGenSeries(instances = {"BuoyID": 3},
+                                       data_types = INTEGER(),
+                                       start=0,
+                                       offset=1,
+                                       num_entries=5)
+
+        # Execute GenseriesFormula for TDGenSeries.
+        uaf_out_3 =  GenseriesFormula(data=data_series_df_3,
+                                      formula="Y = 3.0 + 8.0*X1",
+                                      output_fmt_index_style='NUMERICAL_SEQUENCE')
+
+        # Print the result DataFrame.
+        print(uaf_out_3.result)
+
+    """
+    

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

@@ -0,0 +1,143 @@
+def GenseriesSinusoids(data=None, data_filter_expr=None, periodicities=None, 
+                       output_fmt_index_style="NUMERICAL_SEQUENCE", 
+                       **generic_arguments):
+    """
+    DESCRIPTION:        
+        The GenseriesSinusoids() function generates a result series
+        containing a subset of the sinusoidal elements periodicities (sinusoids).
+        
+        User can subtract the new time series from the original time series
+        by removing the periodicities. The following procedure is an
+        example of how to use GenseriesSinusoids() function:
+            * Use the LineSpec() or PowerSpec() function with "freq_style" argument
+              set to 'K_PERIODICITY' to determine the periodicities in
+              the series.
+            * Use the result dataframe from the GenseriesSinusoids() function
+              to view the periodicities.
+            * Use GenseriesSinusoids() function with the "periodicities"
+              argument and a comma-separated list of periodicities to
+              exclude from the data set.
+            * Use the BinarySeriesOp() function to subtract the generated series
+              from the original series using "mathop" argument value as 'SUB'.
+            * Use the PowerSpec() function to verify that target periodicities
+              have been removed from the original series.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input time series, whose payload content
+            value is 'REAL'.
+            Types: TDSeries
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        periodicities:
+            Required Argument.
+            Specifies the periodicity as a comma-separated list, which
+            contains one or more floating point values representing 
+            periodicities.
+            Types: int, list of int, float, list of float
+            
+        output_fmt_index_style:
+            Optional Argument.
+            Specifies the index style of the output format.
+            Permitted Values: NUMERICAL_SEQUENCE, FLOW_THROUGH
+            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 GenseriesSinusoids.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as GenseriesSinusoids_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", ["production_data"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("production_data")
+
+        # Example 1: Execute the GenseriesSinusoids() function 
+        #            on TDSeries input to generate a time series 
+        #            containing a subset of the sinusoidal 
+        #            elements periodicities, whose payload content
+        #            value is REAL.
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=data,
+                                  id="product_id",
+                                  row_index="TD_TIMECODE",
+                                  payload_field="beer_sales",
+                                  payload_content="REAL")
+
+        # Execute GenseriesSinusoids() fucntion.
+        uaf_out = GenseriesSinusoids(data=data_series_df,
+                                     periodicities=[0.523, 1.4367])
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+    """
+