Update KerasNLP API symbols for 0.3.0 release (keras-team#950)

* Update KerasNLP API symbols for 0.3.0 release * Copy edits
JZakraoui · Jun 30, 2022 · b376c40 · b376c40
1 parent 56f4c8e
commit b376c40
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 13 deletions.
diff --git a/scripts/autogen.py b/scripts/autogen.py
@@ -42,7 +42,7 @@
     "keras": "https://github.com/keras-team/keras/tree/v2.9.0/",
     "keras_tuner": "https://github.com/keras-team/keras-tuner/tree/1.1.2/",
     "keras_cv": "https://github.com/keras-team/keras-cv/tree/v0.2.7/",
-    "keras_nlp": "https://github.com/keras-team/keras-nlp/tree/v0.2.0/",
+    "keras_nlp": "https://github.com/keras-team/keras-nlp/tree/v0.3.0/",
 }
 
 

diff --git a/scripts/nlp_api_master.py b/scripts/nlp_api_master.py
@@ -29,6 +29,19 @@
                 "keras_nlp.tokenizers.WordPieceTokenizer.id_to_token",
             ],
         },
+        {
+            "path": "sentence_piece_tokenizer",
+            "title": "SentencePieceTokenizer",
+            "generate": [
+                "keras_nlp.tokenizers.SentencePieceTokenizer",
+                "keras_nlp.tokenizers.SentencePieceTokenizer.tokenize",
+                "keras_nlp.tokenizers.SentencePieceTokenizer.detokenize",
+                "keras_nlp.tokenizers.SentencePieceTokenizer.get_vocabulary",
+                "keras_nlp.tokenizers.SentencePieceTokenizer.vocabulary_size",
+                "keras_nlp.tokenizers.SentencePieceTokenizer.token_to_id",
+                "keras_nlp.tokenizers.SentencePieceTokenizer.id_to_token",
+            ],
+        },
         {
             "path": "byte_tokenizer",
             "title": "ByteTokenizer",
@@ -109,6 +122,16 @@
             "title": "MLMHead layer",
             "generate": ["keras_nlp.layers.MLMHead"],
         },
+        {
+            "path": "start_end_packer",
+            "title": "StartEndPacker layer",
+            "generate": ["keras_nlp.layers.StartEndPacker"],
+        },
+        {
+            "path": "multi_segment_packer",
+            "title": "MultiSegmentPacker layer",
+            "generate": ["keras_nlp.layers.MultiSegmentPacker"],
+        },
     ],
 }
 
@@ -123,12 +146,60 @@
             "title": "Perplexity metric",
             "generate": ["keras_nlp.metrics.Perplexity"],
         },
+        {
+            "path": "rouge_l",
+            "title": "RougeL metric",
+            "generate": ["keras_nlp.metrics.RougeL"],
+        },
+        {
+            "path": "rouge_n",
+            "title": "RougeN metric",
+            "generate": ["keras_nlp.metrics.RougeN"],
+        },
+    ],
+}
+
+UTILS_MASTER = {
+    "path": "utils/",
+    "title": "Utils",
+    "toc": True,
+    "children": [
+        {
+            "path": "greedy_search",
+            "title": "greedy_search function",
+            "generate": ["keras_nlp.utils.greedy_search"],
+        },
+        {
+            "path": "top_k_search",
+            "title": "top_k_search function",
+            "generate": ["keras_nlp.utils.top_k_search"],
+        },
+        {
+            "path": "top_p_search",
+            "title": "top_p_search function",
+            "generate": ["keras_nlp.utils.top_p_search"],
+        },
+        {
+            "path": "random_search",
+            "title": "random_search function",
+            "generate": ["keras_nlp.utils.random_search"],
+        },
+        {
+            "path": "beam_search",
+            "title": "beam_search function",
+            "generate": ["keras_nlp.utils.beam_search"],
+        },
     ],
 }
 
 NLP_API_MASTER = {
     "path": "keras_nlp/",
     "title": "KerasNLP",
     "toc": True,
-    "children": [TOKENIZERS_MASTER, LAYERS_MASTER, METRICS_MASTER],
+    "children": [
+        TOKENIZERS_MASTER,
+        LAYERS_MASTER,
+        METRICS_MASTER,
+        UTILS_MASTER,
+    ],
 }
diff --git a/templates/api/keras_nlp/layers/preprocessing/index.md b/templates/api/keras_nlp/layers/preprocessing/index.md
diff --git a/templates/api/keras_nlp/utils/index.md b/templates/api/keras_nlp/utils/index.md
@@ -0,0 +1,6 @@
+# KerasNLP Utils
+
+Standalone utilitiy methods for KerasNLP, including functions for generating
+sequences of text with a model.
+
+{{toc}}