[None][doc] Enhance api reference doc by labeling stable APIs (NVIDIA#7751)

Signed-off-by: Yan Chunwei <[email protected]>

Author: Superjomn

docs/source/_static/custom.css

@@ -1,6 +1,6 @@
 .tag {
-  padding: 2px 5px;
-  border-radius: 4px;
+  padding: 2px 3px;
+  border-radius: 3px;
   font-size: 0.8em;
   margin-right: 5px;
   color: #000;
@@ -9,7 +9,7 @@
 code.beta {
   display: inline-block;
   background-color: #6c757d;
-  color: #999;
+  color: #fff;
 }
 
 code.prototype {
@@ -23,3 +23,9 @@ code.deprecated {
   background-color: red;
   color: #fff;
 }
+
+code.stable {
+  display: inline-block;
+  background-color: #28a745;
+  color: #fff;
+}

docs/source/helper.py

@@ -312,10 +312,10 @@ def generate_llmapi():
     content = underline("API Reference", "-") + "\n\n"
     content += ".. note::\n"
     content += "    Since version 1.0, we have attached a status label to `LLM`, `LlmArgs` and `TorchLlmArgs` Classes.\n\n"
-    content += '    1. :tag:`prototype` - The item is a prototype and is subject to change.\n'
-    content += '    2. :tag:`beta` - The item is in beta and approaching stability.\n'
-    content += '    3. :tag:`deprecated` - The item is deprecated and will be removed in a future release.\n'
-    content += "    4. For the remaining items without a status label, they are considered **stable**.\n"
+    content += "    1. :tag:`stable` - The item is stable and will keep consistent.\n"
+    content += '    2. :tag:`prototype` - The item is a prototype and is subject to change.\n'
+    content += '    3. :tag:`beta` - The item is in beta and approaching stability.\n'
+    content += '    4. :tag:`deprecated` - The item is deprecated and will be removed in a future release.\n'
     content += "\n"
 
     for cls_name in public_classes_names:

tensorrt_llm/llmapi/utils.py

@@ -520,6 +520,9 @@ def generate_api_docs_as_docstring(model: Type[BaseModel],
         arg_line = f"{indent}    {field_name} ({type_str}): "
         if status := field_info.get("status", None):
             arg_line += f":tag:`{status}` "
+        elif LABEL_STABLE_APIS:
+            arg_line += f":tag:`stable` "
+
         if field_description:
             arg_line += field_description.split('\n')[0]  # First line with type
 
@@ -553,6 +556,10 @@ def get_type_repr(cls):
     return f"{module_name}.{cls.__qualname__}"
 
 
+LABEL_STABLE_APIS: bool = True
+""" Whether to label the stable APIs with `stable` tags. """
+
+
 class ApiParamTagger:
     ''' A helper to tag the api doc according to the status of the fields.
     The status is set in the json_schema_extra of the field.