KEMBAR78
[None][doc] Update tech blog12 by syuoni · Pull Request #7884 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@syuoni
Copy link
Collaborator

@syuoni syuoni commented Sep 20, 2025

Summary by CodeRabbit

  • Documentation
    • Updated the tech blog on combining guided and speculative decoding.
    • Enlarged images for improved readability.
    • Added external references and links to related pull requests.
    • Clarified terminology and explanations around CUDA/GIL topics and Python bindings.
    • Tightened descriptions of graph capture, callback behavior, and deadlock scenarios.
    • General editorial polish for clarity and consistency.
    • No functional changes to the product.

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: Enwei Zhu <21126786+syuoni@users.noreply.github.com>
Signed-off-by: Enwei Zhu <21126786+syuoni@users.noreply.github.com>
@syuoni syuoni requested a review from a team as a code owner September 20, 2025 02:33
@syuoni
Copy link
Collaborator Author

syuoni commented Sep 20, 2025

/bot skip --comment "doc changes only"

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 20, 2025

📝 Walkthrough

Walkthrough

Edits to a single documentation blog post update image widths, add explicit external references and PR links, and refine wording around CUDA/GIL topics and bindings. No code, APIs, or data structures changed.

Changes

Cohort / File(s) Change Summary
Docs: Tech blog updates
docs/source/blogs/tech_blog/blog12_Combining_Guided_Decoding_and_Speculative_Decoding.md
Increased figure widths (600→800); added explicit PR links and external references; wording tweaks (e.g., “operators” vs “operations”); refined phrasing on CUDA graph capture, hostFunc/Python bindings, and GIL/deadlock notes; editorial tightening without functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The PR description contains only the repository's template and placeholder text without a filled "Description" or "Test Coverage" section and does not summarize the actual changes to tech_blog12, so it fails to provide the required information reviewers need to evaluate the PR. Required details such as a concise summary of edits, relevant tests or verification steps, and links to related issues/PRs are missing. Because the template was left unfilled this description is incomplete and does not meet the repository's PR template requirements. Please replace the template placeholders with a short Description summarizing the specific edits (files changed, image width updates, added PR references and wording tweaks), list any relevant tests or state that none are needed, confirm checklist items such as documentation/CODEOWNERS updates, and include links or PR/issue numbers referenced so reviewers can verify the changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title "[None][doc] Update tech blog12" follows the repository title template, succinctly indicates a documentation change, and accurately relates to the primary change set (updates to the tech_blog12 documentation such as image size and wording edits). It is concise and clear enough for a reviewer scanning history, though somewhat generic. Overall it reflects the main intent of the changes.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

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.

❤️ Share

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

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/blog12_Combining_Guided_Decoding_and_Speculative_Decoding.md (2)

3-3: Fix byline formatting to satisfy MD036 (no-emphasis-as-heading).

Avoid an emphasis-only line. Make it plain text to appease markdownlint.

Apply this diff:

-*By NVIDIA TensorRT LLM Team and the XGrammar Team*
+By NVIDIA TensorRT LLM Team and the XGrammar Team

52-52: Add meaningful alt text to all images (MD045).

Improves accessibility and passes markdownlint.

Apply this diff:

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_constrained_decoding_pipeline_overlap.png" width="800">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_constrained_decoding_pipeline_overlap.png" alt="Guided decoding timeline with and without overlapping" width="800">

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_one_model_vs_two_model.png" width="800">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_one_model_vs_two_model.png" alt="GPU timeline of one-model vs two-model speculative decoding" width="800">

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_cpu_gpu_synchronization_for_multiple_steps.png" width="1000">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_cpu_gpu_synchronization_for_multiple_steps.png" alt="CPU–GPU synchronization across multiple steps" width="1000">

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_cpu_gpu_synchronization_for_multiple_steps_by_cuda_callback.png" width="1000">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_cpu_gpu_synchronization_for_multiple_steps_by_cuda_callback.png" alt="CPU–GPU synchronization via CUDA callbacks across multiple steps" width="1000">

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_mode_eval_llama_3.1_8b.png" width="800">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_mode_eval_llama_3.1_8b.png" alt="Pareto curve on JSON Mode Eval for LLaMA 3.1 8B" width="800">

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_mode_eval_llama_3.3_70b.png" width="800">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_mode_eval_llama_3.3_70b.png" alt="Pareto curve on JSON Mode Eval for LLaMA 3.3 70B" width="800">

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_schema_bench_llama_3.1_8b.png" width="800">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_schema_bench_llama_3.1_8b.png" alt="Pareto curve on JSON Schema Bench for LLaMA 3.1 8B" width="800">

-  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_schema_bench_llama_3.3_70b.png" width="800">
+  <img src="https://github.com/NVIDIA/TensorRT-LLM/raw/main/docs/source/blogs/media/tech_blog12_pareto_curve_json_schema_bench_llama_3.3_70b.png" alt="Pareto curve on JSON Schema Bench for LLaMA 3.3 70B" width="800">

Also applies to: 65-65, 86-86, 142-142, 264-264, 272-272, 283-283, 290-290

📜 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 2e317a7 and 5cf9170.

📒 Files selected for processing (1)
  • docs/source/blogs/tech_blog/blog12_Combining_Guided_Decoding_and_Speculative_Decoding.md (8 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-20T07:43:36.447Z
Learnt from: ChristinaZ
PR: NVIDIA/TensorRT-LLM#7068
File: cpp/tensorrt_llm/kernels/moeTopKFuncs.cuh:169-172
Timestamp: 2025-08-20T07:43:36.447Z
Learning: In TensorRT-LLM MOE kernels, when processing up to 128 experts across 32 threads, each thread handles at most 4 experts (N < 5 constraint), where N represents candidates per thread rather than total system capacity.

Applied to files:

  • docs/source/blogs/tech_blog/blog12_Combining_Guided_Decoding_and_Speculative_Decoding.md
🪛 markdownlint-cli2 (0.18.1)
docs/source/blogs/tech_blog/blog12_Combining_Guided_Decoding_and_Speculative_Decoding.md

3-3: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


52-52: Images should have alternate text (alt text)

(MD045, no-alt-text)


65-65: Images should have alternate text (alt text)

(MD045, no-alt-text)


86-86: Images should have alternate text (alt text)

(MD045, no-alt-text)


142-142: Images should have alternate text (alt text)

(MD045, no-alt-text)


264-264: Images should have alternate text (alt text)

(MD045, no-alt-text)


272-272: Images should have alternate text (alt text)

(MD045, no-alt-text)


283-283: Images should have alternate text (alt text)

(MD045, no-alt-text)


290-290: Images should have alternate text (alt text)

(MD045, no-alt-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). (2)
  • GitHub Check: Check PR Checklist Resolution
  • GitHub Check: Pre-commit Check
🔇 Additional comments (1)
docs/source/blogs/tech_blog/blog12_Combining_Guided_Decoding_and_Speculative_Decoding.md (1)

250-252: Wording LGTM — upstream issue/PR statuses verified; qualify with "as of September 20, 2025".

  • pytorch/pytorch#163061 — open (torch.compile kernels called with GIL held; deadlock risk with CUDA hostfunc callbacks).
  • pytorch/pytorch#163062 — open (implicit/synced D2H copy performed with the GIL held).
  • NVIDIA/TensorRT-LLM PR #7871 — open (created/edited Sep 19, 2025; disables torch.compile for CapturableGuidedDecoder; references pytorch#163061).
  • NVIDIA/TensorRT-LLM PR #6948 — merged Sep 3, 2025 (adds CapturableGuidedDecoder and enables GIL releases in some C++ bindings).

Add "as of September 20, 2025" to the paragraph (docs/source/blogs/tech_blog/blog12_Combining_Guided_Decoding_and_Speculative_Decoding.md lines 250–252) or update the links/statuses just before publishing.

@tensorrt-cicd
Copy link
Collaborator

PR_Github #19389 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #19389 [ skip ] completed with state SUCCESS
Skipping testing for commit 5cf9170

@juney-nvidia juney-nvidia merged commit e943a39 into NVIDIA:main Sep 20, 2025
8 of 9 checks passed
MrGeva pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Sep 21, 2025
Signed-off-by: Enwei Zhu <21126786+syuoni@users.noreply.github.com>
@syuoni syuoni deleted the update-tech-blog12 branch September 22, 2025 02:41
nv-lschneider pushed a commit to nv-lschneider/TensorRT-LLM that referenced this pull request Sep 22, 2025
Signed-off-by: Enwei Zhu <21126786+syuoni@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