KEMBAR78
[None][doc] update feature_combination_matrix doc by leslie-fang25 · Pull Request #6691 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@leslie-fang25
Copy link
Collaborator

@leslie-fang25 leslie-fang25 commented Aug 7, 2025

Summary by CodeRabbit

  • Documentation
    • Updated the compatibility matrix to reflect the latest support statuses for "KV Cache Reuse" and "Slide Window Attention" features.

Description

This PR mainly update the feature combination matrix:

  • Mark MTP with KV Cache Reuse as Yes
  • Mark MTP with SWA as No
    • When add the mtp_config = MTPDecodingConfig(num_nextn_predict_layers=2)to case test_llm_api_pytorch.py::TestGemma3_1BInstruct::test_auto_dtype got the error msg as AttributeError: 'Gemma3TextConfig' object has no attribute 'num_nextn_predict_layers'
  • Mark Overlap Scheduler with Logits Post Processor as Yes
    • Covered by test case python -u -m pytest -s -v tests/unittest/llmapi/test_llm_pytorch.py -k test_tinyllama_logits_processor[False]
  • Mark SWA with chunked prefill as Yes
    • Covered by testing python -u -m pytest -s -v tests/integration/defs/accuracy/test_llm_api_pytorch.py::TestGemma3_1BInstruct::test_auto_dtype_chunked_prefill
  • Mark Eagle3 two model with KV Cache reuse as Yes

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.

@leslie-fang25 leslie-fang25 requested a review from a team as a code owner August 7, 2025 08:03
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 7, 2025

📝 Walkthrough

Walkthrough

Updated the Torch features compatibility matrix in documentation: changed several entries for "KV Cache Reuse", "Slide Window Attention", "Logits Post Processor (Overlap Scheduler)", and one "Torch Sampler" cell to reflect new compatibility statuses. No code or public API changes.

Changes

Cohort / File(s) Change Summary
Documentation compatibility matrix
docs/source/torch/features/feature_combination_matrix.md
Updated table entries: KV Cache Reuse statuses changed for MTP (Untested→Yes), EAGLE-3 (One Model Engine: Untested→Yes), EAGLE-3 (Two Model Engine: No→Yes); Slide Window Attention entries changed (Chunked Prefill: Untested→No; MTP: Untested→No); Logits Post Processor (Overlap Scheduler) changed No→Yes; one Torch Sampler cell changed Yes→No. Other rows unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

Documentation

Suggested reviewers

  • yilin-void
  • QiJune
  • kaiyux

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 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 9f6aa0e and b3b759b.

📒 Files selected for processing (1)
  • docs/source/torch/features/feature_combination_matrix.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/source/torch/features/feature_combination_matrix.md
✨ 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 @coderabbitai in a new review comment at the desired location with your query.
  • 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 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 @coderabbitai help to get the list of available commands.

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.

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.

@leslie-fang25 leslie-fang25 requested a review from QiJune August 7, 2025 08:03
@leslie-fang25
Copy link
Collaborator Author

/bot run

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 (1)
docs/source/torch/features/feature_combination_matrix.md (1)

15-15: Add a reproducible reference for the new “Yes” claim

The matrix now lists “Yes” for KV Cache Reuse × MTP, but the reader has no citation or foot-note to understand how this was validated (e.g., the cache_hit_rate > 0 check in py_executor.py).
Consider appending a short foot-note or link to the exact test so others can reproduce the evidence behind the status.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0a467b0 and 9f6aa0e.

📒 Files selected for processing (1)
  • docs/source/torch/features/feature_combination_matrix.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: zhengd-nv
PR: NVIDIA/TensorRT-LLM#6633
File: cpp/tensorrt_llm/batch_manager/dataTransceiverImpl.cpp:145-155
Timestamp: 2025-08-06T08:18:28.669Z
Learning: In cpp/tensorrt_llm/batch_manager/dataTransceiverImpl.cpp, the existing `mMtxForMap` mutex in DataSenderImpl is sufficient to synchronize measurement file operations in the `release` method, as all file operations occur within the same critical section that protects the `mRequestToSession` map access.
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 testing, it's common to have both cli flow tests (test_cli_flow.py) and pytorch api ...
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.

Applied to files:

  • docs/source/torch/features/feature_combination_matrix.md
🔇 Additional comments (1)
docs/source/torch/features/feature_combination_matrix.md (1)

16-16: Clarify the reason for the “No” status or keep it “Untested”

Slide Window Attention × MTP changed from “Untested” to “No”, yet the PR description only states that this combination errors out due to a missing num_nextn_predict_layers attribute.
If the incompatibility is definitive, add a brief foot-note explaining the failure; otherwise, revert to “Untested” until the root cause is resolved.

@tensorrt-cicd
Copy link
Collaborator

PR_Github #14423 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@leslie-fang25 leslie-fang25 changed the title [None][doc] update feature_combination_matrix of MTP [None][doc] update feature_combination_matrix doc Aug 14, 2025
@leslie-fang25 leslie-fang25 force-pushed the leslie/update_mtp_feature_combination branch from b3b759b to e4965c5 Compare August 14, 2025 06:28
@leslie-fang25
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15288 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@leslie-fang25 leslie-fang25 force-pushed the leslie/update_mtp_feature_combination branch from e5a0354 to c04663c Compare August 15, 2025 02:39
@leslie-fang25
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15395 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@QiJune QiJune requested a review from mikeiovine August 15, 2025 07:11
Signed-off-by: leslie-fang25 <leslief@nvidia.com>
@leslie-fang25 leslie-fang25 force-pushed the leslie/update_mtp_feature_combination branch from 7b190ed to bd879ce Compare August 20, 2025 09:49
@leslie-fang25
Copy link
Collaborator Author

@mikeiovine could you please double confirm if kv cache reuse can work with eagle-3 two model engine?

Hi @mikeiovine, sorry for the interruption. When you have a moment, could you please review this PR especially for the change of kv cache reuse with eagle-3 two model case?

@leslie-fang25
Copy link
Collaborator Author

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15908 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@leslie-fang25 leslie-fang25 requested a review from QiJune August 26, 2025 00:05
Copy link
Collaborator

@QiJune QiJune left a comment

Choose a reason for hiding this comment

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

LGTM

@leslie-fang25 leslie-fang25 merged commit 9df15b2 into NVIDIA:main Aug 26, 2025
5 checks passed
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