teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,237 @@
+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, output_fmt_index_style='FLOW_THROUGH',  **generic_arguments):
+    """
+    DESCRIPTION:
+        The Resample() function transforms an irregular time series into a
+        regular time series. It can also be used to alter the sampling interval
+        for a time series.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the irregular time series that is to be altered.
+            Types: TDSeries
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies the filter expression for "data".
+            Types: ColumnExpression
+
+        timecode_start_value:
+            Optional Argument.
+            Specifies the first sampling index to interpolate.
+            Note:
+                Provide either arguments "timecode_start_value" and
+                "timecode_duration", or arguments "sequence_start_value"
+                and "sequence_duration".
+            Types: str
+
+        timecode_duration:
+            Optional Argument.
+            Specifies the sampling interval associated with the result series.
+            Note:
+                Provide either arguments "timecode_start_value" and
+                "timecode_duration", or arguments "sequence_start_value"
+                and "sequence_duration".
+            Permitted Values:
+                * CAL_YEARS
+                * CAL_MONTHS
+                * CAL_DAYS
+                * WEEKS
+                * DAYS
+                * HOURS
+                * MINUTES
+                * SECONDS
+                * MILLISECONDS
+                * MICROSECONDS
+            Types: str
+
+        sequence_start_value:
+            Optional Argument.
+            Specifies the first sampling index to interpolate.
+            Note:
+                Provide either arguments "timecode_start_value" and
+                "timecode_duration", or arguments "sequence_start_value"
+                and "sequence_duration".
+            Types: int OR float
+
+        sequence_duration:
+            Optional Argument.
+            Specifies the sampling interval associated with the result series.
+            Note:
+                Provide either arguments "timecode_start_value" and
+                "timecode_duration", or arguments "sequence_start_value"
+                and "sequence_duration".
+            Types: int OR float
+
+        interpolate:
+            Required Argument.
+            Specifies the interpolation strategies.
+            Permitted Values:
+                * LINEAR
+                * LAG
+                * LEAD
+                * WEIGHTED
+                * SPLINE
+            Types: str
+
+        weight:
+            Optional Argument.
+            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: int OR float
+
+        spline_params_method:
+            Optional Argument.
+            Specifies the type of spline method to use.
+            Note:
+                * Applicable only when "interpolate" set to 'SPLINE'.
+            Permitted Values:
+                * CLAMPED
+                * NATURAL
+                * NOT_A_KNOT
+            Default Value: NOT_A_KNOT
+            Types: str
+
+        spline_params_yp1:
+            Optional Argument.
+            Specifies the value of the first derivative for the left boundary
+            condition.
+            Notes:
+                * Used only when "interpolate" set to 'SPLINE'.
+                * Used only when "spline_params_method" set to 'CLAMPED'.
+            Default Value: 0.0
+            Types: int OR float
+
+        spline_params_ypn:
+            Optional Argument.
+            Specifies the value of the first derivative for the right boundary
+            condition.
+            Notes:
+                * Used only when "interpolate" set to 'SPLINE'.
+                * Used only when "spline_params_method" set to 'CLAMPED'.
+            Default Value: 0.0
+            Types: int OR 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:
+                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 Resample.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as Resample_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.
+        production_data = DataFrame.from_table("production_data")
+
+        # Example 1 : Execute function to transform irregular time series into
+        #             regular time series when row index style is "SEQUENCE".
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=production_data,
+                                  id="product_id",
+                                  row_index_style="SEQUENCE",
+                                  row_index="TD_SEQNO",
+                                  payload_field="beer_sales",
+                                  payload_content="REAL")
+
+        # Execute Resample for TDSeries.
+        uaf_out1 = Resample(data=data_series_df,
+                            interpolate='LINEAR',
+                            sequence_start_value=0.0,
+                            sequence_duration=1.0)
+
+        # Print the result DataFrame.
+        print(uaf_out1.result)
+
+        # Example 2 : Execute function to transform irregular time series into
+        #             regular time series when row index style is "TIMECODE".
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=production_data,
+                                  id="product_id",
+                                  row_index_style="TIMECODE",
+                                  row_index="TD_TIMECODE",
+                                  payload_field="beer_sales",
+                                  payload_content="REAL")
+
+        # Execute Resample for TDSeries.
+        uaf_out2 = Resample(data=data_series_df,
+                            interpolate='LINEAR',
+                            timecode_start_value="TIMESTAMP '2021-01-01 00:00:00'",
+                            timecode_duration="MINUTES(30)")
+
+        # Print the result DataFrame.
+        print(uaf_out2.result)
+    
+    """
+    

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: int, list of int, 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: int, list of int, 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: 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
+            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)
+    
+    """
+    

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

@@ -0,0 +1,123 @@
+def SInfo(data=None, data_filter_expr=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The SInfo() function returns one row for each series instance found in
+        DataFrame. Each returned row provides the following information about
+        the series:
+            * Index data type
+            * Starting index value
+            * Ending index value
+            * Number of series entries
+            * Indicator that the series is regular (discrete) or irregular
+            * Sample interval for regular series or average sample interval for
+              irregular series
+            * Content type
+            * Minimum sample magnitude
+            * Maximum sample magnitude
+            * Average of magnitudes in the series
+            * Root-mean-square for each magnitude
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies a logical series of either the regular or irregular type based on
+            time or space.
+            Types: TDSeries
+
+        data_filter_expr:
+            Optional Argument.
+            Specifies filter expression for "data".
+            Types: ColumnExpression
+
+        **generic_arguments:
+            Specifies the generic keyword arguments of UAF functions.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the
+                    function in a table or not. When set to True,
+                    results are persisted in a table; otherwise,
+                    results are garbage collected at the end of the
+                    session.
+                    Note that, when UAF function is executed, an 
+                    analytic result table (ART) is created.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile ART or not. When set to
+                    True, results are stored in a volatile ART,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+                output_table_name:
+                    Optional Argument.
+                    Specifies the name of the table to store results. 
+                    If not specified, a unique table name is internally 
+                    generated.
+                    Types: str
+
+                output_db_name:
+                    Optional Argument.
+                    Specifies the name of the database to create output 
+                    table into. If not specified, table is created into 
+                    database specified by the user at the time of context 
+                    creation or configuration parameter. Argument is ignored,
+                    if "output_table_name" is not specified.
+                    Types: str
+
+
+    RETURNS:
+        Instance of SInfo.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as SInfo_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", ["ocean_buoys2"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("ocean_buoys2")
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=data,
+                                  id=["ocean_name","buoyid"],
+                                  row_index="TD_TIMECODE",
+                                  row_index_style="TIMECODE",
+                                  payload_field="jsoncol.Measure.salinity",
+                                  payload_content="REAL")
+
+
+        # Example 1 : Display a result set with metadata about the series.
+        #             There is one output row for each series. In addition,
+        #             each input payload produces the output variables for
+        #             MIN, MAX, AVG and RMS. The output varies depending on
+        #             the number of input payloads.
+        uaf_out = SInfo(data=data_series_df)
+
+        # Print the result DataFrame.
+        print(uaf_out.result)
+    
+    """
+