[None][doc] Fix broken links in markdown files #7913
Conversation
Signed-off-by: Kanghwan Jang <[email protected]>
|
/bot skip --comment "Changed documents only" |
|
PR_Github #19619 [ skip ] triggered by Bot |
📝 WalkthroughWalkthroughThis pull request updates documentation links and paths across multiple files to reflect a reorganized docs structure, moving several references to legacy locations. No source code, APIs, or control flow are modified. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/source/developer-guide/perf-benchmarking.md (1)
101-103: Fix empty link text and satisfy MD059The link has empty text: . Use descriptive text and keep the support-matrix anchor.
-For more information about quantization, refer to [](../legacy/reference/precision.md) and -the [support matrix](../legacy/reference/precision.md#support-matrix) of the supported quantization methods for each network. +For more information about quantization, refer to the [precision and quantization reference](../legacy/reference/precision.md) and +the [support matrix](../legacy/reference/precision.md#support-matrix) for supported methods by network.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)docs/source/developer-guide/perf-benchmarking.md(3 hunks)docs/source/legacy/torch.md(1 hunks)
🧰 Additional context used
🧠 Learnings (9)
📚 Learning: 2025-08-21T00:16:56.457Z
Learnt from: farshadghodsian
PR: NVIDIA/TensorRT-LLM#7101
File: docs/source/blogs/tech_blog/blog9_Deploying_GPT_OSS_on_TRTLLM.md:36-36
Timestamp: 2025-08-21T00:16:56.457Z
Learning: TensorRT-LLM container release tags in documentation should only reference published NGC container images. The README badge version may be ahead of the actual published container versions.
Applied to files:
README.md
📚 Learning: 2025-08-01T15:14:45.673Z
Learnt from: yibinl-nvidia
PR: NVIDIA/TensorRT-LLM#6506
File: examples/models/core/mixtral/requirements.txt:3-3
Timestamp: 2025-08-01T15:14:45.673Z
Learning: In TensorRT-LLM, examples directory can have different dependency versions than the root requirements.txt file. Version conflicts between root and examples dependencies are acceptable because examples are designed to be standalone and self-contained.
Applied to files:
README.mddocs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-08-06T13:58:07.506Z
Learnt from: galagam
PR: NVIDIA/TensorRT-LLM#6487
File: tests/unittest/_torch/auto_deploy/unit/singlegpu/test_ad_trtllm_bench.py:1-12
Timestamp: 2025-08-06T13:58:07.506Z
Learning: In TensorRT-LLM, test files (files under tests/ directories) do not require NVIDIA copyright headers, unlike production source code files. Test files typically start directly with imports, docstrings, or code.
Applied to files:
README.mddocs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-07-28T17:06:08.621Z
Learnt from: moraxu
PR: NVIDIA/TensorRT-LLM#6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
Applied to files:
README.mddocs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-08-11T20:09:24.389Z
Learnt from: achartier
PR: NVIDIA/TensorRT-LLM#6763
File: tests/integration/defs/triton_server/conftest.py:16-22
Timestamp: 2025-08-11T20:09:24.389Z
Learning: In the TensorRT-LLM test infrastructure, the team prefers simple, direct solutions (like hard-coding directory traversal counts) over more complex but robust approaches when dealing with stable directory structures. They accept the maintenance cost of updating tests if the layout changes.
Applied to files:
README.mddocs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-09-09T09:40:45.658Z
Learnt from: fredricz-20070104
PR: NVIDIA/TensorRT-LLM#7645
File: tests/integration/test_lists/qa/llm_function_core.txt:648-648
Timestamp: 2025-09-09T09:40:45.658Z
Learning: In TensorRT-LLM test lists, it's common and intentional for the same test to appear in multiple test list files when they serve different purposes (e.g., llm_function_core.txt for comprehensive core functionality testing and llm_function_core_sanity.txt for quick sanity checks). This duplication allows tests to be run in different testing contexts.
Applied to files:
README.mddocs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-08-27T14:23:55.566Z
Learnt from: ixlmar
PR: NVIDIA/TensorRT-LLM#7294
File: tensorrt_llm/_torch/modules/rms_norm.py:17-17
Timestamp: 2025-08-27T14:23:55.566Z
Learning: The TensorRT-LLM project requires Python 3.10+ as evidenced by the use of TypeAlias from typing module, match/case statements, and union type | syntax throughout the codebase, despite some documentation still mentioning Python 3.8+.
Applied to files:
README.md
📚 Learning: 2025-08-26T09:49:04.956Z
Learnt from: pengbowang-nv
PR: NVIDIA/TensorRT-LLM#7192
File: tests/integration/test_lists/test-db/l0_dgx_b200.yml:56-72
Timestamp: 2025-08-26T09:49:04.956Z
Learning: In TensorRT-LLM test configuration files, the test scheduling system handles wildcard matching with special rules that prevent duplicate test execution even when the same tests appear in multiple yaml files with overlapping GPU wildcards (e.g., "*b200*" and "*gb200*").
Applied to files:
docs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-08-27T16:59:12.325Z
Learnt from: Fridah-nv
PR: NVIDIA/TensorRT-LLM#7227
File: tests/unittest/_torch/auto_deploy/_utils_test/_model_test_utils.py:269-275
Timestamp: 2025-08-27T16:59:12.325Z
Learning: In FP8 quantized linear layers, bias should be kept in high precision (typically float32) rather than being quantized to FP8 or cast to half precision, as bias is added after the matrix multiplication and high precision bias helps maintain numerical accuracy.
Applied to files:
docs/source/developer-guide/perf-benchmarking.md
🪛 markdownlint-cli2 (0.18.1)
docs/source/developer-guide/perf-benchmarking.md
102-102: Link text should be descriptive
(MD059, descriptive-link-text)
⏰ 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 (9)
docs/source/legacy/torch.md (4)
29-31: Developer Guide links LGTMTargets under ../torch and ../models appear consistent with the new structure.
34-37: Key Components links LGTMPaths to ../features/attention.md and ../torch/* components look consistent.
22-26: Feature links look correct after reparenting — no changes requiredVerified files exist at docs/source/features/sampling.md, docs/source/features/quantization.md, docs/source/torch/features/overlap_scheduler.md, docs/source/torch/features/feature_combination_matrix.md.
44-44: Broken relative path — update link to ../features/auto_deploy/auto-deploy.mddocs/source/legacy/torch.md (line 44): "./torch/auto_deploy/auto-deploy.md" resolves to docs/source/legacy/torch/..., but the file exists at docs/source/features/auto_deploy/auto-deploy.md — change the link to ../features/auto_deploy/auto-deploy.md.
Likely an incorrect or invalid review comment.
docs/source/developer-guide/perf-benchmarking.md (3)
70-71: Verified: Performance Overview link resolves to existing doc.
../legacy/performance/perf-overview.md → docs/source/legacy/performance/perf-overview.md (file present).
11-11: Anchor exists — no action requiredHeader "Throughput Measurements" is present in docs/source/legacy/performance/perf-overview.md (line 17), so ../legacy/performance/perf-overview.md#throughput-measurements is valid.
18-19: Link target exists — no action required.docs/source/legacy/advanced/gpt-attention.md defines (inflight-batching)= and a "## In-flight Batching" section, so ../legacy/advanced/gpt-attention.md#in-flight-batching resolves.
CONTRIBUTING.md (1)
139-151: Align example stack trace path to ./tests/unittest/api_stabilityCONTRIBUTING.md still references the old tests/api_stability path; update it to the new path (tests/unittest/api_stability exists).
- tests/api_stability/test_api_stability.py:241: AssertionError + tests/unittest/api_stability/test_api_stability.py:241: AssertionErrorREADME.md (1)
15-15: Verify updated Performance link and anchor — confirmeddocs/source/legacy/performance/perf-overview.md exists and contains the heading "## Throughput Measurements" (line 17).
|
PR_Github #19619 [ skip ] completed with state |
|
|
||
| `trtllm-bench` executes all benchmarks using [in-flight batching] -- for more information see | ||
| the [in-flight batching section](../advanced/gpt-attention.md#in-flight-batching) that describes the concept | ||
| the [in-flight batching section](../legacy/advanced/gpt-attention.md#in-flight-batching) that describes the concept |
There was a problem hiding this comment.
../features/attention.md#inflight-batching
|
Thanks, sounds good. I'll close it~ |
Summary by CodeRabbit
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 thestage-listparameter 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.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip 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-pipelineReuse 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.