Skip to content

[None][chore] Guided decoding fixes and benchmarking #6752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

syuoni
Copy link
Collaborator

@syuoni syuoni commented Aug 8, 2025

Summary by CodeRabbit

  • New Features

    • Added support for guided decoding parameters in inference requests and dataset creation.
    • Benchmark request data is now exported to a JSON Lines file after evaluation, including guided decoding parameters when present.
  • Bug Fixes

    • Improved handling of draft requests and CUDA graph dummy requests during guided decoding.
  • Chores

    • Ensured tokenizer initialization is not skipped during throughput benchmarking.

Description

Test Coverage

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.

syuoni added 2 commits August 8, 2025 08:56
Signed-off-by: Enwei Zhu <[email protected]>
Signed-off-by: Enwei Zhu <[email protected]>
Copy link
Contributor

coderabbitai bot commented Aug 8, 2025

📝 Walkthrough

Walkthrough

The changes introduce and propagate a new optional guided_decoding_params field in inference request data structures and dataset utilities, update the handling of guided decoding parameters in asynchronous request processing, and add logic to serialize benchmark requests with guided decoding information. Additionally, minor logic adjustments are made to draft request handling and assertion checks in the guided decoder.

Changes

Cohort / File(s) Change Summary
Guided Decoder Logic Adjustments
tensorrt_llm/_torch/pyexecutor/guided_decoder.py
Refined _require_matcher_advance to only return True for draft requests in specific states; relaxed assertion in execute to allow cumulative offset ≤ logits size, accommodating dummy logits for CUDA graph dummy requests.
Benchmark Throughput Argument Handling
tensorrt_llm/bench/benchmark/throughput.py
Explicitly sets 'skip_tokenizer_init' to False in ignore_trt_only_args to ensure tokenizer initialization occurs during throughput benchmarking.
Asynchronous Guided Decoding Propagation
tensorrt_llm/bench/benchmark/utils/asynchronous.py
Sets sampling_params.guided_decoding from request.guided_decoding_params within LlmManager.process_request, enabling propagation of guided decoding parameters during asynchronous request processing.
Inference Request Data Model Update
tensorrt_llm/bench/dataclasses/general.py
Adds optional guided_decoding_params: Optional[GuidedDecodingParams] = None to the InferenceRequest dataclass and imports GuidedDecodingParams.
Dataset Creation with Guided Decoding
tensorrt_llm/bench/utils/data.py
Extends create_dataset_from_stream to parse, store, and include guided_decoding_params from JSON input, passing them into constructed InferenceRequest objects.
Benchmark Request Serialization
tensorrt_llm/evaluate/interface.py
Updates Evaluator.evaluate to write benchmark request data (including guided decoding parameters, if present) to a bench_requests.jsonl file after evaluation, serializing relevant fields for each repeated output.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DatasetLoader
    participant InferenceRequest
    participant LlmManager
    participant Evaluator

    User->>DatasetLoader: Provide JSON stream (may include guided_decoding_params)
    DatasetLoader->>InferenceRequest: Create with guided_decoding_params (if present)
    User->>LlmManager: Submit InferenceRequest
    LlmManager->>LlmManager: Set sampling_params.guided_decoding from request.guided_decoding_params
    User->>Evaluator: Run evaluate
    Evaluator->>Evaluator: Serialize requests (incl. guided_decoding_params) to bench_requests.jsonl
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Possibly related PRs

Suggested labels

Community want to contribute

Suggested reviewers

  • yilin-void
  • HuiGao-NV

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ 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
🪧 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.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai 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:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai 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 comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

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

Documentation and Community

  • 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: 5

🔭 Outside diff range comments (1)
tensorrt_llm/bench/utils/data.py (1)

1-1: Add NVIDIA copyright header to tensorrt_llm/bench/utils/data.py

Per project guidelines (see CODING_GUIDELINES.md), all non-test source files (*.py, *.cpp, etc.) must begin with the standard NVIDIA copyright header including the current year.

• File to update:

  • tensorrt_llm/bench/utils/data.py (currently starts with import json)

Suggested diff (insert at the very top of the file):

+# -----------------------------------------------------------------------------
+# Copyright (c) 2025 NVIDIA Corporation.  All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------------
+
 import json
🧹 Nitpick comments (3)
tensorrt_llm/bench/benchmark/throughput.py (1)

385-390: Hard-forcing skip_tokenizer_init=False may override user intent

runtime_config.get_llm_args() can already carry a user-chosen skip_tokenizer_init. Unconditionally resetting it ignores CLI/YAML knobs and makes future debugging harder.

Consider only defaulting when the key is absent:

- kwargs['skip_tokenizer_init'] = False
+ kwargs.setdefault('skip_tokenizer_init', False)
tensorrt_llm/evaluate/interface.py (1)

110-126: Bench-request dump is convenient but unbounded

Repeating every output 100 × can create very large files for sizeable datasets and is impossible to disable.

Suggest making num_repeats a parameter (default = 1) or guarding with an env var.

tensorrt_llm/bench/utils/data.py (1)

47-59: Document the new input JSON key in the function docstring

The function now accepts “guided_decoding_params” from the input JSON lines. Please update the docstring to document this optional key and note it is unpacked into a GuidedDecodingParams instance.

I can draft the docstring update with a short example referencing the accepted fields from GuidedDecodingParams if you’d like.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ebdc43e and 26d0ddf.

📒 Files selected for processing (6)
  • tensorrt_llm/_torch/pyexecutor/guided_decoder.py (2 hunks)
  • tensorrt_llm/bench/benchmark/throughput.py (1 hunks)
  • tensorrt_llm/bench/benchmark/utils/asynchronous.py (1 hunks)
  • tensorrt_llm/bench/dataclasses/general.py (2 hunks)
  • tensorrt_llm/bench/utils/data.py (5 hunks)
  • tensorrt_llm/evaluate/interface.py (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.py

📄 CodeRabbit Inference Engine (CODING_GUIDELINES.md)

**/*.py: Python code should conform to Python 3.8+.
Indent Python code with 4 spaces. Do not use tabs.
Always maintain the namespace when importing in Python, even if only one class or function from a module is used.
Python filenames should use snake_case (e.g., some_file.py).
Python classes should use PascalCase (e.g., class SomeClass).
Python functions and methods should use snake_case (e.g., def my_awesome_function():).
Python local variables should use snake_case. Prefix k for variable names that start with a number (e.g., k_99th_percentile).
Python global variables should use upper snake_case and prefix G (e.g., G_MY_GLOBAL).
Python constants should use upper snake_case (e.g., MY_CONSTANT).
Avoid shadowing variables declared in an outer scope in Python.
Initialize all externally visible members of a Python class in the constructor.
For interfaces that may be used outside a Python file, prefer docstrings over comments.
Comments in Python should be reserved for code within a function, or interfaces that are local to a file.
Use Google style docstrings for Python classes and functions, which can be parsed by Sphinx.
Attributes and variables in Python can be documented inline; attribute docstrings will be rendered under the class docstring.
Avoid using reflection in Python when functionality can be easily achieved without it.
When using try-except blocks in Python, limit the except to the smallest set of errors possible.
When using try-except blocks to handle multiple possible variable types in Python, keep the body of the try as small as possible, using the else block to implement the logic.

Files:

  • tensorrt_llm/bench/benchmark/utils/asynchronous.py
  • tensorrt_llm/bench/dataclasses/general.py
  • tensorrt_llm/bench/benchmark/throughput.py
  • tensorrt_llm/_torch/pyexecutor/guided_decoder.py
  • tensorrt_llm/evaluate/interface.py
  • tensorrt_llm/bench/utils/data.py
**/*.{cpp,h,hpp,cc,cxx,cu,py}

📄 CodeRabbit Inference Engine (CODING_GUIDELINES.md)

All TensorRT-LLM Open Source Software code should contain an NVIDIA copyright header that includes the current year. This includes .cpp, .h, .cu, .py, and any other source files which are compiled or interpreted.

Files:

  • tensorrt_llm/bench/benchmark/utils/asynchronous.py
  • tensorrt_llm/bench/dataclasses/general.py
  • tensorrt_llm/bench/benchmark/throughput.py
  • tensorrt_llm/_torch/pyexecutor/guided_decoder.py
  • tensorrt_llm/evaluate/interface.py
  • tensorrt_llm/bench/utils/data.py
🧠 Learnings (3)
📚 Learning: 2025-08-08T04:10:18.987Z
Learnt from: djns99
PR: NVIDIA/TensorRT-LLM#6728
File: cpp/tensorrt_llm/plugins/mixtureOfExperts/mixtureOfExpertsPlugin.cpp:966-966
Timestamp: 2025-08-08T04:10:18.987Z
Learning: TensorRT plugins currently don't support padding functionality, and TensorRT is not getting new features (in maintenance mode). This means that duplicating parameters like mExpertHiddenSize in function calls, even with TODO comments, can be acceptable as pragmatic solutions within these constraints.

Applied to files:

  • tensorrt_llm/bench/benchmark/throughput.py
📚 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:

  • tensorrt_llm/bench/benchmark/throughput.py
📚 Learning: 2025-07-22T09:22:14.726Z
Learnt from: yechank-nvidia
PR: NVIDIA/TensorRT-LLM#6254
File: tensorrt_llm/_torch/pyexecutor/model_engine.py:1201-1204
Timestamp: 2025-07-22T09:22:14.726Z
Learning: In TensorRT-LLM's multimodal processing pipeline, shared tensor recovery using `from_shared_tensor()` is only needed during the context phase. Generation requests reuse the already-recovered tensor data and only need to call `strip_for_generation()` to remove unnecessary multimodal data while preserving the recovered tensors. This avoids redundant tensor recovery operations during generation.

Applied to files:

  • tensorrt_llm/_torch/pyexecutor/guided_decoder.py
🔇 Additional comments (4)
tensorrt_llm/bench/dataclasses/general.py (1)

11-28: Addition looks correct

Optional guided_decoding_params is properly typed and imported; no further feedback.

tensorrt_llm/_torch/pyexecutor/guided_decoder.py (2)

82-91: Logic refinement is sound

The draft path now advances the matcher only when (a) finishing context init chunk or (b) in generation. This prevents unnecessary matcher work on intermediate context chunks – good improvement.


196-198: Relaxed assertion could mask real mis-alignment

Allowing offset < logits.size(0) keeps CUDA-graph dummy rows safe, but it also hides genuine bookkeeping errors.
Recommend asserting the exact equality when d2t is None (normal path) and only allow <= when dummies are expected:

if d2t is None:
    assert offset == logits.size(0), "Offset/logits mismatch."
else:
    assert offset <= logits.size(0)
tensorrt_llm/bench/utils/data.py (1)

88-88: LGTM: Accumulator init for guided decoding params

Initialization is consistent with other “all_*” accumulators and keeps list alignment intact.

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.

1 participant