Skip to content

[None][doc] Add doc for multimodal feature support matrix #6619

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

Merged
merged 4 commits into from
Aug 8, 2025

Conversation

chang-l
Copy link
Collaborator

@chang-l chang-l commented Aug 5, 2025

Summary by CodeRabbit

  • Documentation
    • Added a new document outlining the feature support matrix for various multimodal models using the PyTorch backend, detailing support for CUDA Graph, Encoder IFB, KV Cache Reuse, and Chunked Prefill.

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.

Copy link
Contributor

coderabbitai bot commented Aug 5, 2025

📝 Walkthrough

Walkthrough

A new documentation file was introduced, presenting a feature support matrix for multimodal models in the PyTorch backend. The matrix lists nine models and their support status for four specific features, using a tabular format to indicate whether each model supports each feature.

Changes

Cohort / File(s) Change Summary
New Multimodal Feature Support Matrix Doc
docs/source/reference/multimodal-feature-support-matrix.md
Added a markdown document detailing feature support (CUDA Graph, Encoder IFB, KV Cache Reuse, Chunked Prefill) across nine multimodal models for the PyTorch backend.

Sequence Diagram(s)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

Documentation

Suggested reviewers

  • amukkara
  • nv-guomingz

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.


📜 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 1a9e6e1 and 376f26f.

📒 Files selected for processing (1)
  • docs/source/reference/multimodal-feature-support-matrix.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/source/reference/multimodal-feature-support-matrix.md
⏰ 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 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: 0

🧹 Nitpick comments (3)
docs/source/reference/multimodal-feature-support-matrix.md (3)

3-4: Clarify column names & abbreviations for self-contained readability

“CUDA Graph” is usually referred to in plural form (“CUDA Graphs”) throughout the TensorRT-LLM docs, and “IFB w/ SharedTensor” is an internal shorthand that external readers may not understand. Consider renaming for consistency and adding an inline footnote or parenthetical expansion (e.g., “Incremental Forward Buffer (IFB) w/ SharedTensor”) to avoid forcing readers to hunt for definitions.

-| Model              | CUDA Graph | IFB w/ SharedTensor | KV Cache Reuse | Chunked Prefill |
+| Model              | CUDA Graphs | IFB (Incremental Forward Buffer) w/ SharedTensor | KV Cache Reuse | Chunked Prefill |

5-13: Add “Last-verified” disclaimer to reduce future staleness risk

Support status can drift quickly as back-ends evolve. Adding a lightweight “Last verified” note (date + TensorRT-LLM commit) below the table makes it clear when the matrix was accurate and reminds maintainers to update it.

 | Qwen2.5-VL         | Yes        | Yes                 | Yes            | No              |
 |
+> **Last verified:** 2025-08-xx against commit `<short-sha>`. Please update after any multimodal feature changes.

5-13: Alphabetise model list for easier scanning

Ordering models alphabetically (or by release date) improves discoverability. At the moment “Gemma 3” appears before “HyperCLOVA” but “Mistral” is after “Llama 4”. Consider sorting or documenting the chosen ordering scheme.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between db51ab1 and e07a970.

📒 Files selected for processing (1)
  • docs/source/reference/multimodal-feature-support-matrix.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: moraxu
PR: NVIDIA/TensorRT-LLM#6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
📚 Learning: in tensorrt-llm's multimodal processing pipeline, shared tensor recovery using `from_shared_tensor()...
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:

  • docs/source/reference/multimodal-feature-support-matrix.md
⏰ 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

@chang-l chang-l requested a review from 2ez4bz August 5, 2025 05:50
Copy link
Collaborator

@brb-nv brb-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

@chang-l chang-l requested review from a team, kaiyux and Shixiaowei02 and removed request for a team August 5, 2025 22:16
@chang-l chang-l requested a review from a team as a code owner August 5, 2025 22:57
Copy link
Collaborator

@nv-guomingz nv-guomingz left a comment

Choose a reason for hiding this comment

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

LGTM

@chang-l chang-l force-pushed the add_mm_feature_doc branch from 46c0f7c to 26eaea8 Compare August 6, 2025 04:07
@chang-l chang-l changed the title [None][Doc] Add doc for multimodal feature support matrix [None][doc] Add doc for multimodal feature support matrix Aug 6, 2025
@chang-l chang-l force-pushed the add_mm_feature_doc branch from 26eaea8 to 8460f55 Compare August 6, 2025 04:45
@nv-guomingz
Copy link
Collaborator

@chang-l Does this PR need to be cherry-picked into release/1.0 branch?

@chang-l
Copy link
Collaborator Author

chang-l commented Aug 7, 2025

/bot run --stage-list "A10-Build-docs"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14497 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14497 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #10950 (Partly Tested) completed with status: 'FAILURE'

@nv-guomingz
Copy link
Collaborator

/bot skip --comment "docs only"

@nv-guomingz nv-guomingz enabled auto-merge (squash) August 8, 2025 03:54
@tensorrt-cicd
Copy link
Collaborator

PR_Github #14556 [ skip ] triggered by Bot

@chang-l chang-l force-pushed the add_mm_feature_doc branch 3 times, most recently from ad1fbb3 to 5307956 Compare August 8, 2025 04:10
@tensorrt-cicd
Copy link
Collaborator

PR_Github #14556 [ skip ] completed with state SUCCESS
Skipping testing for commit 314c5e5

chang-l added 4 commits August 8, 2025 13:41
Signed-off-by: Chang Liu (Enterprise Products) [email protected]
Signed-off-by: Chang Liu <[email protected]>
Signed-off-by: Chang Liu (Enterprise Products) [email protected]
Signed-off-by: Chang Liu <[email protected]>
Signed-off-by: Chang Liu (Enterprise Products) [email protected]
Signed-off-by: Chang Liu <[email protected]>
Signed-off-by: Chang Liu (Enterprise Products) [email protected]
Signed-off-by: Chang Liu <[email protected]>
@nv-guomingz
Copy link
Collaborator

/bot skip --comment "docs only"

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14565 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14565 [ skip ] completed with state SUCCESS
Skipping testing for commit da000d3

@nv-guomingz nv-guomingz merged commit 9687bb4 into NVIDIA:main Aug 8, 2025
4 checks passed
nv-guomingz pushed a commit to nv-guomingz/TensorRT-LLM that referenced this pull request Aug 8, 2025
nv-guomingz added a commit that referenced this pull request Aug 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants