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

teradataml/data/amazon_reviews_25.csv

@@ -0,0 +1,26 @@
+"rev_id","aid","rev_name","helpful","rev_text","rating","prodsummary","unixrevtime","revtime"
+A10000012B7CGYKOMPQ4L,"000100039X",Adam,"[0, 0]",Spiritually and mentally inspiring! A book that allows you to question your morals and will help you discover who you really are!,5.00,Wonderful!,1355616000,"12 16, 2012"
+A2KU9IU07LOJS1,"000100039X",Amazon Customer,"[0, 0]",This book has been a classic for many years. It has so much wisdom in it that it can be read numerous times and new things will come out each time. My favorite chapter is the one on children.,5.00,Great classic that everyone should read,1384905600,"11 20, 2013"
+A19N3FCQCLJYUA,"000100039X",Amazon Customer,"[1, 1]","I discovered The Prophet fifty years ago in college and have read it dozens of times since then.  Now, in addition to my beat up hard copy, I have a portable e-copy.  If you were looking for an example of an intelligently designed (pun intended) book of spiritual guidance, this would be it.  It doesn""t care how you picture, name or define "God" or whether you give him a gender and a personality.  It just cuts to the heart of how to live and how to relate to others.  If Jesus and the Buddha teamed up to write a book, it might come out like this.When I first read it, I found some passages difficult to grasp.  Looking back, I now think that it was not because they were hard to understand, but because I did not want to hear gently spoken, intelligently phrased ideas that contradicted my own.  Now, if I could have only one book, this would probably be it.",5.00,A book everyone "should" read,1358899200,"01 23, 2013"
+A5E9TSD20U9PR,"000100039X",April,"[0, 0]","For those who don""t know Gibran, get to know his work. The Prophet is a must read. His outlook on life is truly an inspiring guide on how to approach major life decisions. This is a relationship with a man""s work you won""t regret having.",5.00,Just beautiful.,1377475200,"08 26, 2013"
+A1BM81XB4QHOA3,"000100039X","""Ahoro Blethends """"Seriously""""""","[0, 0]","This book provides a reflection that you can apply to your own life.And, a way for you to try and assess whether you are truly doing the right thing and making the most of your short time on this plane.",5.00,Must Read for Life Afficianados,1390003200,"01 18, 2014"
+A26GKZPS079GFF,"000100039X",Areej,"[2, 3]","I would have to say that this is the best book I""ve ever read.. I could feel every word deep in my heart everytime, of the many times I""ve read it!  I would never get enough of it! its a treasure..",5.00,Touches my heart.. again and.. again...,982972800,"02 24, 2001"
+A1MOSTXNIO5MPJ,"000100039X",Alan Krug,"[0, 0]","I first read THE PROPHET in college back in the 60""s. The book had a revival as did anything metaphysical in the turbulent 60""s. It had a profound effect on me and became a book I always took with me. After graduation I joined the Peace Corps and during stressful training in country (Liberia) at times of illness and the night before I left, this book gave me great comfort. I read it before I married, just before and again after my children were born and again after two near fatal illnesses. I am always amazed that there is a chapter that reaches out to you, grabs you and offers both comfort and hope for the future.Gibran offers timeless insights and love with each word. I think that we as a nation should read AND learn the lessons here. It is definitely a time for thought and reflection this book could guide us through.",5.00,Timeless for every good and bad time in your life.,1317081600,"09 27, 2011"
+A1TT4CY55WLHAR,"000100039X",anonymous,"[0, 0]","I have the 1972 version, bought in 1974. The 1972 version originally had a dust jacket but my dust jacket is long gone. This particular rendition has had many re-printings, for a reason: it""s very popular. The textured paper, old-style typography, and leather cover are better than a plain-old paperback. The size is diminutive, which is perfect for this book.",5.00,"textured paper, old-style typography, and leather cover",1342396800,"07 16, 2012"
+A3FFNE1DR5SI1W,"000100039X",A. Morelli,"[1, 1]","Can""t say enough about Kahlil Gibran""s work among this piece. Everybody in the whole world should read this! There is almost too much to take in, really appreciate and put towards our daily lives. In my opinion, it is just one of the most beautiful literature pieces ever written. Would recommend to as a gift for anyone spiritual/poetic/philosophy/educational piece or just something to enjoy here and there. 5 stars for sure!",5.00,phenomenal piece of literature!,1340755200,"06 27, 2012"
+A1340OFLZBW5NG,"000100039X",Amazon Customer,"[0, 0]",I LOVE this book... his writing seems to just flow from page to page. I get something different from this book each time I read it..,5.00,Perhaps the greatest book that I have ever read,1231977600,"01 15, 2009"
+A29TRDMK51GKZR,"000100039X",Alpine Plume,"[0, 0]","Deep, moving dramatic verses of the heart and soul.Truths of  ancient wisdom from a true and romantic poet.Relevant for all eternity.",5.00,Such Beauty,1383436800,"11 3, 2013"
+A3FI0744PG1WYG,"000100039X","""Always Reading """"tkm""""""","[0, 0]","This is a timeless classic.  Over the years I""ve given it as a gift more times than I can count, and will continue to do so.  Addresses real life issues in a beautiful way and makes us reexamine our own attitude about how we see what happens in our lives.  So easy to read over and over.",5.00,The Prophet,1390953600,"01 29, 2014"
+A2XQ5LZHTD4AFT,"000100039X",Alaturka,"[7, 9]","A timeless classic.  It is a very demanding and assuming title, but Gibran backs it up with some excellent style and content.  If he had the means to publish it a century or two earlier, he could have inspired a new religion.From the mouth of an old man about to sail away to a far away destination, we hear the wisdom of life and all important aspects of it.  It is a messege.  A guide book.  A Sufi sermon. Much is put in perspective without any hint of a dogma.  There is much that hints at his birth place, Lebanon where many of the old prophets walked the Earth and where this book project first germinated most likely.Probably becuase it was written in English originally, the writing flows, it is pleasant to read, and the charcoal drawings of the author decorating the pages is a plus.  I loved the cover.",5.00,A Modern Rumi,1033948800,"10 7, 2002"
+A2LBBQHYLEHM7P,"000100039X","""Amazon Customer """"Full Frontal Nerdity""""""","[0, 0]","An amazing work. Realizing extensive use of Biblical imagery and sentence structure, "The Prophet" by Khalil Gibran is a literary classic. Influencing the Free Love movement of the 1960""s, Gibran""s master work explores themes of love, longing and loss.",5.00,A Modern Classic,1379808000,"09 22, 2013"
+AENNW2G826191,"000100039X",Ashish A,"[1, 4]","Its a thin book, very readable and has interesting 1-2 page thoughts on various entities like anger, children, religion, speech, silence and its COOL.........reading. Ofcourse if one needs to imbibe the thoughts of the  author, it has to be consumed slowly and perhaps revisited but leaves you  pretty heady and clear about certain things.",3.00,Good Read,963446400,"07 13, 2000"
+A2X4HE21JTAL98,"000100039X",Antiquarian,"[3, 5]","Anything I""ve read by Gibran is, in my mind, flawless. This, the most famous of his works, is no exception. It is simple, yet deep; honest and profound; moving and inspirational. Gibran""s work is one of a kind, and can be far more encouraging and moving than any self-help program or therapy or anything like that. The poetic style, the aphorisms, the parables, the almost biblical feel, are all just what over-worked, over-stressed, modern and spiritually starved worldly people need.",5.00,Flawless,1132099200,"11 16, 2005"
+A3V1MKC2BVWY48,"000100039X",Alex Dawson,"[0, 0]","Reading this made my mind feel like a still pool of water, cool and quiet in a mossy grotto.  It""s direct and simple wisdom has a depth of complexity that takes a quiet day to sink in, leaving you at peace.  It is best to set time aside for it, relax, absorb, and let it softly clear your mind.",5.00,This book will bring you peace,1390780800,"01 27, 2014"
+A1KQ80Y692CDOI,"000100039X",Atown,"[2, 9]","I read this about a year ago and can""t recall a great deal of the book. From what I do recall it was like a poem all the way through. While the writing was beautiful, I found it ambiguous and befuddled with meaning that I could not identify with. When Gibran speaks of God, I cannot identify because I have since abandoned those philosophies. It is thus difficult to revisit them in this book. I have the feeling a may have missed something great about this book. Indeed, I pulled wisdom from parts, but rather than go back and read it again, for now, perhaps I will move on to another of the many books out there that are enlightening and worth reading. Someday, I would like to read this again and dig deeper.",2.00,Eloquent,1206057600,"03 21, 2008"
+AUTNO7VDY4H4A,"000100039X",Austin guy,"[0, 0]","Loved this book since first I read it, years gone by.  Purchased this copy for a friend who has not ever read Gibran.",5.00,"A great book, buying it for a friend.",1371427200,"06 17, 2013"
+A2WVHIRDMLM82E,"000100039X",Amazon Customer,"[0, 0]","This book has so much you can take out of it to use in your real life. Amazing, and one of my favorite reads of all time.",5.00,Amazing,1394928000,"03 16, 2014"
+A2I35JB67U20C0,"000100039X",Amazon Customer,"[0, 0]","When I was in college in the 70""s this book had a revival and I did not read it then.  Recently a friend (who is 90) and I were talking about work and she said: "work is love made visible," and told me it was from the Prophet.  I though that was so beautiful I got the book and was not disappointed.You see, if you have ideas and you do not realize them, then they are nothing, and if your ideas do not come from love and joy, then they are bitter and what they produce will be bitter, but if they flow from love and joy, then their realization will be love and joy, thus work is love made visible.He says it WAY better that I do and says much more in just a few paragraphs.  But as you can see from the example, what he says is not religious, but positive ways of looking at things.  Since I rediscoverd the book I have given away many copies and everyone I have given it to sincerly thanked me.",5.00,Everyone should have this book,983318400,"02 28, 2001"
+A12387207U8U24,"000100039X",Alex,"[0, 0]","As you read, Gibran""s poetry brings spiritual and visual beauty to life within you. Gibran is justly famous for rich metaphors that brilliantly highlight the pursuit of Truth and Goodness amidst all the darkness and light of human nature.",5.00,Graet Work,1206662400,"03 28, 2008"
+A2S166WSCFIFP5,"000100039X","""adead_poet@hotmail.com """"adead_poet@hotmail.com""""""","[0, 2]","This is one my must have books. It is a masterpiece of spirituality. I""ll be the first to admit, its literary quality isn""t much. It is rather simplistically written, but the message behind it is so powerful that you have to read it. It will take you to enlightenment.",5.00,close to god,1071100800,"12 11, 2003"
+A27ZH1AQORJ1L,"000100039X","""anybody else or """"amanuet""""""","[3, 3]","This book is everything that is simple, delicate, true, and beautiful.I have read few books so touching and enlightening; "The Prophet" is a true masterpiece that has that feeling of ancient wisdom in it. The wisdom of the text is gentle, yet insistent, it lets you understand things you""ve always known.My feelings defy description.",5.00,Enchanting,1066003200,"10 13, 2003"
+ARDQ9KNB8K22N,"000100039X",Anwar,"[1, 1]","Cool book, I really like the quality of the production.  Black clothbound with gold embossing and nice paper, looks to be cotton rag.  I am proud to include it in my collection.  Intrigueing story full of the sort of passion that does not cloud the mind or divert truth but instead is revealing and living. Very readable, the stories are short and highly economic so that one is likely to read for only a minute or two until something insightful is revealed. It is full of timeless truths which are of lasting value to the reader and inform life.  The language and delivery is familiar yet of a quality that is penetrating in a similar way as it might be listening to a surmon by Jesus.  I give it 5 stars. I considered giving only 4 stars because the format is fairly predictable but I have decided that this quality is actually a strength as one can pick up the book at any point and continue until the end...and then start over for that matter.  Excellent for busy people or commuters!",5.00,"""""""The Prophet"""" is cool""",1329264000,"02 15, 2012"

teradataml/data/apriori_example.json

@@ -0,0 +1,22 @@
+{
+    "trans_dense": {
+      "location": "varchar(100)",
+      "tranid": "int",
+      "period": "varchar(20)",
+      "storeid": "int",
+      "region": "varchar(20)",
+      "item": "varchar(200)",
+      "sku": "int",
+      "category": "varchar(20)"
+    },
+    "trans_sparse": {
+      "location": "varchar(20)",
+      "tranid": "int",
+      "period": "varchar(20)",
+      "storeid": "int",
+      "region": "varchar(20)",
+      "item": "varchar(20)",
+      "sku": "int",
+      "category": "varchar(20)"
+    }
+}

teradataml/data/byom_example.json

@@ -14,5 +14,16 @@
     "petal_length" : "float",
     "petal_width" : "float",
     "species": "integer"
+  },
+  "amazon_reviews_25": {
+    "rev_id": "VARCHAR(64000)",
+    "aid": "VARCHAR(64000)",
+    "rev_name": "VARCHAR(64000)",
+    "helpful": "VARCHAR(64000)",
+    "rev_text": "VARCHAR(64000)",
+    "rating": "DECIMAL(10,2)",
+    "prodsummary": "VARCHAR(64000)",
+    "unixrevtime": "BIGINT",
+    "revtime": "VARCHAR(64000)"
   }
 }

teradataml/data/docs/byom/docs/DataRobotPredict.py

@@ -23,7 +23,7 @@ def DataRobotPredict(modeldata=None, newdata=None, accumulate=None, model_output
             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.
@@ -108,7 +108,7 @@ def DataRobotPredict(modeldata=None, newdata=None, accumulate=None, model_output
             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/DataikuPredict.py

@@ -24,7 +24,7 @@ def DataikuPredict(modeldata=None, newdata=None, accumulate=None, model_output_f
             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)
+            Types: str OR list of Strings (str) OR Feature OR list of Features
 
         model_output_fields:
             Optional Argument.
@@ -86,6 +86,45 @@ def DataikuPredict(modeldata=None, newdata=None, accumulate=None, model_output_f
             Default Value: False
             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 DataikuPredict.
         Output teradataml DataFrame can be accessed using attribute

teradataml/data/docs/byom/docs/H2OPredict.py

@@ -38,7 +38,7 @@ def H2OPredict(modeldata=None, newdata=None, accumulate=None, model_output_field
             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.
@@ -147,7 +147,7 @@ def H2OPredict(modeldata=None, newdata=None, accumulate=None, model_output_field
             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/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/Apriori.py

@@ -0,0 +1,138 @@
+def Apriori(data=None, target_column=None, id_column=None, partition_columns=None,
+            max_len=2, delimiter=",", is_dense_input=False, patterns_or_rules=None,
+            support=0.01, **generic_arguments):
+    """
+    DESCRIPTION:
+        The Apriori() function finds patterns and calculates different statistical metrics to
+        understand the influence of the occurrence of a set of items on others.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        target_column:
+            Required Argument.
+            Specifies the input teradataml DataFrame column which contains the data to filter.
+            Types: str
+
+        id_column:
+            Optional Argument.
+            Specifies the name of the column that uniquely groups the items that are purchased together. 
+            Applicable only when `is_dense_input` is False.
+            Types: str
+
+        partition_columns:
+            Optional Argument.
+            Specifies the column name(s) in the "data" to partition the input.
+            Types: str or list of str
+
+        max_len:
+            Optional Argument.
+            Specifies the maximum number of items in the item set. 
+            "max_len" must be greater than or equal to 1 and less than or equal to 20.
+            Default Value: 2
+            Types: int
+
+        delimiter:
+            Optional Argument, Required when "is_dense_input" is set to True.
+            Specifies a character or string that separates words in the input text.
+            Default Value: ","
+            Types: str
+
+
+        is_dense_input:
+            Optional Argument.
+            Specifies whether input data is in dense format or not. 
+            When set to True, function considers the  data is in dense format. 
+            Otherwise function considers  data is not in dense format.
+            Default Value: False
+            Types: bool
+
+        patterns_or_rules:
+            Optional Argument.
+            Specifies whether to emit PATTERNS or RULES as output.
+            Permitted Values: "PATTERNS", "RULES"
+            Types: str
+
+        support:
+            Optional Argument.
+            Specifies the support value (minimum occurrence threshold) of the itemset.
+            Default Value: 0.01
+            Types: float
+
+        **generic_arguments:
+            Optional Argument.
+            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)
+                * "<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 SQLE Engine
+                function supports, else an exception is raised.
+
+    RETURNS:
+        Instance of Apriori.
+        Output teradataml DataFrames can be accessed using attribute references, such as AprioriObj.<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 an error if not supported on the Vantage user is connected to.
+
+        # Load the example data.
+        load_example_data("apriori", ["trans_dense","trans_sparse"])
+
+        # Create teradataml DataFrame objects.
+        dense_table = DataFrame.from_table("trans_dense")
+        sparse_table = DataFrame.from_table("trans_sparse")
+
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+        
+        # Import function Apriori.
+        from teradataml import Apriori
+
+        # Example 1: Find patterns in the input data with DENSE DATA, PARTITION,RULES .
+        Apriori_out = Apriori(data=dense_table, target_column="item",
+                              partition_columns=["location"], max_len=2,
+                              patterns_or_rules="rules", support=0.01)
+
+        # Print the result DataFrame.
+        print(Apriori_out.result)
+
+        # Example 2: Find patterns in the input data with SPARSE DATA, NO PARTITIONS, PATTERNS.
+        Apriori_out = Apriori(data=sparse_table, target_column="item",
+                              id_column="tranid", max_len=3)
+                                    
+        # Print the result DataFrame.
+        print(Apriori_out.result)
+    """