Skip to content

Conversation

@Superjomn
Copy link
Collaborator

@Superjomn Superjomn commented Jul 3, 2025

Motivation

  • Add clear "prototype", "beta" tags to the API reference
  • Print warning logs when users touch the unstable ("beta", "prototype") APIs

Change

Add "prototype" and "beta" tags to all the APIs those not in the "committed_reference", note that, only the non-committed APIs has the tag.

image

There are two deprecated knobs:
image

Update to the LlmArgs development

For the non-committed APIs:

  • Each API field should add consistent status metadata, the status could be either "beta" or "prototype"
    • In LlmArgs or other Pydantic classes, xxx_field = Field(..., status="beta")
    • In reference/llm.yaml, add status: beta
  • Each API method should add consistent status metadata
    • Add @set_api_status("beta") on the target method
    • Add status: beta in the reference/llm.yaml

Summary by CodeRabbit

  • New Features

    • Introduced visual tags and styling in documentation to highlight beta, prototype, and deprecated features.
    • Added status annotations ("beta", "prototype", "deprecated") to API parameters and methods, now visible in documentation.
    • Implemented warnings for usage of unstable (beta/prototype) features in certain argument classes.
  • Bug Fixes

    • Improved exclusion of deprecated and unstable fields from generated documentation.
  • Tests

    • Added tests to verify correct tagging and status annotation of API methods and parameters.
    • Enhanced API stability tests to check for consistency of status metadata.
  • Documentation

    • Updated documentation configuration and reference files to reflect new status tags and styling.

@Superjomn Superjomn added the Doc <NV>TRTLLM's textual/illustrative materials: API refs, guides, tutorials. Improvement & clarity. label Jul 3, 2025
@Superjomn Superjomn changed the title chore: add experimental tags to API reference [TRTLLM-5061] chore: add experimental tags to API reference Jul 3, 2025
@Superjomn Superjomn force-pushed the doc-mark-api-backend branch from b2c9325 to 3a005da Compare July 4, 2025 03:21
@Superjomn
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #10912 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #10912 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #8065 completed with status: 'FAILURE'

@Superjomn Superjomn force-pushed the doc-mark-api-backend branch from 3a005da to d9d5aca Compare July 4, 2025 05:44
@Superjomn
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #10936 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #10936 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #8084 completed with status: 'FAILURE'

@Superjomn Superjomn force-pushed the doc-mark-api-backend branch from d9d5aca to 83d230a Compare July 7, 2025 09:16
@Superjomn
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11128 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11128 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #8229 completed with status: 'FAILURE'

@Superjomn
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11137 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11137 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #8233 completed with status: 'FAILURE'

@Superjomn Superjomn force-pushed the doc-mark-api-backend branch 2 times, most recently from 6be2f72 to a95cb28 Compare July 14, 2025 07:47
@Superjomn Superjomn requested a review from a team as a code owner July 14, 2025 07:47
@Superjomn Superjomn requested a review from juney-nvidia July 14, 2025 07:47
@Superjomn Superjomn force-pushed the doc-mark-api-backend branch from a95cb28 to d5739ef Compare July 15, 2025 14:33
@Superjomn Superjomn requested review from a team as code owners July 15, 2025 14:33
@Superjomn Superjomn force-pushed the doc-mark-api-backend branch 4 times, most recently from b9ee9ba to d474788 Compare July 16, 2025 07:39
@Superjomn Superjomn requested review from hchings and nv-guomingz July 16, 2025 10:08
Signed-off-by: Superjomn <[email protected]>
We can use status label directly.

Signed-off-by: Superjomn <[email protected]>
Signed-off-by: Superjomn <[email protected]>
Signed-off-by: Superjomn <[email protected]>
@Superjomn Superjomn force-pushed the doc-mark-api-backend branch from 3671257 to b237a1f Compare July 27, 2025 03:22
@Superjomn
Copy link
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #13087 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #13087 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #9785 completed with status: 'FAILURE'

@Superjomn Superjomn force-pushed the doc-mark-api-backend branch from b237a1f to c724e45 Compare July 27, 2025 12:10
@Superjomn Superjomn requested a review from a team as a code owner July 27, 2025 12:10
@Superjomn
Copy link
Collaborator Author

/bot run

Signed-off-by: Superjomn <[email protected]>
@Superjomn Superjomn force-pushed the doc-mark-api-backend branch from c724e45 to e0e6331 Compare July 27, 2025 12:14
@tensorrt-cicd
Copy link
Collaborator

PR_Github #13102 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #13102 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #9799 completed with status: 'SUCCESS'
Pipeline passed with automatic retried tests. Check the rerun report for details.

@Superjomn Superjomn changed the title [TRTLLM-5061] chore: add tags to API reference [TRTLLM-5061] chore: add status tags to LLM API reference Jul 28, 2025
Copy link
Collaborator

@QiJune QiJune left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Superjomn Superjomn enabled auto-merge (squash) July 28, 2025 01:15
@Superjomn Superjomn requested review from FrankD412 and removed request for juney-nvidia July 28, 2025 01:17
@Superjomn Superjomn merged commit 45d441e into NVIDIA:main Jul 28, 2025
3 checks passed
@Superjomn Superjomn deleted the doc-mark-api-backend branch July 28, 2025 07:57
NVShreyas pushed a commit to NVShreyas/TensorRT-LLM that referenced this pull request Jul 28, 2025
Ransiki pushed a commit to Ransiki/TensorRT-LLM that referenced this pull request Jul 29, 2025
lancelly pushed a commit to lancelly/TensorRT-LLM that referenced this pull request Aug 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc <NV>TRTLLM's textual/illustrative materials: API refs, guides, tutorials. Improvement & clarity.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants