[None] [docs] Update TPOT/ITL docs #8378
Conversation
Signed-off-by: Kaiyu Xie <26294424+kaiyux@users.noreply.github.com>
📝 WalkthroughWalkthroughDocumentation updates standardize metric headings (removing “Median”), restructure the benchmark metrics section to consolidate TPOT and ITL with added formulas and adjusted examples, and make minor editorial/formatting tweaks. One quick-start guide (GPT-OSS) expands accuracy evaluation references and example commands. 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 (beta)
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: 1
🧹 Nitpick comments (1)
docs/source/deployment-guide/quick-start-recipe-for-llama3.3-70b-on-trtllm.md (1)
53-54: Add missing article for readability.Please change “use latest main branch” to “use the latest main branch” to keep the prose grammatical.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/source/commands/trtllm-serve/run-benchmark-with-trtllm-serve.md(2 hunks)docs/source/deployment-guide/quick-start-recipe-for-deepseek-r1-on-trtllm.md(4 hunks)docs/source/deployment-guide/quick-start-recipe-for-gpt-oss-on-trtllm.md(3 hunks)docs/source/deployment-guide/quick-start-recipe-for-llama3.3-70b-on-trtllm.md(10 hunks)docs/source/deployment-guide/quick-start-recipe-for-llama4-scout-on-trtllm.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/source/commands/trtllm-serve/run-benchmark-with-trtllm-serve.md
[grammar] ~154-~154: There might be a mistake here.
Context: ...Metrics #### Time to First Token (TTFT) * The typical time elapsed from when a req...
(QB_NEW_EN)
[grammar] ~164-~164: There might be a mistake here.
Context: ...T is the average of those intervals: [ \text{TPOT (1 request)} = \text{Avg(ITL)...
(QB_NEW_EN)
[grammar] ~165-~165: There might be a mistake here.
Context: ...\text{TTFT}}{\text{#Output Tokens} - 1} ] Across different requests, **average...
(QB_NEW_EN)
[grammar] ~170-~170: There might be a mistake here.
Context: ...ghted (all tokens weighted equally): [ \text{Avg TPOT (N requests)} = \frac{\te...
(QB_NEW_EN)
[grammar] ~171-~171: There might be a mistake here.
Context: ...ext{TPOT}_2 + \cdots + \text{TPOT}_N}{N} ] [ \text{Avg ITL (N requests)} = \fr...
(QB_NEW_EN)
[grammar] ~174-~174: There might be a mistake here.
Context: ...T}_2 + \cdots + \text{TPOT}_N}{N} ] [ \text{Avg ITL (N requests)} = \frac{\tex...
(QB_NEW_EN)
[grammar] ~175-~175: There might be a mistake here.
Context: ...{\text{#Output Tokens across requests}} ] #### End-to-End (E2E) Latency * Th...
(QB_NEW_EN)
[grammar] ~178-~178: There might be a mistake here.
Context: ...ests}} ] #### End-to-End (E2E) Latency * The typical total time from when a reque...
(QB_NEW_EN)
[grammar] ~181-~181: There might be a mistake here.
Context: ...s received. #### Total Token Throughput * The combined rate at which the system pr...
(QB_NEW_EN)
docs/source/deployment-guide/quick-start-recipe-for-llama3.3-70b-on-trtllm.md
[grammar] ~15-~15: There might be a mistake here.
Context: ... NVIDIA Blackwell or Hopper Architecture OS: Linux Drivers: CUDA Driver 575 or La...
(QB_NEW_EN)
[grammar] ~16-~16: There might be a mistake here.
Context: ...ackwell or Hopper Architecture OS: Linux Drivers: CUDA Driver 575 or Later Docker...
(QB_NEW_EN)
[grammar] ~17-~17: There might be a mistake here.
Context: ... Linux Drivers: CUDA Driver 575 or Later Docker with NVIDIA Container Toolkit ins...
(QB_NEW_EN)
[grammar] ~18-~18: There might be a mistake here.
Context: ... with NVIDIA Container Toolkit installed Python3 and python3-pip (Optional, for a...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...* FP8 model: Llama-3.3-70B-Instruct-FP8 * NVFP4 model: [Llama-3.3-70B-Instruct-FP4...
(QB_NEW_EN)
[grammar] ~53-~53: There might be a mistake here.
Context: ...el and feature support. If you want to use latest main branch, you can choose to b...
(QB_NEW_EN)
docs/source/deployment-guide/quick-start-recipe-for-deepseek-r1-on-trtllm.md
[grammar] ~61-~61: There might be a mistake here.
Context: ...el and feature support. If you want to use latest main branch, you can choose to b...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.18.1)
docs/source/commands/trtllm-serve/run-benchmark-with-trtllm-serve.md
155-155: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
158-158: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
159-159: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
160-160: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
179-179: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
⏰ 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/commands/trtllm-serve/run-benchmark-with-trtllm-serve.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Kaiyu Xie <26294424+kaiyux@users.noreply.github.com>
|
/bot skip --comment "doc changes" |
|
PR_Github #21423 [ skip ] triggered by Bot |
|
PR_Github #21423 [ skip ] completed with state |
Signed-off-by: Kaiyu Xie <26294424+kaiyux@users.noreply.github.com>
3 participants
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.