KEMBAR78
[None][fix] fix doc formula by yunruis · Pull Request #7367 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@yunruis
Copy link
Contributor

@yunruis yunruis commented Aug 29, 2025

Summary by CodeRabbit

  • Documentation
    • Corrected the sol_time calculation in the ADP Balance Strategy blog to use multiplication by the balance ratio instead of division, improving accuracy and clarity.
    • Updated the explanation to reflect how balance ratios scale per-iteration time and how this affects the derived SOL TPS.
    • No product functionality or APIs were changed.

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: yunruis <205571022+yunruis@users.noreply.github.com>
@yunruis yunruis requested a review from a team as a code owner August 29, 2025 08:19
@yunruis yunruis requested review from QiJune and Shixiaowei02 August 29, 2025 08:19
@nv-guomingz
Copy link
Collaborator

/bot skip --comment "docs only"

@nv-guomingz nv-guomingz enabled auto-merge (squash) August 29, 2025 08:21
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 29, 2025

📝 Walkthrough

Walkthrough

Updated a documentation formula in docs/source/blogs/tech_blog/blog10_ADP_Balance_Strategy.md: changed sol_time aggregation from a division-based scaling to multiplication by balance_ratio_i; other content unchanged.

Changes

Cohort / File(s) Summary
Docs: SOL time formula correction
docs/source/blogs/tech_blog/blog10_ADP_Balance_Strategy.md
Replaced sol_time = ∑ time_i / balance_ratio_i with sol_time = ∑ time_i * balance_ratio_i; sol_tps definition remains as (elapsed_time / sol_time) * actual_tps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • laikhtewari
✨ Finishing Touches
🧪 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @coderabbitai title anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/source/blogs/tech_blog/blog10_ADP_Balance_Strategy.md (2)

73-75: Use a finite iteration horizon and define it.

Replace the infinite sum with a measured window T and document T in the “where” list. This tightens the definition and avoids implying an unbounded sum.

Apply:

-```math
-sol\_time = \sum_{i=0}^{\infty} time_i * balance\_ratio_i
-```
+```math
+sol\_time = \sum_{i=0}^{T-1} time_i \cdot balance\_ratio_i
+```

And add to the bullets:

 - $sol\_tps$: Theoretical maximum throughput under perfect load balance
+ - $T$: Number of iterations in the measurement window

Also applies to: 81-86


74-79: Clarify what time_i includes (compute-only vs wall-clock with waiting).

Sol_tps comparability across configurations hinges on this. Add a one-line convention so readers know whether waiting/idling is included in time_i (your note later hints it is).

 ```math
 sol\_tps = \frac{elapsed\_time}{sol\_time} \times actual\_tps

where:
+- Measurement convention: $time_i$ is the per-iteration wall-clock step time (including any scheduling-induced idle). Thus, $sol_time$ corrects only for intra-iteration imbalance and not for increased iteration count due to waiting.


Optionally, align the note at Performance Results to reference this convention explicitly.


Also applies to: 220-221

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: Path: .coderabbit.yaml

**Review profile**: CHILL

**Plan**: Pro

**💡 Knowledge Base configuration:**

- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 091b67ad2f4a36ba612484f0cf0d8f45b5511383 and a9d869aa751255d1bab67dfc1a5f804c89c3c2d5.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs/source/blogs/tech_blog/blog10_ADP_Balance_Strategy.md` (1 hunks)

</details>

<details>
<summary>⏰ 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)</summary>

* GitHub Check: Pre-commit Check

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>docs/source/blogs/tech_blog/blog10_ADP_Balance_Strategy.md (1)</summary><blockquote>

`74-75`: **Formula fix is correct (multiply, not divide).**

Given balance_ratio = avg_tokens / max_tokens ∈ (0,1], the per-iteration “speed-of-light” time under perfect balance should be time_i × balance_ratio_i. The updated equation aligns with that definition.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@tensorrt-cicd
Copy link
Collaborator

PR_Github #16960 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #16960 [ skip ] completed with state SUCCESS
Skipping testing for commit a9d869a

@nv-guomingz nv-guomingz merged commit f617b03 into NVIDIA:main Aug 29, 2025
8 of 11 checks passed
chang-l pushed a commit to chang-l/TensorRT-LLM that referenced this pull request Sep 2, 2025
Signed-off-by: yunruis <205571022+yunruis@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants