docs: add API benchmark example - #2138
Conversation
Greptile SummaryThis PR adds an "Online API Benchmarking" section to
Confidence Score: 5/5Pure documentation addition with no code changes; safe to merge. The change is a single documentation section with no logic, configuration, or dependency changes. The curl and evalscope commands are well-formed, the optional tokenizer-path is clearly documented outside the runnable block, and the inline install hint is present. Prior reviewer concerns have been addressed in this revision. Files Needing Attention: No files require special attention.
|
| Filename | Overview |
|---|---|
| doc/en/benchmark.md | Adds a new "Online API Benchmarking" section with a curl verification step, an EvalScope perf command, and inline install guidance; previously flagged issues (optional tokenizer-path, missing install note) are addressed in this revision. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[KTransformers server running] --> B[Verify with direct curl request]
B --> C{Server responds OK?}
C -- No --> D[Debug server-side issue]
C -- Yes --> E[Run evalscope perf --parallel 1 --number 4]
E --> F{Benchmark stable?}
F -- No --> G[Reproduce failing prompt with plain curl]
G --> D
F -- Yes --> H[Increase --parallel and --number gradually]
H --> I[Collect throughput / latency metrics]
Reviews (2): Last reviewed commit: "[docs]: refine EvalScope benchmark examp..." | Re-trigger Greptile
|
Thanks for the review — I pushed Changes made:
Validation:
|
|
Want your agent to iterate on Greptile's feedback? Try greploops. |
Summary
doc/en/benchmark.md.evalscope perfcommand against/v1/chat/completions.curlrequests first, then increasing benchmark parallelism gradually.Refs #853
Refs #1269
Test Plan
pythondocumentation guard check for the new EvalScope benchmark guidancegit diff --check HEAD~1..HEAD