[doc] document long-doc-permutator workload in cli bench#2963
Merged
ApostaC merged 1 commit intoLMCache:devfrom Apr 8, 2026
Merged
[doc] document long-doc-permutator workload in cli bench#2963ApostaC merged 1 commit intoLMCache:devfrom
ApostaC merged 1 commit intoLMCache:devfrom
Conversation
Signed-off-by: deng451e <838677410@qq.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the new long-doc-permutator benchmark workload, including its configuration flags and usage examples. The review feedback identified a missing documentation entry for the --ldp-vocab-size flag, which is necessary for completeness according to the project's style guide.
Comment on lines
+280
to
+295
| * - ``--ldp-num-contexts`` | ||
| - 5 | ||
| - Number of unique context documents. | ||
| * - ``--ldp-context-length`` | ||
| - 5000 | ||
| - Token length of each context document. | ||
| * - ``--ldp-system-prompt-length`` | ||
| - 1000 | ||
| - Token length of the shared system prompt. Use ``0`` for no system prompt. | ||
| * - ``--ldp-num-permutations`` | ||
| - 10 | ||
| - Number of distinct permutations to send. Capped at N! where | ||
| N = ``--ldp-num-contexts``. | ||
| * - ``--ldp-num-inflight-requests`` | ||
| - 1 | ||
| - Maximum concurrent in-flight requests. |
Contributor
There was a problem hiding this comment.
The documentation for the long-doc-permutator workload is missing the --ldp-vocab-size flag. This parameter is defined in the LongDocPermutatorConfig and is used to control the vocabulary pool size for synthetic context generation, which affects chunk hash collision risk. It should be included in the flags table for completeness.
Suggested change
| * - ``--ldp-num-contexts`` | |
| - 5 | |
| - Number of unique context documents. | |
| * - ``--ldp-context-length`` | |
| - 5000 | |
| - Token length of each context document. | |
| * - ``--ldp-system-prompt-length`` | |
| - 1000 | |
| - Token length of the shared system prompt. Use ``0`` for no system prompt. | |
| * - ``--ldp-num-permutations`` | |
| - 10 | |
| - Number of distinct permutations to send. Capped at N! where | |
| N = ``--ldp-num-contexts``. | |
| * - ``--ldp-num-inflight-requests`` | |
| - 1 | |
| - Maximum concurrent in-flight requests. | |
| * - ``--ldp-num-contexts`` | |
| - 5 | |
| - Number of unique context documents. | |
| * - ``--ldp-context-length`` | |
| - 5000 | |
| - Token length of each context document. | |
| * - ``--ldp-system-prompt-length`` | |
| - 1000 | |
| - Token length of the shared system prompt. Use ``0`` for no system prompt. | |
| * - ``--ldp-vocab-size`` | |
| - 8000 | |
| - Vocabulary pool size for context generation. Smaller values increase chunk hash collision risk. | |
| * - ``--ldp-num-permutations`` | |
| - 10 | |
| - Number of distinct permutations to send. Capped at N! where | |
| N = ``--ldp-num-contexts``. | |
| * - ``--ldp-num-inflight-requests`` | |
| - 1 | |
| - Maximum concurrent in-flight requests. |
References
- The style guide requires that missing or inaccurate documentation for user-facing changes be addressed (listed as an 'error' in the guide). (link)
Oasis-Git
pushed a commit
to Oasis-Git/LMCache
that referenced
this pull request
Apr 13, 2026
document long-doc-permutator workload Signed-off-by: deng451e <838677410@qq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Special notes for your reviewers:
If applicable:
Note
Low Risk
Docs-only update that adds and references a new benchmark workload option; no runtime code changes.
Overview
Documents the new
long-doc-permutatorworkload forlmcache bench engine, including its purpose, warmup/concurrency behavior, workload-specific flags, and an example invocation.Updates the
--workloadoption and interactive-mode workload list to includelong-doc-permutator, plus a small formatting fix in the exit-codes section.Reviewed by Cursor Bugbot for commit 715943b. Bugbot is set up for automated code reviews on this repo. Configure here.