Model Card for Preset Table for Keras-NLP (#1263)

* Updated Dependencies and DockerFile * Keras-NLP Autogenerate presets table * Made backbone table autogenerated. * Updated Requirements.txt * Updated requirements.txt * Updated render_nlp_tags and autogen.py * Improved Comments in render_nlp_tags.py * Updated render_nlp_tags.py * Formatted code and made minor changes * Update keras-nlp version and add a few simplifications * Added Model Cards for Keras-NLP. * Changed Disclaimer to Note --------- Co-authored-by: Matt Watson <[email protected]>
keras-team · Aug 1, 2023 · bedf607 · bedf607
1 parent 6f1fb07
commit bedf607
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/scripts/render_tags.py b/scripts/render_tags.py
@@ -81,8 +81,11 @@ def render_backbone_table(symbols):
                 f"{preset} | "
                 f"{format_path(metadata)} | "
                 f"{format_param_count(metadata)} | "
-                f"{metadata['description']} \n"
+                f"{metadata['description']}"
             )
+            if "model_card" in metadata:
+                table += f" [Model Card]({metadata['model_card']})"
+            table += "\n"
     return table
 
 

diff --git a/templates/api/keras_nlp/models/index.md b/templates/api/keras_nlp/models/index.md
@@ -28,6 +28,9 @@ preprocessor = keras_nlp.models.BertPreprocessor.from_preset("bert_tiny_en_uncas
 
 {{backbone_presets_table}}
 
+**Note**: The links provided will lead to the model card or to the official README, 
+if no model card has been provided by the author.
+
 ## Classification presets
 
 The following preset names correspond to a configuration, weights and vocabulary
@@ -45,6 +48,9 @@ preprocessor = keras_nlp.models.BertPreprocessor.from_preset("bert_tiny_en_uncas
 
 {{classifier_presets_table}}
 
+**Note**: The links provided will lead to the model card or to the official README, 
+if no model card has been provided by the author.
+
 ## API Documentation
 
 {{toc}}