Skip to content

Commit 9eb78f8

Browse files
nv-guomingzdominicshanshan
authored andcommitted
[None][doc] Add labels description note into llm api section (NVIDIA#7696)
Signed-off-by: nv-guomingz <[email protected]> Signed-off-by: Wangshanshan <[email protected]>
1 parent 9462312 commit 9eb78f8

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/source/helper.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,14 @@ def generate_llmapi():
310310
public_classes_names = extract_all_and_eval(llmapi_all_file)['__all__']
311311

312312
content = underline("API Reference", "-") + "\n\n"
313+
content += ".. note::\n"
314+
content += " Since version 1.0, we have attached a status label to `LLM`, `LlmArgs` and `TorchLlmArgs` Classes.\n\n"
315+
content += ' 1. :tag:`prototype` - The item is a prototype and is subject to change.\n'
316+
content += ' 2. :tag:`beta` - The item is in beta and approaching stability.\n'
317+
content += ' 3. :tag:`deprecated` - The item is deprecated and will be removed in a future release.\n'
318+
content += " 4. For the remaining items without a status label, they are considered **stable**.\n"
319+
content += "\n"
320+
313321
for cls_name in public_classes_names:
314322
cls_name = cls_name.strip()
315323
options = [
@@ -328,7 +336,6 @@ def generate_llmapi():
328336

329337
content += f".. autoclass:: tensorrt_llm.llmapi.{cls_name}\n"
330338
content += "\n".join(options) + "\n\n"
331-
332339
with open(doc_path, "w+") as f:
333340
f.write(content)
334341

0 commit comments

Comments
 (0)