Skip to content

Conversation

@stnie
Copy link
Collaborator

@stnie stnie commented Jul 8, 2025

Description

CI/refactor: Speedup beam search unit tests with fixtures for LLMs, prompts and expected outputs

  • Introduced pytest fixtures for input prompts and expected outputs to improve test readability and maintainability.

  • Refactored the test function to utilize these fixtures, simplifying the parameter list and enhancing clarity.

  • Introduced pytest fixture for LLM to skip rebuilding LLM for each test

  • disabled threadleak to prevent failure, due to LLM not being shutdown after each test

  • Updated assertions to ensure correct behavior of the beam search output shapes.

  • updated small issues related to beam search

  • Throw NotImplemented Error, when beam search is executed with CUDA Graph

  • Fix Indexing Error in cum_log_probs

Test Coverage

test_beam_search.py

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.

Details

run [--disable-fail-fast --skip-test --stage-list "A10-1, xxx" --gpu-type "A30, H100_PCIe" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-[Post-Merge]-1, xxx"]

Launch build/test pipelines. All previously running jobs will be killed.

--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-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-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.

--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. Will also run 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-[Post-Merge]-1, xxx" (OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-[Post-Merge]-1, xxx".

For guidance on mapping tests to stage names, see docs/source/reference/ci-overview.md.

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.

Summary by CodeRabbit

  • Bug Fixes

    • Added a runtime check to prevent using CUDA Graphs with beam search, improving error handling and stability.
    • Corrected cumulative log probability handling for multi-beam scenarios to ensure accurate results.
  • Tests

    • Refactored beam search tests to use reusable fixtures, reducing redundancy and improving test clarity.

@stnie stnie force-pushed the develop/update_test_beam_search branch from 184fbe3 to 6d6cc02 Compare July 8, 2025 11:04
@stnie
Copy link
Collaborator Author

stnie commented Jul 8, 2025

/bot run --stage-list "A30-PyTorch-1"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11292 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11292 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #8350 (Partly Tested) completed with status: 'SUCCESS'

@stnie stnie force-pushed the develop/update_test_beam_search branch from 6d6cc02 to b3bdf4b Compare July 15, 2025 12:20
@stnie
Copy link
Collaborator Author

stnie commented Jul 15, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11941 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11941 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #8859 completed with status: 'FAILURE'

@stnie
Copy link
Collaborator Author

stnie commented Jul 15, 2025

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11956 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #11956 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #8873 completed with status: 'SUCCESS'
Pipeline passed with automatic retried tests. Check the rerun report for details.

@stnie stnie marked this pull request as ready for review July 16, 2025 07:14
@stnie stnie requested a review from a team as a code owner July 16, 2025 07:14
@stnie stnie requested review from Funatiq, Naveassaf and omera-nv July 16, 2025 07:14
Copy link
Collaborator

@omera-nv omera-nv left a comment

Choose a reason for hiding this comment

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

LGTM test-wise: the tests are now 48secs instead of 10mins, great work :)

@stnie stnie force-pushed the develop/update_test_beam_search branch from b3bdf4b to 44a5d25 Compare July 17, 2025 10:21
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 17, 2025

"""

Walkthrough

The changes introduce a runtime check in the model engine to prevent the use of CUDA Graphs with beam search, adjust the way cumulative log probabilities are accessed in the sampler, and refactor beam search tests to use pytest fixtures for modularity and clarity. No public API signatures are altered.

Changes

File(s) Change Summary
tensorrt_llm/_torch/pyexecutor/model_engine.py Added a runtime check to disallow CUDA Graphs when beam width > 1; removed a trailing blank line.
tensorrt_llm/_torch/pyexecutor/sampler.py Changed cumulative log probability access from flat to 2D indexing in sampler logic.
tests/unittest/_torch/test_beam_search.py Refactored tests to use pytest fixtures, modularized parameters, and streamlined test logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PyTorchModelEngine
    participant CUDA_Graphs

    User->>PyTorchModelEngine: Initialize with config (may enable CUDA Graphs, set beam width)
    PyTorchModelEngine->>PyTorchModelEngine: Check if CUDA Graphs enabled and beam width > 1
    alt Invalid combination
        PyTorchModelEngine-->>User: Raise NotImplementedError
    else Valid configuration
        PyTorchModelEngine-->>User: Proceed with initialization
    end
Loading

Suggested reviewers

  • yilin-void
  • symphonylyh

Poem

In fields of code where rabbits hop,
A sampler’s logic gets a swap.
CUDA Graphs and beams don’t mix—
The engine now throws errors quick!
Pytest fixtures in a row,
Make tests more clear—onward we go!
🐇✨
"""


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26fc029 and 561657f.

📒 Files selected for processing (3)
  • tensorrt_llm/_torch/pyexecutor/model_engine.py (1 hunks)
  • tensorrt_llm/_torch/pyexecutor/sampler.py (1 hunks)
  • tests/unittest/_torch/test_beam_search.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • tensorrt_llm/_torch/pyexecutor/sampler.py
  • tensorrt_llm/_torch/pyexecutor/model_engine.py
  • tests/unittest/_torch/test_beam_search.py
⏰ 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
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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 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.

@stnie stnie force-pushed the develop/update_test_beam_search branch from 44a5d25 to 7d25f49 Compare July 17, 2025 10:22
@stnie
Copy link
Collaborator Author

stnie commented Jul 17, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #12198 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #12198 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #9060 completed with status: 'FAILURE'

@stnie stnie force-pushed the develop/update_test_beam_search branch from 7d25f49 to 26fc029 Compare July 17, 2025 15:48
@stnie
Copy link
Collaborator Author

stnie commented Jul 17, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #12216 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #12216 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #9071 completed with status: 'FAILURE'

…ts and expected outputs

- Introduced pytest fixtures for input prompts and expected outputs to improve test readability and maintainability.
- Refactored the test function to utilize these fixtures, simplifying the parameter list and enhancing clarity.
- Introduced pytest fixture for LLM to skip rebuilding LLM for each test
- disabled threadleak to prevent failure, due to LLM not being shutdown after each test
- Updated assertions to ensure correct behavior of the beam search output shapes.

Signed-off-by: Stefan Niebler <[email protected]>
stnie added 2 commits July 18, 2025 09:19
- Added a NotImplementedError to raise an exception if CUDA Graph is enabled with a max beam width greater than 1, indicating that this combination is not yet supported.
- Corrected the indexing for cumulative log probabilities in the sampler to ensure proper data access.
- Updated the LLM fixture in unit tests to use a dynamic max batch size based on input prompts, improving memory management and preventing potential data access issues.

Signed-off-by: Stefan Niebler <[email protected]>
- enabled similarity check if less than max_beam_width outputs are returned.
- moved KvCacheConfig into the llm fixture

Signed-off-by: Stefan Niebler <[email protected]>
@stnie stnie force-pushed the develop/update_test_beam_search branch from 26fc029 to 561657f Compare July 18, 2025 07:19
@stnie
Copy link
Collaborator Author

stnie commented Jul 18, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #12295 [ run ] triggered by Bot

@stnie stnie enabled auto-merge (squash) July 18, 2025 13:09
@tensorrt-cicd
Copy link
Collaborator

PR_Github #12295 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #9131 completed with status: 'SUCCESS'

@stnie stnie merged commit fd6ce7f into NVIDIA:main Jul 18, 2025
3 checks passed
reasonsolo pushed a commit to reasonsolo/TensorRT-LLM that referenced this pull request Jul 21, 2025
timlee0212 pushed a commit to timlee0212/TensorRT-LLM that referenced this pull request Jul 21, 2025
NVShreyas pushed a commit to NVShreyas/TensorRT-LLM that referenced this pull request Jul 28, 2025
@stnie stnie deleted the develop/update_test_beam_search branch September 9, 2025 08:37
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.

4 participants