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

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:

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

@@ -0,0 +1,246 @@
+def SAX(data=None, data_filter_expr=None, window_type='GLOBAL', 
+        output_type='STRING', mean=None, std_dev=None, 
+        window_size=None, output_frequency=1, 
+        points_per_symbol=1, symbols_per_window=1, 
+        alphabet_size=4, bitmap_level=2, code_stats=0, 
+        breakpoints=None, 
+        output_fmt_index_style="NUMERICAL_SEQUENCE", 
+        **generic_arguments):
+    """
+    DESCRIPTION:
+        SAX() function uses Piecewise Aggregate Approximation (PAA) and 
+        transform a timeseries into sequence of symbols.
+        The symbols can be characters, string, and bitmap.
+
+
+    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
+
+        window_type:
+            Optional Argument.
+            Specifies the window type used in the SAX transformation.
+            Default Value: GLOBAL
+            Permitted Values: GLOBAL, SLIDING
+            Types: str
+
+        output_type:
+            Optional Argument.
+            Specifies the output format of the result.
+            Default Value: STRING
+            Permitted Values: STRING, BITMAP, O_CHARS
+            Types: str
+
+        mean:
+            Optional Argument.
+            Specifies the global mean values that used to
+            calculate the SAX code for every partition.
+            Note:
+                * If "mean" not specified, the function calculates the mean values
+                  for every partition.
+                * If "mean" specifies a single value but there are multiple payloads,
+                  the specified value will apply to all payloads.
+                * If "mean" specifies multiple values, each value will be 
+                  applied to its corresponding payload.
+            Types: float, list of float
+
+        std_dev:
+            Optional Argument.
+            Specifies the global standard deviation values that used to
+            calculate the SAX code for every partition.
+            Note:
+                * If "std_dev" not specified, the function calculates the standard
+                  deviation values for every partition.
+                * If "std_dev" specifies a single value but there are multiple payloads,
+                  the specified value will apply to all payloads.
+                * If "std_dev" specifies multiple values, each value will be
+                  applied to its corresponding payload.
+            Types: float, list of float
+
+        window_size:
+            Optional Argument, Required if "window_type" is SLIDING.
+            Specifies the size of the window used in the SAX
+            transformation. Maximum value is 64000.
+            Types: int
+
+        output_frequency:
+            Optional Argument.
+            Specifies the number of data points that the window slides
+            between successive outputs.
+            Note:
+                * "output_frequency" is valid only for SLIDING "window_type".
+            Default Value: 1
+            Types: int
+
+        points_per_symbol:
+            Optional Argument.
+            Specifies the number of data points to be converted to one SAX
+            symbol.
+            Note:
+                * "points_per_symbol" is valid for GLOBAL "window_type".
+            Default Value: 1
+            Types: int
+
+        symbols_per_window:
+            Optional Argument.
+            Specifies the number of SAX symbols to be generated for each
+            window.
+            Note:
+                * "symbols_per_window" is valid for SLIDING "window_type".
+            Default Value: 1
+            Types: int
+
+        alphabet_size:
+            Optional Argument.
+            Specifies the number of symbols in the SAX alphabet. 
+            The alphabet consists of letters from 'a' to 't'.
+            The size of the alphabet must be less than or equal to 20 
+            and greater than or equal to 2.
+            Default Value: 4
+            Types: int
+
+        bitmap_level:
+            Optional Argument.
+            Specifies the level of the bitmap. The bitmap level
+            determines the number of consecutive symbols to be
+            converted to one symbol on a bitmap. 
+            "bitmap_level" must be greater than or equal to 1 and less than or equal to 4.
+            Default Value: 2
+            Types: int
+
+        code_stats:
+            Optional Argument.
+            Specifies whether to print the mean and standard deviation
+            Default Value: 0
+            Types: int
+
+        breakpoints:
+            Optional Argument.
+            Specifies the breakpoints to form the SAX code based on "data".
+            Types: float, list of float
+
+        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 SAX.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as SAX_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 SAX.
+        from teradataml import SAX
+
+        # Load the example data.
+        load_example_data("sax", ["finance_data4"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("finance_data4")
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=data,
+                                  id="id",
+                                  row_index="period",
+                                  row_index_style="SEQUENCE",
+                                  payload_field=["expenditure", "income", "investment"],
+                                  payload_content="MULTIVAR_REAL")
+
+        # Example 1: Execute SAX() function on the TDSeries to transform the
+        #            time series into sequence of symbols using GLOBAL window.
+        uaf_out = SAX(data=data_series_df, 
+                      window_type='GLOBAL', 
+                      output_type='STRING', 
+                      mean=[2045.16666, 2387.41666,759.083333], 
+                      std_dev=[256.612489,317.496587,113.352594], 
+                      output_frequency=1, 
+                      points_per_symbol=2,
+                      alphabet_size=10,
+                      code_stats=True)
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+
+        # Example 2: Execute SAX() function on the TDSeries to transform the
+        #            time series into sequence of symbols using SLIDING window.
+        uaf_out1 = SAX(data=data_series_df, 
+                       window_type='SLIDING', 
+                       window_size=4,
+                       symbols_per_window=5, 
+                       code_stats=True)
+
+        # Print the result DataFrame.
+        print(uaf_out1.result)
+    
+    """
+