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

teradataml/data/docs/byom/docs/ONNXEmbeddings.py

@@ -0,0 +1,242 @@
+def ONNXEmbeddings(newdata=None, modeldata=None, tokenizerdata=None, accumulate=None, model_output_tensor=None,
+                   encode_max_length=512, show_model_properties=False, output_column_prefix="emb_",
+                   output_format="VARBYTE(3072)", overwrite_cached_models="false", is_debug=False,
+                   enable_memory_check=False, **generic_arguments):
+    """
+    DESCRIPTION:
+        The ONNXEmbeddings() function is used to calculate embeddings values in
+        Vantage with a HuggingFace model that has been created outside Vantage
+        and exported to Vantage using ONNX format.
+
+    PARAMETERS:
+        newdata:
+            Required Argument.
+            Specifies the input teradataml DataFrame that contains
+            the data to be scored.
+            Types: teradataml DataFrame
+
+        modeldata:
+            Required Argument.
+            Specifies the model teradataml DataFrame to be used for
+            scoring.
+            Note:
+                * Use `retrieve_byom()` to get the teradataml DataFrame that contains the model.
+            Types: teradataml DataFrame
+
+        tokenizerdata:
+            Required Argument.
+            Specifies the tokenizer teradataml DataFrame
+            which contains the tokenizer json file.
+            Types: teradataml DataFrame
+
+        accumulate:
+            Required Argument.
+            Specifies the name(s) of input teradataml DataFrame column(s) to
+            copy to the output. By default, the function copies all input
+            teradataml DataFrame columns to the output.
+            Types: str OR list of Strings (str) OR Feature OR list of Features
+
+        model_output_tensor:
+            Required Argument.
+            Specifies the column of the model's possible output fields
+            that the user wants to calculate and output.
+            Types: str
+
+        encode_max_length:
+            Optional Argument.
+            Specifies the maximum length of the tokenizer output token
+            encodings(only applies for models with symbolic dimensions).
+            Default Value: 512
+            Types: int
+
+        show_model_properties:
+            Optional Argument.
+            Specifies the default or expanded "model_input_fields_map" based on
+            input model for defaults or "model_input_fields_map" for expansion.
+            Default Value: False
+            Types: bool
+
+        output_column_prefix:
+            Optional Argument.
+            Specifies the column prefix for each of the output columns
+            when using float32 "output_format".
+            Default Value: "emb_"
+            Types: str
+
+        output_format:
+            Optional Argument.
+            Specifies the output format for the model embeddings output.
+            Default Value: "VARBYTE(3072)"
+            Types: str
+
+        overwrite_cached_models:
+            Optional Argument.
+            Specifies the model name that needs to be removed from the cache.
+            When a model loaded into the memory of the node fits in the cache,
+            it stays in the cache until being evicted to make space for another
+            model that needs to be loaded. Therefore, a model can remain in the
+            cache even after the completion of function execution. Other functions
+            that use the same model can use it, saving the cost of reloading it
+            into memory. User should overwrite a cached model only when it is updated,
+            to make sure that the Predict function uses the updated model instead
+            of the cached model.
+            Note:
+                Do not use the "overwrite_cached_models" argument except when user
+                is trying to replace a previously cached model. Using the argument
+                in other cases, including in concurrent queries or multiple times
+                within a short period of time lead to an OOM error.
+            Default Value: "false"
+            Permitted Values: true, t, yes, y, 1, false, f, no, n, 0, *,
+                              current_cached_model
+            Types: str
+
+        is_debug:
+            Optional Argument.
+            Specifies whether debug statements are added to a trace table or not.
+            When set to True, debug statements are added to a trace table that must
+            be created beforehand.
+            Notes:
+                * Only available with BYOM version 3.00.00.02 and later.
+                * To save logs for debugging, user can create an error log by using
+                  the is_debug=True parameter in the predict functions.
+                  A database trace table is used to collect this information which
+                  does impact performance of the function, so using small data input
+                  sizes is recommended.
+                * To generate this log, user must do the following:
+                      1. Create a global trace table with columns vproc_ID BYTE(2),
+                         Sequence INTEGER, Trace_Output VARCHAR(31000)
+                      2. Turn on session function tracing:
+                           SET SESSION FUNCTION TRACE USING '' FOR TABLE <trace_table_name_created_in_step_1>;
+                      3. Execute function with "is_debug" set to True.
+                      4. Debug information is logged to the table created in step 1.
+                      5. To turn off the logging, either disconnect from the session or
+                         run following SQL:
+                           SET SESSION FUNCTION TRACE OFF;
+                      The trace table is temporary and the information is deleted if user
+                      logs off from the session. If long term persistence is necessary,
+                      user can copy the table to a permanent table before leaving the
+                      session.
+            Default Value: False
+            Types: bool
+
+        enable_memory_check:
+            Optional Argument.
+            Specifies whether there is enough native memory for large models.
+            Default Value: True
+            Types: bool
+
+        **generic_arguments:
+            Specifies the generic keyword arguments SQLE functions accept. 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.
+                    Default Value: False
+                    Types: bool
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the
+                    function in a volatile table or not. When set to
+                    True, results are stored in a volatile table,
+                    otherwise not.
+                    Default Value: False
+                    Types: bool
+
+            Function allows the user to partition, hash, order or local
+            order the input data. These generic arguments are available
+            for each argument that accepts teradataml DataFrame as
+            input and can be accessed as:
+                * "<input_data_arg_name>_partition_column" accepts str or
+                  list of str (Strings) or PartitionKind
+                * "<input_data_arg_name>_hash_column" accepts str or list
+                  of str (Strings)
+                * "<input_data_arg_name>_order_column" accepts str or list
+                  of str (Strings)
+                * "local_order_<input_data_arg_name>" accepts boolean
+            Note:
+                These generic arguments are supported by teradataml if
+                the underlying SQL Engine function supports, else an
+                exception is raised.
+
+    RETURNS:
+        Instance of ONNXEmbeddings.
+        Output teradataml DataFrame can be accessed using attribute
+        references, such as  ONNXEmbeddings.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            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.
+        #     4. To execute BYOM functions, set 'configure.byom_install_location' to the
+        #        database name where BYOM functions are installed.
+
+        # Import required libraries / functions.
+        import os, teradataml
+        from teradataml import get_connection, DataFrame
+        from teradataml import save_byom, retrieve_byom, load_example_data
+        from teradataml import configure, display_analytic_functions, execute_sql
+
+        # Load example data.
+        load_example_data("byom", "amazon_reviews_25")
+
+        # Create teradataml DataFrame objects.
+        amazon_reviews_25 = DataFrame.from_table("amazon_reviews_25")
+
+        # Assigning txt column name to rev_txt column.
+        amazon_reviews_25 = amazon_reviews_25.assign(txt=amazon_reviews_25.rev_text)
+
+        # Set install location of BYOM functions.
+        configure.byom_install_location = "td_mldb"
+
+        # Check the list of available analytic functions.
+        display_analytic_functions(type="BYOM")
+
+        # Retrieve model.
+        modeldata = retrieve_byom("bge-small-en-v1.5", table_name="onnx_models")
+        tokenizerdata = retrieve_byom("bge-small-en-v1.5", table_name="embeddings_tokenizers")
+
+        # Assigning tokenizer_id, tokenizer to model_id, model in embeddings_tokenizers.
+        tokenizerdata_a1 = tokenizerdata.assign(tokenizer_id=tokenizerdata.model_id)
+        tokenizerdata_a2 = tokenizerdata_a1.assign(tokenizer=tokenizerdata_a1.model)
+
+        # Example 1: Calculate embedding values in Vantage with a bge-small-en-v1.5
+        #            model that has been created outside the Vantage by removing all
+        #            the all cached models.
+        ONNXEmbeddings_out_1 = ONNXEmbeddings(modeldata=modeldata,
+                                              tokenizerdata=tokenizerdata_a2.select(['tokenizer_id', 'tokenizer']),
+                                              newdata=amazon_reviews_25.select(["rev_id", "txt"]),
+                                              accumulate='rev_id',
+                                              model_output_tensor='sentence_embedding'
+                                              )
+
+        # Print the results.
+        print(ONNXEmbeddings_out_1.result)
+
+        # Example 2: Showcasing the model properties of bge-small-en-v1.5 model that has been
+        #            created outside the Vantage by showcasing.
+        ONNXEmbeddings_out_2 = ONNXEmbeddings(modeldata=modeldata,
+                                              tokenizerdata=tokenizerdata_a2.select(['tokenizer_id', 'tokenizer']),
+                                              newdata=amazon_reviews_25.select(["rev_id", "txt"]),
+                                              accumulate='rev_id',
+                                              model_output_tensor='sentence_embedding',
+                                              show_model_properties=True
+                                              )
+
+        # Print the results.
+        print(ONNXEmbeddings_out_2.result)
+    """

teradataml/data/docs/byom/docs/ONNXPredict.py

@@ -40,7 +40,7 @@ def ONNXPredict(newdata=None, modeldata=None, accumulate=None, model_output_fiel
             Required Argument.
             Specifies the name(s) of input teradataml DataFrame column(s) to
             copy to the output.
-            Types: str OR list of Strings (str)
+            Types: str OR list of Strings (str) OR Feature OR list of Features
 
         model_output_fields:
             Optional Argument.
@@ -146,7 +146,7 @@ def ONNXPredict(newdata=None, modeldata=None, accumulate=None, model_output_fiel
             for each argument that accepts teradataml DataFrame as
             input and can be accessed as:
                 * "<input_data_arg_name>_partition_column" accepts str or
-                  list of str (Strings)
+                  list of str (Strings) or PartitionKind
                 * "<input_data_arg_name>_hash_column" accepts str or list
                   of str (Strings)
                 * "<input_data_arg_name>_order_column" accepts str or list

teradataml/data/docs/byom/docs/PMMLPredict.py

@@ -52,7 +52,7 @@ def PMMLPredict(newdata=None, modeldata=None, accumulate=None,
             Required Argument.
             Specifies the name(s) of input teradataml DataFrame column(s)
             to copy to the output DataFrame.
-            Types: str OR list of Strings (str)
+            Types: str OR list of Strings (str) OR Feature OR list of Features
 
         model_output_fields:
             Optional Argument.
@@ -143,7 +143,7 @@ def PMMLPredict(newdata=None, modeldata=None, accumulate=None,
             for each argument that accepts teradataml DataFrame as
             input and can be accessed as:
                 * "<input_data_arg_name>_partition_column" accepts str or
-                  list of str (Strings)
+                  list of str (Strings) or PartitionKind
                 * "<input_data_arg_name>_hash_column" accepts str or list
                   of str (Strings)
                 * "<input_data_arg_name>_order_column" accepts str or list

teradataml/data/docs/sqle/docs_17_20/NaiveBayes.py

@@ -131,7 +131,7 @@ def  NaiveBayes(data = None, response_column = None, numeric_inputs = None,
         display_analytic_functions()
         
         # Import function  NaiveBayes.
-        from teradataml import  NaiveBayes
+        from teradataml import  NaiveBayes, Unpivoting
         
         # Example 1: NaiveBayes function to generate classification model using Dense input.
         NaiveBayes_out = NaiveBayes(data=housing_train, response_column='homestyle', 

teradataml/data/docs/sqle/docs_17_20/Shap.py

@@ -1,4 +1,4 @@
-def Shap(data = None, object = None, training_function = "TD_GLM",
+def Shap(data = None, object = None, id_column=None, training_function = None,
          model_type = "Regression", input_columns = None, detailed = False,
          accumulate = None, num_parallel_trees = 1000, num_boost_rounds = 10,
          **generic_arguments):
@@ -19,11 +19,16 @@ def Shap(data = None, object = None, training_function = "TD_GLM",
             Required Argument.
             Specifies the teradataml DataFrame containing the model data.
             Types: teradataml DataFrame
+
+        id_column:
+            Required Argument.
+            Specifies the input data column name that has the unique identifier
+            for each row in the "data".
+            Types: str
         
         training_function:
             Required Argument.
             Specifies the model type name.
-            Default Value: "TD_GLM"
             Permitted Values: TD_GLM, TD_DECISIONFOREST, TD_XGBOOST
             Types: str
         
@@ -44,6 +49,9 @@ def Shap(data = None, object = None, training_function = "TD_GLM",
             Optional Argument.
             Specifies whether to output detailed shap information about the 
             forest trees.
+            Note: 
+                * It is only supported for "TD_XGBOOST" and "TD_DECISIONFOREST" 
+                  training functions.
             Default Value: False
             Types: bool
         
@@ -145,10 +153,10 @@ def Shap(data = None, object = None, training_function = "TD_GLM",
         
         # Example 1: Shap for classification model.
         XGBoost_out = XGBoost(data=iris_input,
-                      input_columns=['sepal_length', 'sepal_width', 'petal_length', 'petal_width'],
-                      response_column = 'species',
-                      model_type='Classification',
-                      iter_num=25)
+                              input_columns=['sepal_length', 'sepal_width', 'petal_length', 'petal_width'],
+                              response_column = 'species',
+                              model_type='Classification',
+                              iter_num=25)
         
         Shap_out = Shap(data=iris_input, 
                         object=XGBoost_out.result, 
@@ -194,4 +202,24 @@ def Shap(data = None, object = None, training_function = "TD_GLM",
 
         # Print the result DataFrame.
         print(Shap_out2.output_data)
+
+        # Example 3: Shap for GLM model.
+        from teradataml import GLM
+        GLM_out = GLM(data=transform_obj.result,
+                      input_columns=['MedInc', 'HouseAge', 'AveRooms',
+                                     'AveBedrms', 'Population', 'AveOccup',
+                                     'Latitude', 'Longitude'],
+                      response_column="MedHouseVal",
+                      family="GAUSSIAN")
+        
+        Shap_out3 = Shap(data=transform_obj.result, 
+                         object=GLM_out.result,
+                         id_column='id',
+                         training_function="TD_GLM",
+                         model_type="Regression",
+                         input_columns=['MedInc', 'HouseAge', 'AveRooms','AveBedrms', 'Population', 'AveOccup','Latitude', 'Longitude'],
+                         detailed=False)
+
+        # Print the result DataFrame.
+        print(Shap_out3.output_data)
     """

teradataml/data/docs/sqle/docs_17_20/TDNaiveBayesPredict.py

@@ -133,10 +133,10 @@ def  TDNaiveBayesPredict(data = None, object = None, id_column = None,
         # Check the list of available analytic functions.
         display_analytic_functions()
         
-        # Import function  NaiveBayesPredict.
-        from teradataml import  NaiveBayesPredict
+        # Import function  TDNaiveBayesPredict.
+        from teradataml import  TDNaiveBayesPredict, NaiveBayes, Unpivoting
         
-        # Example 1: NaiveBayesPredict function to predict the classification label using Dense input.
+        # Example 1: TDNaiveBayesPredict function to predict the classification label using Dense input.
         NaiveBayes_out = NaiveBayes(data=housing_train, response_column='homestyle', 
                                     numeric_inputs=['price','lotsize','bedrooms','bathrms','stories','garagepl'], 
                                     categorical_inputs=['driveway','recroom','fullbase','gashw','airco','prefarea'])
@@ -152,7 +152,7 @@ def  TDNaiveBayesPredict(data = None, object = None, id_column = None,
         # Print the result DataFrame.
         print( NaiveBayesPredict_out.result)
 
-        # Example 2: NaiveBayesPredict function to predict the classification label using Sparse input.
+        # Example 2: TDNaiveBayesPredict function to predict the classification label using Sparse input.
         
         # Unpivoting the data for sparse input to naive bayes.
         upvt_train = Unpivoting(data = housing_train, id_column = 'sn', 

teradataml/data/docs/sqle/docs_17_20/TextParser.py

@@ -1,4 +1,4 @@
-def TextParser(data=None, object=None, text_column=None, covert_to_lowercase=True, stem_tokens=False,
+def TextParser(data=None, object=None, text_column=None, convert_to_lowercase=True, stem_tokens=False,
                remove_stopwords=False, accumulate=None, delimiter=" \t\n\f\r",
                punctuation="!#$%&()*+,-./:;?@\^_`{|}~", token_col_name=None, **generic_arguments):
     """
@@ -38,7 +38,7 @@ def TextParser(data=None, object=None, text_column=None, covert_to_lowercase=Tru
             Specifies the name of the input data column whose contents are to be tokenized.
             Types: str
 
-        covert_to_lowercase:
+        convert_to_lowercase:
             Optional Argument.
             Specifies whether to convert the text in "text_column" to lowercase.
             Default Value: True
@@ -165,7 +165,7 @@ def TextParser(data=None, object=None, text_column=None, covert_to_lowercase=Tru
         # Example 2 : Convert words in "text_data" column into their root forms.
         TextParser_out = TextParser(data=complaints,
                                     text_column="text_data",
-                                    covert_to_lowercase=True,
+                                    convert_to_lowercase=True,
                                     stem_tokens=True)
 
         # Print the result DataFrame.

teradataml/data/docs/tableoperator/docs_17_20/Image2Matrix.py

@@ -0,0 +1,118 @@
+def Image2Matrix(data=None,
+                 output='gray',
+                 **generic_arguments):
+    """
+    DESCRIPTION:
+        Image2Matrix() function converts an image to a matrix.
+        It converts JPEG or PNG images to matrixes with payload values being the pixel values.
+        Note:
+            * The image size cannot be greater than 16 MB.
+            * The image should not exceed 4,000,000 pixels.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the teradataml DataFrame which has image details.
+            Types: Teradataml DataFrame
+
+        output:
+            Optional Argument.
+            Specifies the type of output matrix.
+            Default: 'gray'
+            Permitted Values:
+                'gray': Converts the image to a grayscale matrix.
+                'rgb': Converts the image to a RGB matrix.
+            Types: str
+
+        **generic_arguments:
+            Specifies the generic keyword arguments SQLE functions accept.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the function in table or not.
+                    When set to True, results are persisted in table; otherwise, results
+                    are garbage collected at the end of the session.
+                    Default Value: False
+                    Types: boolean
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the function in volatile table or not.
+                    When set to True, results are stored in volatile table, otherwise not.
+                    Default Value: False
+                    Types: boolean
+
+            Function allows the user to partition, hash, order or local order the input
+            data. These generic arguments are available for each argument that accepts
+            teradataml DataFrame as input and can be accessed as:
+                * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
+                * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
+                * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
+                * "local_order_<input_data_arg_name>" accepts boolean
+            Note:
+                These generic arguments are supported by teradataml if the underlying Analytic Database
+                function supports, else an exception is raised.
+
+    RETURNS:
+        Instance of Image2Matrix.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as Image2Matrix.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            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 analytic functions.
+        display_analytic_functions()
+
+        # Import function Image2Matrix.
+        from teradataml import Image2Matrix
+        import teradataml
+
+        # Drop the image table if it is present.
+        try:
+            db_drop_table('imageTable')
+        except:
+            pass
+
+        # Create a table to store the image data.
+        execute_sql('CREATE TABLE imageTable(id INTEGER, image BLOB);')
+
+        # Load the image data into the fileContent variable.
+        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()
+
+        # Insert the image data into the table.
+        sql = 'INSERT INTO imageTable VALUES(?, ?);'
+        parameters = (1, fileContent)
+        execute_sql(sql, parameters)
+
+        # Create a DataFrame for the image table.
+        imageTable = DataFrame('imageTable')
+
+        # Example 1: Convert the image to matrix with gray values.
+        image2matrix = Image2Matrix(data=imageTable.select(['id', 'image']), 
+                                    output='gray')
+
+        # Print the result DataFrame.
+        print(image2matrix.result)
+
+        # Example 2: Convert the image to matrix with rgb values.
+        image2matrix2 = Image2Matrix(data=imageTable.select(['id', 'image']), 
+                                     output='rgb')
+
+        # Print the result DataFrame.
+        print(image2matrix2.result)
+    """

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

@@ -0,0 +1,145 @@
+def CopyArt(data=None, database_name = None,
+            table_name = None, map_name = None,
+            **generic_arguments):
+    """
+    DESCRIPTION:
+        CopyArt() function creates a copy of an existing analytics result table (ART).
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the ART data to be copied.
+            Types: DataFrame
+
+        database_name:
+            Required Argument.
+            Specifies the name of the destination database for copied ART.
+            Types: str
+
+        table_name:
+            Required Argument.
+            Specifies the name of the destination table for copied ART.
+            Types: str
+
+        map_name:
+            Optional Argument.
+            Specifies the name of the map for the destination ART.
+            By default, it refers to the map of the 'data'.
+            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 CopyArt.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as 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 CopyArt.
+        from teradataml import CopyArt, AutoArima
+
+        # Load the example data.
+        load_example_data("uaf", ["blood2ageandweight"])
+
+        # Create teradataml DataFrame object.
+        data = DataFrame.from_table("blood2ageandweight")
+
+        # Create teradataml TDSeries object.
+        data_series_df = TDSeries(data=data,
+                                  id="PatientID",
+                                  row_index="SeqNo",
+                                  row_index_style="SEQUENCE",
+                                  payload_field="BloodFat",
+                                  payload_content="REAL")
+
+        # Execute AutoArima function to create ART.
+        uaf_out = AutoArima(data=data_series_df,
+                            start_pq_nonseasonal=[1, 1],
+                            seasonal=False,
+                            constant=True,
+                            algorithm="MLE",
+                            fit_percentage=80,
+                            stepwise=True,
+                            nmodels=7,
+                            fit_metrics=True,
+                            residuals=True)
+
+        # Example 1: Execute CopyArt function to copy ART to a destination table name
+        #            with persist option.
+        res = CopyArt(data=uaf_out.result,
+                      database_name="alice",
+                      table_name="copied_table",
+                      persist=True)
+        print(res.result)
+
+        # Example 2: Execute CopyArt function to copy ART to a destination table name.
+        res = CopyArt(data=uaf_out.result,
+                      database_name="alice",
+                      table_name="copied_table2")
+
+        # Print the result DataFrame.
+        print(res.result)
+
+        # Example 3: Copy ART to a destination table name using uaf object.
+        res = uaf_out.copy(database_name="alice",
+                           table_name="copied_table3")
+
+        # Print the result DataFrame.
+        print(res.result)
+
+    """