KEMBAR78
[None][chore] add TorchLlmArgs to the connector api by richardhuo-nv · Pull Request #7493 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@richardhuo-nv
Copy link
Collaborator

@richardhuo-nv richardhuo-nv commented Sep 3, 2025

Summary by CodeRabbit

  • New Features
    • KV cache connector now accepts unified LLM configuration parameters, enabling consistent runtime settings across worker and scheduler components.
  • Refactor
    • Public constructors updated to require LLM configuration (and tokens-per-block where applicable). Initialization calls may need updates.
    • Internal creation logic now forwards these settings to all components for alignment.
    • No changes to caching behavior or control flow; existing functionality remains the same.

Description

Given that executor_config is being deprecated, the connector API needs another information-rich class to provide all the necessary details from the executor. This includes, for example, the Hugging Face model’s configuration, LoRA configuration, MPI world_size and rank, as well as tensor, data, or pipeline parallelism information.

TorchLlmArgs is a good candidate for this role and serves as the successor to executor_config.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 3, 2025

📝 Walkthrough

Walkthrough

Propagates TorchLlmArgs into KV cache components. Updates constructor signatures for worker/leader/scheduler to accept llm_args (and tokens_per_block where applicable). Adjusts executor creator to pass new arguments when launching worker and scheduler. Example connector imports TorchLlmArgs and aligns with new base-class parameters. No other logic changes.

Changes

Cohort / File(s) Summary of Changes
Core KV cache connector (Torch)
tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py
Added TorchLlmArgs import. Changed KvCacheConnectorWorker.init to accept llm_args: TorchLlmArgs and store it. Changed KvCacheConnectorScheduler.init to accept llm_args: TorchLlmArgs, tokens_per_block: int and store them. No other control-flow changes.
Executor creation wiring
tensorrt_llm/_torch/pyexecutor/py_executor_creator.py
Updated construction/launch to pass llm_args to worker and llm_args, tokens_per_block to scheduler; no changes to concurrency pattern or result handling.
Example KV cache connector
examples/llm-api/llm_kv_cache_connector.py
Imported TorchLlmArgs. Updated PersistentKvCacheConnectorWorker.init to accept llm_args: TorchLlmArgs and forward to base. Updated PersistentKvCacheConnectorLeader.init to accept llm_args: TorchLlmArgs, tokens_per_block: int, forward both, and initialize block_size from internal _tokens_per_block.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Creator as PyExecutorCreator
  participant Worker as KvCacheConnectorWorker
  participant Scheduler as KvCacheConnectorScheduler

  User->>Creator: create_executor(llm_args, tokens_per_block)
  note over Creator: Prepare tasks

  Creator->>Worker: start(llm_args)
  activate Worker
  Worker-->>Creator: ready
  deactivate Worker

  Creator->>Scheduler: start(llm_args, tokens_per_block)
  activate Scheduler
  Scheduler-->>Creator: ready
  deactivate Scheduler

  note over Creator,Worker: llm_args now available in components
  note over Creator,Scheduler: tokens_per_block set in scheduler
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • syuoni
  • dongxuy04
  • LinPoly
  • suyoggupta
✨ 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.
    • 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 or @coderabbit 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.

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: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
tensorrt_llm/_torch/pyexecutor/py_executor_creator.py (1)

436-447: Validate tokens_per_block before scheduler instantiation
In tensorrt_llm/_torch/pyexecutor/py_executor_creator.py (around the executor.submit(scheduler_cls, …) block at lines 448–454), add a guard to ensure executor_config.tokens_per_block is a positive integer and raise a clear error if not.

examples/llm-api/llm_kv_cache_connector.py (1)

28-33: Python 3.8 compatibility: replace PEP 585 built-in generics

The repo targets Python 3.8+. Annotations like list[tuple[str, int]] require 3.9+. Switch to typing.List/typing.Tuple (and add imports) to avoid SyntaxError on 3.8.

You can adjust as follows (outside the changed hunk):

from typing import List, Tuple  # add near other imports

@dataclass
class PersistentKvCacheConnectorMetadata:
    load: List[Tuple[str, int]] = field(default_factory=list)
    save: List[Tuple[str, int]] = field(default_factory=list)
🧹 Nitpick comments (2)
tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py (1)

84-86: Store llm_args on worker: OK; consider documenting intended usage

Attribute is set but unused here. A brief docstring or comment clarifying expected fields (e.g., kv_connector_config) would help implementers.

examples/llm-api/llm_kv_cache_connector.py (1)

1-4: Add NVIDIA/SPDX header for consistency

Other TRT-LLM Python files include the SPDX/NVIDIA header. Mirror that here.

Example (insert at file top):

# SPDX-FileCopyrightText: Copyright (c) 2022-2025 NVIDIA CORPORATION & AFFILIATES.
# SPDX-License-Identifier: Apache-2.0
📜 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 9a4f606 and ec1ee4f.

📒 Files selected for processing (3)
  • examples/llm-api/llm_kv_cache_connector.py (3 hunks)
  • tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py (3 hunks)
  • tensorrt_llm/_torch/pyexecutor/py_executor_creator.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
**/*

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Filenames compiled into a target must be case-insensitively unique

Files:

  • tensorrt_llm/_torch/pyexecutor/py_executor_creator.py
  • examples/llm-api/llm_kv_cache_connector.py
  • tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py
**/*.{h,hpp,hh,hxx,cc,cpp,cxx,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Use spaces, not tabs; indent 4 spaces

Files:

  • tensorrt_llm/_torch/pyexecutor/py_executor_creator.py
  • examples/llm-api/llm_kv_cache_connector.py
  • tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py
**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: Code must target Python 3.8+
Indent with 4 spaces; do not use tabs (Python)
Maintain module namespace on import: prefer from package.subpackage import foo; use foo.Symbol()
Python filenames use snake_case
Python class names use PascalCase
Python functions and methods use snake_case
Python local variables use snake_case; if starting with a number concept, prefix with k (e.g., k_99th_percentile)
Python global variables use G_ prefix with UPPER_SNAKE_CASE
Python constants use UPPER_SNAKE_CASE
Avoid shadowing variables from outer scopes
Initialize all externally visible class members in init
For public interfaces, prefer docstrings over comments; comments should be for in-function or file-local interfaces
Use Google-style docstrings for classes and functions (Sphinx-parsable)
Document attributes and variables inline with docstrings immediately after assignment
Avoid reflection when a non-reflective approach suffices
Limit except clauses to specific exceptions where possible
When using try/except for duck-typing, keep try body minimal and move logic to else

Files:

  • tensorrt_llm/_torch/pyexecutor/py_executor_creator.py
  • examples/llm-api/llm_kv_cache_connector.py
  • tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py
**/*.{cpp,cc,cxx,h,hpp,hh,hxx,cu,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

Prepend NVIDIA copyright header (current year) to all source files

Files:

  • tensorrt_llm/_torch/pyexecutor/py_executor_creator.py
  • examples/llm-api/llm_kv_cache_connector.py
  • tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py
🧬 Code graph analysis (3)
tensorrt_llm/_torch/pyexecutor/py_executor_creator.py (1)
tensorrt_llm/_torch/attention_backend/trtllm.py (1)
  • tokens_per_block (581-585)
examples/llm-api/llm_kv_cache_connector.py (1)
tensorrt_llm/llmapi/llm_args.py (2)
  • KvCacheConnectorConfig (407-419)
  • TorchLlmArgs (2173-2606)
tensorrt_llm/_torch/pyexecutor/kv_cache_connector.py (1)
tensorrt_llm/llmapi/llm_args.py (1)
  • TorchLlmArgs (2173-2606)
🔇 Additional comments (2)
tensorrt_llm/_torch/pyexecutor/py_executor_creator.py (1)

441-441: Passing llm_args into worker ctor looks correct

Matches the updated worker interface. No concerns here.

examples/llm-api/llm_kv_cache_connector.py (1)

36-38: Worker ctor update aligns with base class

Forwarding llm_args is correct.

@svc-trtllm-gh-bot svc-trtllm-gh-bot added the Community want to contribute PRs initiated from Community label Sep 3, 2025
@pcastonguay
Copy link
Collaborator

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #17533 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

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

@QiJune QiJune requested a review from Superjomn September 3, 2025 18:19
@QiJune
Copy link
Collaborator

QiJune commented Sep 3, 2025

@Superjomn, I think we need to merge this PR #5911. Then, tokens_per_block would be a part of TorchLlmArgs.

@pcastonguay pcastonguay changed the title [None][chore] add TorchLlmArgs to the connector api Draft: [None][chore] add TorchLlmArgs to the connector api Sep 3, 2025
@pcastonguay
Copy link
Collaborator

@Superjomn, I think we need to merge this PR #5911. Then, tokens_per_block would be a part of TorchLlmArgs.

Ok, Marking current MR as Draft until that PR gets merged.

@pcastonguay
Copy link
Collaborator

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #17933 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@pcastonguay pcastonguay changed the title Draft: [None][chore] add TorchLlmArgs to the connector api [None][chore] add TorchLlmArgs to the connector api Sep 7, 2025
Copy link
Collaborator

@pcastonguay pcastonguay left a comment

Choose a reason for hiding this comment

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

@richardhuo-nv now that #5911 has been merged, can we update this PR so that we don't need to explicitely pass tokens_per_block since it's now part of LlmArgs? Thanks.

Signed-off-by: richardhuo-nv <rihuo@nvidia.com>

fix

Signed-off-by: richardhuo-nv <rihuo@nvidia.com>
Signed-off-by: richardhuo-nv <rihuo@nvidia.com>
Signed-off-by: richardhuo-nv <rihuo@nvidia.com>
@richardhuo-nv
Copy link
Collaborator Author

@richardhuo-nv now that #5911 has been merged, can we update this PR so that we don't need to explicitely pass tokens_per_block since it's now part of LlmArgs? Thanks.

Thank you so much for your effort to get the CI passed! I just pushed a commit to rebase the main and removed the tokens_per_block.

@richardhuo-nv
Copy link
Collaborator Author

/bot run

@pcastonguay
Copy link
Collaborator

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18050 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@pcastonguay pcastonguay merged commit dcd110c into NVIDIA:main Sep 9, 2025
5 checks passed
Wong4j pushed a commit to Wong4j/TensorRT-LLM that referenced this pull request Sep 20, 2025
Signed-off-by: richardhuo-nv <rihuo@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Community want to contribute PRs initiated from Community

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants