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

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

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

@@ -0,0 +1,297 @@
+def Matrix2Image(data=None, data_filter_expr=None, image="PNG", type=None, 
+                 colormap="viridis", range=None, red=None, green=None, 
+                 blue=None, flip_x=False, flip_y=False, 
+                 input_fmt_input_mode=None, 
+                 output_fmt_index_style="NUMERICAL_SEQUENCE", 
+                 **generic_arguments):
+    """
+    DESCRIPTION:
+        Matrix2Image() function converts a matrix to an image.
+        The conversion produces an image using color maps.
+        The color image produced by Matrix2Image() is limited to
+        8-bit color depth.
+        In previous versions, Plot() with MESH option was used to
+        convert a matrix to an image. Plot() is limited to a
+        single payload.
+        Matrix2Image() can combine three payloads to create RGB
+        color images.
+
+
+    PARAMETERS:
+        data:
+            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
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        image:
+            Optional Argument.
+            Specifies the image output format.
+            It can be PNG or JPG.
+            Permitted Values: PNG, JPG
+            Default Value: PNG
+            Types: str
+
+        type:
+            Optional Argument.
+            Specifies the type of the image. It can be GRAY, RGB
+            or COLORMAP.
+                * GRAY has a single payload, the output
+                  image is a gray scale image.
+                * RGB has three payloads corresponding to RED, GREEN and BLUE channels,
+                  the output image is a RGB color image.
+                * COLORMAP has a single payload. The output image is a RGB color image.
+            Note:
+                If there is a single payload, then the default
+                type is GRAY. If there are three payloads, then the
+                default type is RGB.
+            Permitted Values: GRAY, RGB, COLORMAP
+            Types: str
+
+        colormap:
+            Optional Argument.
+            Specifies the colormap to use when the "type" is
+            COLORMAP. The values correspond to the colormap of
+            Plot(). If not specified, then the default colormap is
+            "viridis". The value is case-sensitive.
+            Default Value: viridis
+            Types: str
+
+        range:
+            Optional Argument.
+            Specifies the range of the single payload value to be
+            scaled. By default, the MIN and MAX values of the
+            payload are used as the range. Used when "type" is 'GRAY'
+            or 'COLORMAP'.
+            Types: float, list of float
+
+        red:
+            Optional Argument.
+            Specifies the range of the first payload value. By
+            default, the MIN and MAX values of the payload are 
+            used as the range. It is only used when "type" is 'RGB'.
+            Types: float, list of float
+
+        green:
+            Optional Argument.
+            Specifies the range of the second payload value.By
+            default, the MIN and MAX values of the payload are 
+            used as the range. It is only used when "type" is 'RGB'.
+            Types: float, list of float
+
+        blue:
+            Optional Argument.
+            Specifies the range of the third payload value. By
+            default, the MIN and MAX values of the payload are 
+            used as the range. It is only used when "type" is 'RGB'.
+            Types: float, list of float
+
+        flip_x:
+            Optional Argument.
+            Specifies the indicator to flip the image horizontally.
+            When set to True, flip the image otherwise, do not
+            flip the image.
+            Default Value: False
+            Types: bool
+
+        flip_y:
+            Optional Argument.
+            Specifies the indicator to flip the image vertically.
+            When set to True, flip the image otherwise,
+            do not flip the image.
+            Default Value: False
+            Types: bool
+
+        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 Matrix2Image.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as Matrix2Image_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 Matrix2Image.
+        from teradataml import Matrix2Image
+
+        # Convert the image to matrix using 'TD_IMAGE2MATRIX' using output as gray.
+        import teradataml
+        # Drop the image table, matrixTable, matrixTable_rgb if it is present.
+        try:
+            db_drop_table('imageTable')
+            db_drop_table('matrixTable')
+            db_drop_table('matrixTable_rgb')
+        except:
+            pass
+
+        execute_sql('CREATE TABLE imageTable(id INTEGER, image BLOB);')
+
+        file_dir = os.path.join(os.path.dirname(teradataml.__file__), "data")
+        with open(os.path.join(file_dir,'peppers.png'), mode='rb') as file:
+            fileContent = file.read()
+
+        sql = 'INSERT INTO imageTable VALUES(?, ?);'
+        parameters = (1, fileContent)
+        execute_sql(sql, parameters)
+
+        execute_sql("CREATE TABLE matrixTable AS (SELECT * FROM TD_IMAGE2MATRIX ( ON (SELECT id, image FROM imageTable) USING OUTPUT ('gray')) t) WITH DATA PRIMARY INDEX (id, y, x);")
+        data = DataFrame('matrixTable')
+
+        # Create teradataml TDMatrix object.
+        data_matrix_df = TDMatrix(data=data,
+                                  id="id",
+                                  row_index="Y",
+                                  column_index="X",
+                                  row_index_style="SEQUENCE",
+                                  column_index_style="SEQUENCE",
+                                  payload_field="GRAY",
+                                  payload_content="REAL"
+                                  )
+
+        # Example 1: Generate Gray Scale Image Output with Fixed Range.
+        uaf_out = Matrix2Image(data=data_matrix_df,
+                               range=[0,255])
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+
+        # Example 2: Generate Gray Scale Image Output with Automatic Range.
+        uaf_out = Matrix2Image(data=data_matrix_df)
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+
+        # Example 3: Generate Colormap Image Output.
+        uaf_out = Matrix2Image(data=data_matrix_df,
+                               type='colormap',
+                               colormap='viridis',
+                               range=[0,255])
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+        # Convert the image to matrix using 'TD_IMAGE2MATRIX' using output as 'rgb'.
+        execute_sql("CREATE TABLE matrixTable_rgb AS (SELECT * FROM TD_IMAGE2MATRIX ( ON (SELECT id, image FROM imageTable) USING OUTPUT ('rgb')) t) WITH DATA PRIMARY INDEX (id, y, x);")
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("matrixTable_rgb")
+
+        # Create teradataml TDMatrix object.
+        data_matrix_df = TDMatrix(data=data,
+                                  id="id",
+                                  row_index="Y",
+                                  column_index="X",
+                                  row_index_style="SEQUENCE",
+                                  column_index_style="SEQUENCE",
+                                  payload_field=["RED", "BLUE", "GREEN"],
+                                  payload_content="MULTIVAR_REAL"
+                                  )
+
+        # Example 4: Generate RGB Image Output with All Channels Range Fixed.
+        uaf_out = Matrix2Image(data=data_matrix_df,
+                               red=[0,255],
+                               green=[0,255],
+                               blue=[0,255])
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+
+        # Example 5: Generate RGB Image Output with Automatic Range for All Channels.
+        uaf_out = Matrix2Image(data=data_matrix_df)
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+    
+    """
+    

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

@@ -113,13 +113,22 @@ def MatrixMultiply(data1=None, data1_filter_expr=None, data2=None,
         df2 = DataFrame.from_table("mtx2")
 
         # Create teradataml TDMatrix objects.
-        data1_matrix_df = TDMatrix(data=df1, id='buoy_id', row_index='row_i',
-                                   column_index = 'column_i', row_index_style="SEQUENCE",
-                                   column_index_style="SEQUENCE", payload_field='speed1',
+        data1_matrix_df = TDMatrix(data=df1, 
+                                   id='buoy_id', 
+                                   row_index='row_i',
+                                   column_index='column_i', 
+                                   row_index_style="SEQUENCE",
+                                   column_index_style="SEQUENCE", 
+                                   payload_field='speed1',
                                    payload_content='REAL')
-        data2_matrix_df = TDMatrix(data=df2, id='buoy_id', row_index='row_i',
-                                   column_index = 'column_i', row_index_style="SEQUENCE",
-                                   column_index_style="SEQUENCE", payload_field='speed2',
+
+        data2_matrix_df = TDMatrix(data=df2, 
+                                   id='buoy_id', 
+                                   row_index='row_i',
+                                   column_index='column_i', 
+                                   row_index_style="SEQUENCE",
+                                   column_index_style="SEQUENCE", 
+                                   payload_field='speed2',
                                    payload_content='REAL')
 
         # Example 1 : Perform a point-wise mathematical operation against two matrixes

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

@@ -146,7 +146,6 @@ def PACF(data=None, data_filter_expr=None,
 
         # Example 1 : Calculate the partial autocorrelation function coefficients using
         #             'LEVINSON_DURBIN' algorithm, with maximum of 10 lags.
-
         PACF_out = PACF(data=data_series_df,
                         algorithm='LEVINSON_DURBIN',
                         max_lags=10)

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

@@ -12,8 +12,8 @@ def Portman(data=None, data_filter_expr=None, max_lags=None, test=None,
         The following procedure is an example of how to use Portman() function:
             1. Use ArimaEstimate() function to get residuals from the data set.
             2. Use ArimaValidate() function to validate the output.
-            3. white noise using the "fitresiduals" output attributed of ArimaValidate() function.
-
+            3. Use Portman() to check the residuals for zero mean white noise using the 
+            "fitresiduals" output attribute of ArimaValidate() function.
 
     PARAMETERS:
         data:

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

@@ -16,7 +16,7 @@ def PowerSpec(data=None, data_filter_expr=None, freq_style=None,
             * Use ArimaValidate() to validate spectral candidates.
             * Use PowerSpec() with "freq_style" argument set to 'K_PERIODICITY'
               to perform spectral analysis.
-            * Use Plot() to plot the results.
+            * Use DataFrame.plot() to plot the results.
             * Compute the test statistic.
             * Use SignifPeriodicities() on the periodicities of interest.
               More than one periodicities can be entered using the Periodicities
@@ -98,7 +98,7 @@ def PowerSpec(data=None, data_filter_expr=None, freq_style=None,
                          a square wave window, which has a magnitude of '1.0'
                          for the whole duration of the window.
                 * TUKEY : Apply a Tukey smoothing window with the supplied
-                          alpha value. Must use with "window_param". 
+                          alpha value. Must be used with "window_param". 
                 * BARTLETT : Apply a Bartlett smoothing window.
                 * PARZEN : Apply a Parzen smoothing window.
                 * WELCH : Apply a Welch smoothing window.

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

@@ -2,7 +2,7 @@ def Resample(data=None, data_filter_expr=None, timecode_start_value=None,
              timecode_duration=None, sequence_start_value=None,
              sequence_duration=None, interpolate=None, weight=None,
              spline_params_method="NOT_A_KNOT", spline_params_yp1=0.0,
-             spline_params_ypn=0.0, **generic_arguments):
+             spline_params_ypn=0.0, output_fmt_index_style='FLOW_THROUGH',  **generic_arguments):
     """
     DESCRIPTION:
         The Resample() function transforms an irregular time series into a
@@ -83,6 +83,7 @@ def Resample(data=None, data_filter_expr=None, timecode_start_value=None,
             Specifies the interpolated weighted value.
             Note:
                 * Applicable only when "interpolate" set to 'WEIGHTED'.
+                * The interpolated value is calculated as: Y_t  =  Y_{t_LEFT} * (1 - WEIGHT) + (Y-{t_RIGHT} * WEIGHT).
             Types: float
 
         spline_params_method:
@@ -117,6 +118,13 @@ def Resample(data=None, data_filter_expr=None, timecode_start_value=None,
             Default Value: 0.0
             Types: float
 
+        output_fmt_index_style:
+            Optional Argument.
+            Specifies the index style of the output format.
+            Permitted Values: NUMERICAL_SEQUENCE, FLOW_THROUGH
+            Default Value: FLOW_THROUGH
+            Types: str
+
         **generic_arguments:
             Specifies the generic keyword arguments of UAF functions.
             Below are the generic keyword arguments: