[None][doc] Use hash id for external link #7641

nv-guomingz · 2025-09-09T08:00:26Z

Summary by CodeRabbit

Documentation
- Updated documentation branding to “TensorRT LLM.”
- Source links now point to a specific commit for stable, reproducible references.
- Refreshed cross-references in Sampling and Installation pages, including a new anchor for the C++ runtime section and a corrected link to C++ benchmarks.
- Minor editorial cleanup in the Paged Attention scheduler page to improve readability.
- General link hygiene: migrated several links to source-prefixed references for consistency across the docs.

Description

Test Coverage

PR Checklist

Please review the following before submitting your PR:

PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.

GitHub Bot Help

/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...

Provide a user friendly way for developers to interact with a Jenkins server.

Run /bot [-h|--help] to print this help message.

See details below for each supported subcommand.

run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]

Launch build/test pipelines. All previously running jobs will be killed.

--reuse-test (optional)pipeline-id (OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.

--disable-reuse-test (OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.

--disable-fail-fast (OPTIONAL) : Disable fail fast on build/tests/infra failures.

--skip-test (OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.

--stage-list "A10-PyTorch-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.

--gpu-type "A30, H100_PCIe" (OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.

--test-backend "pytorch, cpp" (OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.

--only-multi-gpu-test (OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.

--disable-multi-gpu-test (OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.

--add-multi-gpu-test (OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.

--post-merge (OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.

--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" (OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".

--detailed-log (OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.

--debug (OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in the stage-list parameter to access the appropriate container environment. Note: Does NOT update GitHub check status.

For guidance on mapping tests to stage names, see docs/source/reference/ci-overview.md
and the scripts/test_to_stage_mapping.py helper.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip testing for latest commit on pull request. --comment "Reason for skipping build/test" is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

reuse-pipeline

reuse-pipeline

Reuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

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

coderabbitai · 2025-09-09T08:00:33Z

📝 Walkthrough

Walkthrough

Updates Sphinx docs config to use a commit-hash-based source link and rename the project. Edits multiple docs pages to adjust cross-references and wording. Adds an anchor and updates a link target in the installation guide. No runtime or API changes.

Changes

Cohort / File(s)	Summary of edits
Docs config (Sphinx) `docs/source/conf.py`	Renamed `project` to "TensorRT LLM"; removed `branch_name`; added `repo` and `commit_hash` from `pygit2`; updated `myst_url_schemes['source']` to use commit hash in GitHub URLs.
Docs: feature pages link/text tweaks `docs/source/features/paged-attention-ifb-scheduler.md`, `docs/source/features/sampling.md`	Replaced a linked “Previously” with plain text; converted several cross-references to source-prefixed links (SamplingParams, GuidedDecodingParams, examples, LogitsProcessor).
Docs: installation guide adjustments `docs/source/installation/build-from-source-linux.md`	Changed benchmark link to `source:benchmarks/cpp/`; added anchor `(link-with-the-tensorrt-llm-c++-runtime)=` for cross-referencing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The PR description is currently just the unmodified template and lacks any specific information about the changes made, missing the Description and Test Coverage sections along with actual content, so reviewers cannot assess what the PR accomplishes or how it is tested.	Please replace the placeholder template with actual content: provide a concise explanation of the link updates in the Description section, list relevant tests under Test Coverage, and confirm all PR Checklist items, removing the template comments so reviewers understand and can verify the changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title follows the repository’s PR naming conventions by specifying no ticket, using the [doc] type tag, and succinctly conveying the primary change of using a hash ID for external links, which aligns with the documented updates in conf.py and other documentation files.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

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

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: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

docs/source/conf.py (2)
1-1: Add NVIDIA Apache-2.0 header per guidelines.

Docs config is a Python source file; add the SPDX header with current year.
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved.
+ # SPDX-License-Identifier: Apache-2.0
  # Configuration file for the Sphinx documentation builder.
24-27: Make commit-hash resolution robust (no .git or pygit2).

Building docs in tarball environments or without pygit2 will fail. Add fallbacks to env vars (e.g., GITHUB_SHA) and a sane default to avoid breaking builds while preserving the hash when available.
-# Get the git commit hash
-repo = pygit2.Repository('.')
-commit_hash = str(repo.head.target)[:7]  # Get first 7 characters of commit hash
+# Get the git commit hash (robust to missing .git/pygit2)
+try:
+    repo = pygit2.Repository('.')  # requires .git and pygit2
+    commit_hash = str(repo.head.target)[:7]
+except Exception:
+    sha = os.environ.get('GITHUB_SHA') or os.environ.get('COMMIT_SHA')
+    commit_hash = (sha[:7] if sha else 'main')
No change needed to the myst_url_schemes entry; it will reuse commit_hash.

Also applies to: 80-81

🧹 Nitpick comments (3)

docs/source/features/paged-attention-ifb-scheduler.md (1)
138-138: Reinstate cross-reference instead of plain text.

Dropping the link is a UX regression. Point to the exact section using the new commit-hash “source:” scheme.
-Previously we recommended enabling paged context attention even though in our case study it didn't affect performance significantly. Now that we understand the TensorRT LLM scheduler, we can explain why this is beneficial. In short, we recommend enabling it because it enables context chunking, which allows the context phase of a request to be broken up into pieces and processed over several execution iterations, allowing the engine to provide a more stable balance of context and generation phase execution.
+Previously we recommended enabling [paged context attention](source:docs/source/features/useful-build-time-flags.md#paged-context-attention) even though in our case study it didn't affect performance significantly. Now that we understand the TensorRT LLM scheduler, we can explain why this is beneficial. In short, we recommend enabling it because it enables context chunking, which allows the context phase of a request to be broken up into pieces and processed over several execution iterations, allowing the engine to provide a more stable balance of context and generation phase execution.
docs/source/conf.py (1)
19-22: Project naming consistency.

You renamed the Sphinx project to “TensorRT LLM”, but Breathe still uses “TensorRT-LLM”. If intentional, fine; otherwise unify to avoid confusion in generated docs. Also prefer “NVIDIA” capitalization.
-project = 'TensorRT LLM'
-copyright = '2025, NVidia'
-author = 'NVidia'
+project = 'TensorRT LLM'
+copyright = '2025, NVIDIA'
+author = 'NVIDIA'
docs/source/installation/build-from-source-linux.md (1)
161-161: Fix link text to match path.

The visible text says “benchmark/cpp” but the link path is “benchmarks/cpp/”. Align the label.
-To use the C++ benchmark scripts under [benchmark/cpp](source:benchmarks/cpp/), for example `gptManagerBenchmark.cpp`, add the `--benchmarks` option:
+To use the C++ benchmark scripts under [benchmarks/cpp](source:benchmarks/cpp/), for example `gptManagerBenchmark.cpp`, add the `--benchmarks` option:

📜 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 49dcc0d and 354821a.

📒 Files selected for processing (4)

docs/source/conf.py (2 hunks)
docs/source/features/paged-attention-ifb-scheduler.md (1 hunks)
docs/source/features/sampling.md (4 hunks)
docs/source/installation/build-from-source-linux.md (2 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/conf.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/conf.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/conf.py

🧠 Learnings (1)

📚 Learning: 2025-08-18T09:08:07.687Z

Learnt from: tongyuantongyu
PR: NVIDIA/TensorRT-LLM#6984
File: cpp/tensorrt_llm/CMakeLists.txt:297-299
Timestamp: 2025-08-18T09:08:07.687Z
Learning: In the TensorRT-LLM project, artifacts are manually copied rather than installed via `cmake --install`, so INSTALL_RPATH properties are not needed - only BUILD_RPATH affects the final artifacts.

Applied to files:

docs/source/installation/build-from-source-linux.md

⏰ 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

🔇 Additional comments (7)

docs/source/features/sampling.md (5)

9-9: LGTM: link converted to commit-hash “source:” scheme.

Matches the PR objective and is resilient to branch renames.

77-77: Verify target class location vs example import.

Link points to sampling_params.py#L14, while the example imports GuidedDecodingParams from tensorrt_llm.llmapi. Confirm the symbol’s canonical location or align link/import for consistency.

97-97: LGTM: example link updated to source path.

Consistent with the new scheme.

105-105: LGTM: LogitsProcessor link switched to source path.

Good use of immutable commit-hash linking.

135-135: LGTM: logits processors example link updated.

Change aligns with the repo-wide convention.

docs/source/conf.py (1)

135-137: LGTM: surface commit in footer.

Good addition; ensure it uses the same commit_hash fallback logic above to avoid build breaks.

docs/source/installation/build-from-source-linux.md (1)

183-185: LGTM: anchor added for cross-referencing.

Anchor name is descriptive and matches the earlier reference.

nv-guomingz · 2025-09-09T08:07:08Z

/bot skip --comment "docs only change"

tensorrt-cicd · 2025-09-09T08:12:40Z

PR_Github #18191 [ skip ] triggered by Bot

tensorrt-cicd · 2025-09-09T08:34:03Z

PR_Github #18191 [ skip ] completed with state SUCCESS
Skipping testing for commit 354821a

Signed-off-by: nv-guomingz <137257613+nv-guomingz@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>

[None][doc] Use hash id for external link

354821a

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

nv-guomingz requested a review from a team as a code owner September 9, 2025 08:00

nv-guomingz requested a review from chzblych September 9, 2025 08:00

chzblych approved these changes Sep 9, 2025

View reviewed changes

coderabbitai bot reviewed Sep 9, 2025

View reviewed changes

nv-guomingz enabled auto-merge (squash) September 9, 2025 08:09

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

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

[None][doc] Use hash id for external link (NVIDIA#7641)

4514897

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

nv-guomingz deleted the user/guomingz/use_hash_id_for_external_link branch September 17, 2025 06:23

chzblych pushed a commit that referenced this pull request Sep 22, 2025

[None][doc] Use hash id for external link (#7641)

ab915fb

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[None][doc] Use hash id for external link #7641

[None][doc] Use hash id for external link #7641

Uh oh!

nv-guomingz commented Sep 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 9, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Uh oh!

coderabbitai bot left a comment

Uh oh!

nv-guomingz commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[None][doc] Use hash id for external link #7641

[None][doc] Use hash id for external link #7641

Uh oh!

Conversation

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

Uh oh!

Summary by CodeRabbit

Description

Test Coverage

PR Checklist

GitHub Bot Help

kill

skip

reuse-pipeline

Uh oh!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Pre-merge checks (2 passed, 1 warning)

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

nv-guomingz commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nv-guomingz commented Sep 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 9, 2025 •

edited

Loading