[None][doc] Add labels description note into llm api section #7696

nv-guomingz · 2025-09-14T04:17:22Z

Add note section to describe beta/prototype/deprecated label's meaning for LLM API reference

Summary by CodeRabbit

Documentation
- Added a top-of-page note in the API Reference describing status labels for endpoints and parameters (prototype, beta, deprecated, stable) to clarify stability and lifecycle.
- Minor formatting cleanup in generated docs to remove an extra blank line for improved layout consistency.
Chores
- No changes to public APIs; updates are limited to documentation content and presentation.

coderabbitai · 2025-09-14T04:17:28Z

📝 Walkthrough

Walkthrough

Adds a collapsible Sphinx note describing endpoint/parameter status labels to generate_llmapi() and removes an extra blank line emitted after autoclass options. No public APIs or exported declarations were modified.

Changes

Cohort / File(s)	Summary of Changes
Docs generation: API reference note and formatting `docs/source/helper.py`	- Prepended a collapsible Sphinx note at the top of the API Reference generated by `generate_llmapi()`, documenting status labels: `prototype`, `beta`, `deprecated`, and no label - Removed an extraneous blank line after emitting autoclass options - No changes to public APIs or exported declarations

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant Helper as helper.generate_llmapi()
  participant RST as Generated RST
  participant Sphinx as Sphinx Builder
  participant Docs as HTML Docs

  Dev->>Helper: Run generate_llmapi()
  Helper->>RST: Emit API Reference content
  Note over Helper,RST #D6EAF8: New: prepend collapsible status-label note\n(labels: prototype, beta, deprecated, none)
  Helper->>RST: Emit autoclass options (removed extra blank line)
  RST->>Sphinx: Build docs
  Sphinx->>Docs: Render with status-note included

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The PR description is a single-line summary plus an image and does not follow the repository's required template: it lacks a detailed Description (what and why), a Test Coverage section listing relevant tests, and confirmation of the PR Checklist items; the PR objectives and raw_summary confirm doc-only changes but the template fields remain unpopulated, so the description is largely incomplete.	Please update the PR description to use the repository template by adding a detailed Description explaining the change and rationale, a Test Coverage section listing relevant tests or why none are needed, and complete the PR Checklist (docs updated, CODEOWNERS, CI links). Also consider adding the JIRA/issue tag in the title if available and include any links to rendered docs or CI results.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "[None][doc] Add labels description note into llm api section" accurately and concisely reflects the primary change shown in the raw summary and PR objectives: adding a note describing prototype/beta/deprecated labels to the LLM API documentation (docs/source/helper.py). It follows the repository's title format and is specific enough for reviewers to understand the main intent without listing trivial formatting edits.

✨ Finishing touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2456c6c and 4dc8723.

📒 Files selected for processing (1)

docs/source/helper.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

docs/source/helper.py

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Pre-commit Check

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (4)

docs/source/helper.py (4)

315-318: Replace ambiguous Unicode spaces/hyphen with ASCII.

Ruff flags NARROW NO‑BREAK SPACE and NON‑BREAKING HYPHEN. Use plain spaces and -.

Apply:

-    content += "    Since version 1.0, we attach a status label to every API endpoint and every parameter.\n\n"
-    content += "    1. `prototype`  the item is still in the prototype‑development stage.\n"
-    content += "    2. `beta`  the item is approaching completion.\n"
-    content += "    3. `deprecated`  the item is deprecated.\n"
+    content += "    Since version 1.0, we attach a status label to every API endpoint and every parameter.\n\n"
+    content += "    1. `prototype` the item is still in the prototype-development stage.\n"
+    content += "    2. `beta` the item is approaching completion.\n"
+    content += "    3. `deprecated` the item is deprecated.\n"

319-319: Fix list numbering (“3.” repeats).

Use “4.” for the last item (or switch to auto-enumeration with #.).

Apply:

-    content += "    3. `No label`  the item is already stable.\n"
+    content += "    4. `No label` the item is already stable.\n"

313-321: Optional: Use a single triple‑quoted block for readability and fewer off‑by‑whitespace risks.

Keeps content maintainable and reduces chances of rST formatting errors.

Example:

-    content += ".. note::\n"
-    content += "    :class: dropdown\n"
-    content += "\n"
-    content += "    Since version 1.0, we attach a status label to every API endpoint and every parameter.\n\n"
-    content += "    1. `prototype` the item is still in the prototype-development stage.\n"
-    content += "    2. `beta` the item is approaching completion.\n"
-    content += "    3. `deprecated` the item is deprecated.\n"
-    content += "    4. `No label` the item is already stable.\n"
-    content += "\n"
+    content += (
+        ".. note::\n"
+        "    :class: dropdown\n"
+        "\n"
+        "    Since version 1.0, we attach a status label to every API endpoint and every parameter.\n\n"
+        "    1. `prototype` the item is still in the prototype-development stage.\n"
+        "    2. `beta` the item is approaching completion.\n"
+        "    3. `deprecated` the item is deprecated.\n"
+        "    4. `No label` the item is already stable.\n"
+        "\n"
+    )

1-1: Missing NVIDIA Apache‑2.0 header (2025).

Guidelines require the header atop all .py files.

Apply:

+# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 import logging

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c0e4fce and cad6f8a.

📒 Files selected for processing (1)

docs/source/helper.py (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{h,hpp,hh,hxx,cpp,cxx,cc,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Use only spaces, no tabs; indent with 4 spaces.

Files:

docs/source/helper.py

**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: Python code must target Python 3.8+.
Indent Python code with 4 spaces; do not use tabs.
Maintain module namespace when importing; prefer 'from package.subpackage import foo' then 'foo.SomeClass()' instead of importing the class directly.
Python filenames should be snake_case (e.g., some_file.py).
Python classes use PascalCase names.
Functions and methods use snake_case names.
Local variables use snake_case; prefix 'k' for variables that start with a number (e.g., k_99th_percentile).
Global variables use upper SNAKE_CASE prefixed with 'G' (e.g., G_MY_GLOBAL).
Constants use upper SNAKE_CASE (e.g., MY_CONSTANT).
Avoid shadowing variables from an outer scope.
Initialize all externally visible members of a class in the constructor.
Prefer docstrings for interfaces that may be used outside a file; comments for in-function or file-local interfaces.
Use Google-style docstrings for classes and functions (Sphinx-parsable).
Document attributes and variables inline so they render under the class/function docstring.
Avoid reflection when a simpler, explicit approach suffices (e.g., avoid dict(**locals()) patterns).
In try/except, catch the most specific exceptions possible.
For duck-typing try/except, keep the try body minimal and use else for the main logic.

Files:

docs/source/helper.py

**/*.{cpp,cxx,cc,h,hpp,hh,hxx,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Prepend the NVIDIA Apache-2.0 copyright header with current year to the top of all source files (e.g., .cpp, .h, .cu, .py).

Files:

docs/source/helper.py

🪛 Ruff (0.12.2)

docs/source/helper.py

315-315: String contains ambiguous   (NARROW NO-BREAK SPACE). Did you mean (SPACE)?

(RUF001)

316-316: String contains ambiguous   (NARROW NO-BREAK SPACE). Did you mean (SPACE)?

(RUF001)

316-316: String contains ambiguous ‑ (NON-BREAKING HYPHEN). Did you mean - (HYPHEN-MINUS)?

(RUF001)

317-317: String contains ambiguous   (NARROW NO-BREAK SPACE). Did you mean (SPACE)?

(RUF001)

318-318: String contains ambiguous   (NARROW NO-BREAK SPACE). Did you mean (SPACE)?

(RUF001)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Pre-commit Check

docs/source/helper.py

nv-guomingz · 2025-09-14T14:42:48Z

/bot run

tensorrt-cicd · 2025-09-14T14:47:55Z

PR_Github #18514 [ run ] triggered by Bot

tensorrt-cicd · 2025-09-14T15:26:34Z

PR_Github #18514 [ run ] completed with state SUCCESS
/LLM/release-1.0/L0_MergeRequest_PR pipeline #381 completed with status: 'SUCCESS'

juney-nvidia

LGTM

nv-guomingz · 2025-09-15T04:44:01Z

/bot skip --comment "doc build already pass"

tensorrt-cicd · 2025-09-15T04:49:34Z

PR_Github #18565 [ skip ] triggered by Bot

tensorrt-cicd · 2025-09-15T05:03:35Z

PR_Github #18565 [ skip ] completed with state SUCCESS
Skipping testing for commit 2456c6c

docs/source/helper.py

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

nv-guomingz · 2025-09-15T05:55:37Z

/bot skip --comment "doc build already pass"

tensorrt-cicd · 2025-09-15T06:00:44Z

PR_Github #18578 [ skip ] triggered by Bot

tensorrt-cicd · 2025-09-15T06:15:07Z

PR_Github #18578 [ skip ] completed with state SUCCESS
Skipping testing for commit 4dc8723

…7696) Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

…7696) Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com> Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com> Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>

…7696) Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com> Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>

nv-guomingz requested a review from a team as a code owner September 14, 2025 04:17

coderabbitai bot reviewed Sep 14, 2025

View reviewed changes

docs/source/helper.py Outdated Show resolved Hide resolved

nv-guomingz requested a review from Superjomn September 14, 2025 14:25

nv-guomingz force-pushed the user/guomingz/add_label_note_1.0 branch from cad6f8a to 4d2d627 Compare September 14, 2025 14:25

nv-guomingz added Release Blocker PRs that blocking the final release build or branching out the release branch 1.0_doc labels Sep 14, 2025

nv-guomingz requested a review from laikhtewari September 14, 2025 14:26

juney-nvidia approved these changes Sep 15, 2025

View reviewed changes

nv-guomingz force-pushed the user/guomingz/add_label_note_1.0 branch from 4d2d627 to 2456c6c Compare September 15, 2025 04:39

nv-guomingz enabled auto-merge (squash) September 15, 2025 04:44

nv-guomingz disabled auto-merge September 15, 2025 05:02

Superjomn reviewed Sep 15, 2025

View reviewed changes

docs/source/helper.py Outdated Show resolved Hide resolved

nv-guomingz force-pushed the user/guomingz/add_label_note_1.0 branch from 2456c6c to 742af96 Compare September 15, 2025 05:55

[None][doc] Add labels description note into llm api section

4dc8723

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

nv-guomingz force-pushed the user/guomingz/add_label_note_1.0 branch from 742af96 to 4dc8723 Compare September 15, 2025 05:55

nv-guomingz enabled auto-merge (squash) September 15, 2025 05:56

nv-guomingz merged commit 9d719dd into NVIDIA:release/1.0 Sep 15, 2025
5 checks passed

dominicshanshan pushed a commit to dominicshanshan/TensorRT-LLM that referenced this pull request Sep 16, 2025

[None][doc] Add labels description note into llm api section (NVIDIA#…

469cd4b

…7696) Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

nv-guomingz deleted the user/guomingz/add_label_note_1.0 branch September 30, 2025 08:01

[None][doc] Add labels description note into llm api section #7696

[None][doc] Add labels description note into llm api section #7696

Conversation

nv-guomingz commented Sep 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nv-guomingz commented Sep 14, 2025

Uh oh!

tensorrt-cicd commented Sep 14, 2025

Uh oh!

tensorrt-cicd commented Sep 14, 2025

Uh oh!

juney-nvidia left a comment

Choose a reason for hiding this comment

Uh oh!

nv-guomingz commented Sep 15, 2025

Uh oh!

tensorrt-cicd commented Sep 15, 2025

Uh oh!

tensorrt-cicd commented Sep 15, 2025

Uh oh!

Uh oh!

nv-guomingz commented Sep 15, 2025

Uh oh!

tensorrt-cicd commented Sep 15, 2025

Uh oh!

tensorrt-cicd commented Sep 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

nv-guomingz commented Sep 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 14, 2025 •

edited

Loading