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

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

@@ -0,0 +1,236 @@
+def IDWT(data1=None, data1_filter_expr=None, data2=None, 
+         data2_filter_expr=None, wavelet=None, mode="symmetric", 
+         part=None, input_fmt_input_mode=None, 
+         output_fmt_index_style="NUMERICAL_SEQUENCE", 
+         **generic_arguments):
+    """
+    DESCRIPTION:
+        IDWT() is a function that performs inverse discrete wavelet transform (IDWT).
+
+    PARAMETERS:
+        data1:
+            Required Argument.
+            Specifies the input series. 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 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 Values:
+                * 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
+
+        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:
+                * 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 IDWT.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as IDWT_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 IDWT.
+        from teradataml import IDWT
+
+        # Load the example data.
+        load_example_data("uaf", ["idwt_dataTable", "idwt_filterTable"])
+
+        # Create teradataml DataFrame objects.
+        data1 = DataFrame.from_table("idwt_dataTable")
+        data2 = DataFrame.from_table("idwt_filterTable")
+
+        # Create teradataml TDSeries objects.
+        data1_series_df = TDSeries(data=data1,
+                                   id="id",
+                                   row_index="rowi",
+                                   row_index_style="SEQUENCE",
+                                   payload_field=["approx"],
+                                   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 inverse discrete wavelet transform using 2 series as input.
+        uaf_out = IDWT(data1=data1_series_df,
+                       data2=data2_series_df,
+                       data2_filter_expr=data2.id==1,
+                       input_fmt_input_mode="MANY2ONE",
+                       part='a')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+        # Example 2: Perform inverse discrete wavelet transform using 1 series as input and wavelet parameter.
+
+        # Create teradataml TDSeries objects.
+        data_series_df = TDSeries(data=data1,
+                                  id="id",
+                                  row_index="rowi",
+                                  row_index_style="SEQUENCE",
+                                  payload_field=["approx", "detail"],
+                                  payload_content="MULTIVAR_REAL")
+
+        uaf_out = IDWT(data1=data_series_df,
+                       wavelet='haar')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+    
+    """
+    

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

@@ -0,0 +1,226 @@
+def IDWT2D(data1=None, data1_filter_expr=None, data2=None, 
+           data2_filter_expr=None, wavelet=None, mode="symmetric", 
+           input_fmt_input_mode=None, 
+           output_fmt_index_style="NUMERICAL_SEQUENCE", 
+           **generic_arguments):
+    """
+    DESCRIPTION:
+        IDWT2D() function performs inverse discrete wavelet transform
+        (IDWT) for two-dimensional data. The algorithm is applied 
+        first horizontally by row axis, then vertically by column 
+        axis.
+
+    PARAMETERS:
+        data1:
+            Required Argument.
+            Specifies the input matrix. Multiple
+            payloads are supported, and each payload column is 
+            transformed independently. Only MULTIVAR_REAL payload
+            content type is 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.
+            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
+
+        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 IDWT2D.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as IDWT2D_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 IDWT2D.
+        from teradataml import IDWT2D
+
+        # Load the example data.
+        load_example_data("uaf", ["idwt2d_dataTable", "idwt_filterTable"])
+
+        # Create teradataml DataFrame objects.
+        data1 = DataFrame.from_table("idwt2d_dataTable")
+        data2 = DataFrame.from_table("idwt_filterTable")
+
+        # 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")
+
+        # Execute DWT2D
+        uaf_out = DWT2D(data1=data1_matrix_df,
+                        wavelet='haar')
+
+        # Example 1: Perform inverse discrete wavelet transform using TDAnalyticResult
+        #            from DWT2D() as input and wavelet as 'haar'
+
+        # Create teradataml TDAnalyticResult object.
+        art_df = TDAnalyticResult(data=uaf_out.result)
+
+        uaf_out = IDWT2D(data1=art_df,
+                         wavelet='haar')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+        # Example 1: Perform inverse discrete wavelet transform using TDAnalyticResult from DWT2D()
+        #            and TDSeries as input.
+
+        # 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")
+
+        uaf_out = IDWT2D(data1=art_df,
+                         data2=data2_series_df,
+                         data2_filter_expr=data2.id==1,
+                         input_fmt_input_mode='MANY2ONE')
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+    
+    """
+    

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

@@ -0,0 +1,134 @@
+def IQR(data=None, data_filter_expr=None, stat_metrics=False, 
+        output_fmt_index_style="NUMERICAL_SEQUENCE", 
+        **generic_arguments):
+    """
+    DESCRIPTION:
+        Anomaly detection identifies data points, events and observations that
+        deviate from the normal behavior of the data set.
+        Anomalous data can indicate critical incidents, such as a change in
+        consumer behavior or observations that are suspicious.
+        Anomalies in data are also called standard deviations, outliers, noise,
+        novelties, and exceptions.
+
+        IQR() uses interquartile range for anomaly detection. Any data point
+        that falls outside of 1.5 times of an interquartile range below
+        the first quartile and above the third quartile is considered an outlier.
+        The IQR() function creates a two-layered ART table.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the time series whose value can be REAL or MULTIVAR_REAL.
+            Types: TDSeries
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        stat_metrics:
+            Optional Argument.
+            Specifies the indicator for the secondary layer
+            to indicate the number of outliers.
+            Default Value: False
+            Types: bool
+
+        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 IQR.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as IQR_obj.<attribute_name>.
+        Output teradataml DataFrame attribute names are:
+            1. result
+            2. statsdata
+            3. fitmetadata
+
+
+    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", ["real_values"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("real_values")
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=data,
+                                   id="id",
+                                   row_index="TD_TIMECODE",
+                                   payload_field="val",
+                                   payload_content="REAL")
+
+        # Example 1: Detect which and how many values are considered outliers.
+        uaf_out = IQR(data=data_series_df,
+                      stat_metrics=True)
+
+        # Print the result DataFrames.
+        print(uaf_out.result)
+        print(uaf_out.statsdata)
+    
+    """
+    

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

@@ -10,7 +10,7 @@ def LineSpec(data=None, data_filter_expr=None, freq_style="K_INTEGRAL",
             2. Use ArimaValidate() to validate spectral candidates.
             3. Use LineSpec() with "freq_style" parameter set to K_PERIODICITY
                to perform spectral analysis.
-            4. Use Plot() to plot the results.
+            4. Use DataFrame.plot() to plot the results.
             5. Compute the test statistic.
             6. Use SignifPeriodicities() on the periodicities of interest.
                More than one periodicity can be entered using the "periodicities"

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

@@ -24,8 +24,8 @@ def LinearRegr(data=None, data_filter_expr=None, variables_count=2,
         data:
             Required Argument.
             Specifies an input time series with the following payload characteristics:
-                * CONTENT value is MULTIVAR_REAL.
-                * FIELDS has two required fields (response variable and 
+                * "payload_content" value is MULTIVAR_REAL.
+                * "payload_fields" has two required fields (response variable and 
                   explanatory variable, in that order) and one optional 
                   field (weights).
             Types: TDSeries

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

@@ -52,8 +52,8 @@ def MAMean(data=None, data_filter_expr=None, forecast_periods=None,
         fit_metrics:
             Optional Argument.
             Specifies a flag to generate the secondary result set that contains the model metadata
-            statistics. when set to True, function generate the secondary result set,otherwise
-            not.The generated result set can be retrieved using the attribute fitmetadata of
+            statistics. When set to True, function generate the secondary result set, otherwise
+            not. The generated result set can be retrieved using the attribute fitmetadata of
             the function output.
             Default Value: False
             Types: bool
@@ -61,7 +61,7 @@ def MAMean(data=None, data_filter_expr=None, forecast_periods=None,
         residuals:
             Optional Argument.
             Specifies a flag to generate the tertiary result set that contains the model residuals.
-            when set to True, means generate the tertiary result set, otherwise not.
+            When set to True, means generate the tertiary result set, otherwise not.
             The generated result set can be retrieved using the attribute fitresiduals of
             the function output.
             Default Value: False