[None][doc] Show trtllm-bench KV host cache config - #17279
Conversation
Signed-off-by: zq <zhouquan1511@163.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughThe benchmarking guide documents PyTorch benchmark KV cache host offloading. It adds YAML configuration for ChangesKV cache host offloading
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/source/developer-guide/perf-benchmarking.md`:
- Around line 276-279: After the YAML example, document that when both
max_tokens and host_cache_size are configured, the runtime allocates host-cache
memory based on the smaller effective limit; clarify that host_cache_size:
1073741824 does not always result in a 1 GiB host cache.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 2c891c87-75ca-4876-a9c9-1019789959af
📒 Files selected for processing (1)
docs/source/developer-guide/perf-benchmarking.md
brnguyen2
left a comment
There was a problem hiding this comment.
Docs-only, accurate: kv_cache_config.host_cache_size matches the KvCacheConfig field, and the kvcache.md anchor resolves. Fine to merge; two optional wording touch-ups inline.
| ``` | ||
|
|
||
| The setting allocates host memory for KV cache blocks that have been evicted or | ||
| paused and can later be copied back to GPU memory for reuse. It is not a |
There was a problem hiding this comment.
"It is not a top-level trtllm-bench option such as --kv_host_cache_bytes" names a flag that has never existed, which reads oddly in reference docs and invites someone to search for it. The first paragraph already makes the point ("does not expose every LLM API option as a top-level CLI flag"). Suggest dropping this sentence.
|
|
||
| ```yaml | ||
| # kv_host_cache.yaml | ||
| kv_cache_config: |
There was a problem hiding this comment.
Worth stating the general rule once instead of the KV-specific one: the --config YAML accepts any TorchLlmArgs field, so this same mechanism covers cuda_graph_config, moe_config, etc. That saves the next doc section for the next un-flagged option.
Signed-off-by: zq <zhouquan1511@163.com>
|
Thanks for the review — I pushed Changes made:
Validation:
Note: Full Sphinx docs build was not run locally because |
Summary
trtllm-benchPyTorch workflow section for KV cache host offloading.--configusingkv_cache_config.host_cache_size.--kv_host_cache_bytesis not a top-leveltrtllm-benchoption.Test Plan
git diff --checkpython -m sphinx --versionfails locally withNo module named sphinx)Refs #6912
Dev Engineer Review
trtllm-benchdocumentation for PyTorch KV cache host offloading.TorchLlmArgssettings through--config, includingkv_cache_config.host_cache_size.max_tokensandhost_cache_sizeare set.--kv_host_cache_bytesreference.git diff --checkpassed.QA Engineer Review
No test changes.