[TRTLLM-7918][feat] Support kvcache reuse for phi4mm #7563
Conversation
📝 WalkthroughWalkthroughUpdated Phi4MMInputProcessor to also inherit from BaseMultimodalInputProcessor and added three public API methods: get_vocab_size, get_mm_token_ids, and get_num_tokens_per_image. Implementations return model_config.vocab_size, a tensor of multimodal special token IDs on the correct device, and computed image token counts via a dummy PIL image, respectively. Changes
Sequence Diagram(s)Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
tensorrt_llm/_torch/models/modeling_phi4mm.py (1)
1-1: Add NVIDIA Apache-2.0 header.Per repository guidelines, prepend the 2025 NVIDIA Apache-2.0 header at the top of this source file.
+ # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved. + # + # Licensed under the Apache License, Version 2.0 (the "License"); + # you may not use this file except in compliance with the License. + # You may obtain a copy of the License at + # http://www.apache.org/licenses/LICENSE-2.0 + # + # Unless required by applicable law or agreed to in writing, software + # distributed under the License is distributed on an "AS IS" BASIS, + # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + # See the License for the specific language governing permissions and + # limitations under the License.
🧹 Nitpick comments (3)
tensorrt_llm/_torch/models/modeling_phi4mm.py (3)
22-23: Import location for BaseMultimodalInputProcessor.Confirm that BaseMultimodalInputProcessor is re-exported from tensorrt_llm.inputs. If not, import it from tensorrt_llm.inputs.registry to avoid import errors and to be explicit.
-from ...inputs import (BaseMultimodalInputProcessor, ExtraProcessedInputs, - InputProcessor, MultimodalPlaceholderMetadata, +from ...inputs import (ExtraProcessedInputs, InputProcessor, MultimodalPlaceholderMetadata, MultimodalPlaceholderPlacement, TextPrompt, register_input_processor) +from ...inputs.registry import BaseMultimodalInputProcessor
418-420: Minor: cast vocab_size to int or rely on base implementation.Return an int to avoid downstream type surprises. Alternatively, remove this override and use BaseMultimodalInputProcessor.get_vocab_size.
- def get_vocab_size(self) -> Optional[int]: - return self.model_config.vocab_size + def get_vocab_size(self) -> Optional[int]: + return int(self.model_config.vocab_size)
421-425: Scope check: only image modality is claimed supported.PR description says only image is supported; returning audio token id here could confuse downstream chunked_prefill logic if it is modality-aware. If audio isn’t supported yet, consider returning only the image token or confirm that downstream safely ignores unused ids.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
tensorrt_llm/_torch/models/modeling_phi4mm.py(3 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{h,hpp,hh,hxx,cpp,cxx,cc,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Use only spaces, no tabs; indent with 4 spaces.
Files:
tensorrt_llm/_torch/models/modeling_phi4mm.py
**/*.py
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
**/*.py: Python code must target Python 3.8+.
Indent Python code with 4 spaces; do not use tabs.
Maintain module namespace when importing; prefer 'from package.subpackage import foo' then 'foo.SomeClass()' instead of importing the class directly.
Python filenames should be snake_case (e.g., some_file.py).
Python classes use PascalCase names.
Functions and methods use snake_case names.
Local variables use snake_case; prefix 'k' for variables that start with a number (e.g., k_99th_percentile).
Global variables use upper SNAKE_CASE prefixed with 'G' (e.g., G_MY_GLOBAL).
Constants use upper SNAKE_CASE (e.g., MY_CONSTANT).
Avoid shadowing variables from an outer scope.
Initialize all externally visible members of a class in the constructor.
Prefer docstrings for interfaces that may be used outside a file; comments for in-function or file-local interfaces.
Use Google-style docstrings for classes and functions (Sphinx-parsable).
Document attributes and variables inline so they render under the class/function docstring.
Avoid reflection when a simpler, explicit approach suffices (e.g., avoid dict(**locals()) patterns).
In try/except, catch the most specific exceptions possible.
For duck-typing try/except, keep the try body minimal and use else for the main logic.
Files:
tensorrt_llm/_torch/models/modeling_phi4mm.py
**/*.{cpp,cxx,cc,h,hpp,hh,hxx,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Prepend the NVIDIA Apache-2.0 copyright header with current year to the top of all source files (e.g., .cpp, .h, .cu, .py).
Files:
tensorrt_llm/_torch/models/modeling_phi4mm.py
🧬 Code graph analysis (1)
tensorrt_llm/_torch/models/modeling_phi4mm.py (1)
tensorrt_llm/inputs/registry.py (4)
BaseMultimodalInputProcessor(44-160)get_vocab_size(63-83)get_mm_token_ids(85-97)get_num_tokens_per_image(114-131)
⏰ 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
🔇 Additional comments (1)
tensorrt_llm/_torch/models/modeling_phi4mm.py (1)
392-392: Inheritance order is correct.Placing BaseMultimodalInputProcessor first ensures its default multimodal helpers are available via MRO. Looks good.
|
/bot run |
|
PR_Github #17775 [ run ] triggered by Bot |
|
PR_Github #17775 [ run ] completed with state |
|
@Wanli-Jiang Since you already made most of changes needed for enabling kv cache reuse, can you also add kv cache reuse support in this PR (w/ necessary tests) in this PR? Thanks. |
chang-l
changed the title
Wanli-Jiang
force-pushed
the
user/williamj/phi4mm-input-with-hash
branch
from
4b2525e to
15c220c
Compare
Wanli-Jiang
force-pushed
the
user/williamj/phi4mm-input-with-hash
branch
from
15c220c to
18848d8
Compare
|
/bot run |
|
PR_Github #18335 [ run ] triggered by Bot |
|
PR_Github #18335 [ run ] completed with state |
Wanli-Jiang
force-pushed
the
user/williamj/phi4mm-input-with-hash
branch
from
18848d8 to
f0d59ac
Compare
|
/bot run --disable-fail-fast |
|
PR_Github #18349 [ run ] triggered by Bot |
Wanli-Jiang
changed the title
|
PR_Github #18349 [ run ] completed with state |
|
/bot run --disable-fail-fast |
|
PR_Github #18435 [ run ] triggered by Bot |
|
PR_Github #18435 [ run ] completed with state |
* Only support image modality. * Audio modality is not supported yet. Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
Wanli-Jiang
force-pushed
the
user/williamj/phi4mm-input-with-hash
branch
from
f0d59ac to
2a57fb6
Compare
|
/bot reuse-pipeline |
|
PR_Github #18588 [ reuse-pipeline ] triggered by Bot |
|
PR_Github #18588 [ reuse-pipeline ] completed with state |
Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
…7563)" (NVIDIA#7722) Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
…7563)" (NVIDIA#7722) Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
5 participants
Summary by CodeRabbit
New Features
Refactor
Notes
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 thestage-listparameter 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.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip 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-pipelineReuse 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.