servebench 1.0.0__tar.gz

servebench-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

servebench-1.0.0/PKG-INFO

@@ -0,0 +1,323 @@
+Metadata-Version: 2.4
+Name: servebench
+Version: 1.0.0
+Summary: Load-test any OpenAI-compatible LLM endpoint: TTFT, TPOT, ITL, throughput, goodput, charts.
+Keywords: llm,benchmark,inference,serving,ttft,openai,vllm,ollama,llama.cpp
+Author: Prajwal Pujari
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: System :: Benchmark
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13
+Requires-Dist: pydantic>=2.6
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: aiohttp>=3.10
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: nvidia-ml-py>=13.615.71
+Requires-Dist: transformers>=4.40 ; extra == 'hf'
+Requires-Dist: fastapi>=0.110 ; extra == 'mock'
+Requires-Dist: uvicorn>=0.29 ; extra == 'mock'
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/Prajwal7-2002/servebench
+Project-URL: Issues, https://github.com/Prajwal7-2002/servebench/issues
+Provides-Extra: hf
+Provides-Extra: mock
+Description-Content-Type: text/markdown
+
+# servebench
+
+[![CI](https://github.com/Prajwal7-2002/servebench/actions/workflows/ci.yml/badge.svg)](https://github.com/Prajwal7-2002/servebench/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+![Python](https://img.shields.io/badge/python-3.11%2B-blue)
+
+Load-test any OpenAI-compatible LLM endpoint (Ollama, llama.cpp server, vLLM, SGLang, your
+own engine) and get the numbers that matter for serving: **TTFT, TPOT, inter-token latency,
+throughput and goodput**, at p50/p90/p99, over a sweep of load levels, with charts and
+side-by-side comparison of runs.
+
+No GPU or engine install is needed on the client: it is one async Python process talking HTTP.
+
+## Quickstart
+
+Uses [uv](https://docs.astral.sh/uv/) (or pipx/pip). PyPI release coming; for now, from a
+clone:
+
+```bash
+uv tool install --from . servebench      # puts `servebench` on your PATH
+servebench quick                         # finds your local server, ~1 minute
+```
+
+`quick` looks for Ollama, llama.cpp, LM Studio, vLLM and SGLang on their usual ports, picks
+the loaded model, measures, and answers in plain language. A real run (Ollama with
+`OLLAMA_NUM_PARALLEL=4` on a laptop):
+
+```
+servebench quick: Ollama 0.35.1 at http://127.0.0.1:11434/v1, model qwen2.5:0.5b
+...
+Ollama 0.35.1, qwen2.5:0.5b on AMD Ryzen 5 6600H, 15.3 GB RAM, NVIDIA GeForce RTX 3050 6GB Laptop GPU
+One user:    first token in 43 ms, then 203 tokens/s
+Capacity:    4 users at once (first token < 500 ms and >= 20 tokens/s each, for 90% of requests)
+At 4 users:  361 tokens/s in total, 136 tokens/s each, first token p99 161 ms
+```
+
+With default Ollama settings it also explains *why* the limit is where it is ("requests
+queue: the server works on about 1 at once") and suggests the fix. Then
+`servebench share <run.json>` prints a Markdown table to paste into a post or issue and
+makes a result card:
+
+![servebench result card: 4 users at once, 203 tokens/s for one user, 43 ms to first token](results/quick-ollama-np4-card.png)
+
+Full control:
+
+```bash
+# sweep a running server, e.g. Ollama (on Windows use 127.0.0.1, not localhost)
+servebench run --url http://127.0.0.1:11434/v1 --model qwen2.5:0.5b \
+    --concurrency 1,2,4,8 --input-len 256 --output-len 128 --out runs/ollama.json
+
+# how many concurrent users fit your latency targets?
+servebench find-capacity --url http://127.0.0.1:11434/v1 --model qwen2.5:0.5b \
+    --out runs/ollama-cap.json
+
+# compare multiple runs side by side, with charts and GPU telemetry
+servebench compare-models runs/model-q4.json runs/model-fp16.json
+
+# CI performance regression gate (fails with exit code 1 on regressions)
+servebench check candidate.json --baseline baseline.json \
+    --max-ttft-degradation-pct 15.0 --max-throughput-degradation-pct 10.0
+
+# generate interactive HTML report
+servebench report runs/ollama.json runs/llamacpp.json --out report.html
+```
+
+### Python API
+
+Use Servebench programmatically in your own evaluation harnesses or notebooks:
+
+```python
+import servebench
+
+res = servebench.benchmark(
+    url="http://127.0.0.1:8000/v1",
+    model="llama-3-8b",
+    levels=[1, 2, 4, 8],
+    preset="chat",
+    gpu_telemetry=True,
+)
+print(f"Peak: {max(lv.summary.output_throughput for lv in res.levels):.1f} tok/s")
+
+# Evaluate CI performance regression
+report = servebench.check_regression("candidate.json", "baseline.json")
+assert report.passed, "Serving latency regressed!"
+```
+
+No model at hand? `uv tool install --from . "servebench[mock]"` adds `servebench mock-server`,
+a stand-in server with set timings, so you can try every command without a GPU
+([see How it's tested](#how-its-tested)).
+
+## Learn LLM inference by measuring it
+
+Want to understand how inference engines, batching, and queueing behave under the hood?
+Follow our hands-on guide: **[docs/learn-inference.md](docs/learn-inference.md)**.
+
+It walks through 7 reproducible experiments with Ollama:
+1. **Prefill scaling**: Why TTFT scales linearly with prompt length (~100 ms / 1k tokens).
+2. **Decode bottleneck**: Why TPOT is constant (~4.9 ms/tok, ~200 tok/s) regardless of prompt length.
+3. **Batching & slots**: Why `OLLAMA_NUM_PARALLEL=4` doubles throughput to 385 tok/s, and why 8 slots plateaus.
+4. **The p99 latency knee**: Why p50 hides queues while p99 spikes 5× (197 ms → 943 ms) when slots fill.
+5. **Little's Law in practice**: Proving $L = \lambda W$ with real serving numbers.
+6. **Closed vs. open loop**: Why concurrency sweeps mask production breaking points.
+7. **Benchmarking pitfalls**: Prompt cache hits, connection resets, and warm-up bias.
+
+## Results
+
+### Ollama on a laptop GPU: what `OLLAMA_NUM_PARALLEL` buys
+
+Qwen2.5-0.5B (Q4_K_M) on Ollama 0.35.1, fully on an RTX 3050 6 GB laptop GPU. Synthetic
+prompts of 256 tokens, 128 output tokens, 64 requests per level, `find-capacity` with
+SLO TTFT < 500 ms and TPOT < 50 ms for 90% of requests. Only `OLLAMA_NUM_PARALLEL` changes.
+
+![TTFT, TPOT, throughput and E2E latency vs concurrent requests for 1, 4 and 8 Ollama slots](results/ollama-parallel_files/sweep.png)
+
+| Slots | Capacity (concurrent requests) | Completed req/s at capacity | Output tok/s | TTFT p50 / p99 | TPOT p50 | E2E p50 |
+|---|---|---|---|---|---|---|
+| 1 | 1 | 1.51 | 190 | 45 / 59 ms | 4.9 ms | 0.67 s |
+| 4 | 4 | 3.16 | 385 | 101 / 197 ms | 9.4 ms | 1.30 s |
+| 8 | 8 | 3.30 | 400 | 224 / 386 ms | 16 ms | 2.22 s |
+
+- **Capacity follows the slot count exactly.** With one slot, a second request waits for the
+  whole first answer (TTFT 688 ms at c=2), so only one user fits the SLO.
+- **The GPU saturates at about 400 tok/s with 4 streams.** Going from 4 to 8 slots doubles
+  the users who fit the SLO, but finishes only 4% more requests per second; each answer
+  takes 71% longer (TPOT 9.4 → 16 ms) because the same GPU time is split more ways.
+- So for this model and GPU, 4 slots maximise work done; 8 slots only help if you need more
+  simultaneous users within the TTFT target and can accept slower answers.
+
+Full report with every level: [results/ollama-parallel.md](results/ollama-parallel.md).
+Raw data: `results/ollama-np{1,4,8}.json` (every request's timings). Next: llama.cpp server
+on the same GPU, and vLLM on a free Kaggle T4.
+
+## Metrics
+
+| Metric | Meaning |
+|---|---|
+| TTFT | Request sent → first streamed chunk with non-empty content (role-only and empty chunks don't count) |
+| TPOT | (E2E − TTFT) / (output tokens − 1) |
+| ITL | Gaps between consecutive content chunks. Some servers put several tokens in one chunk; the report shows `tok/chunk` so you can tell |
+| E2E | Request sent → end of stream |
+| req/s, out tok/s | Completed requests and output tokens per second of wall time for the level |
+| Goodput | Requests/s that meet the SLOs (default TTFT < 500 ms and TPOT < 50 ms; change with `--slo-ttft-ms`/`--slo-tpot-ms`, also at report time) |
+| Errors | Failed requests grouped by kind (`HTTP 500`, `timeout`, `ConnectError`, ...) |
+
+Token counts come from the server's `usage` (requested with `stream_options.include_usage`).
+If the server sends none, servebench counts with a Hugging Face tokenizer if you pass
+`--tokenizer Qwen/Qwen2.5-0.5B-Instruct` (install the `hf` extra: `servebench[hf]`), or falls back to
+counting chunks. Every request records which source was used, and the report warns about
+chunk counts.
+
+## Load modes
+
+- **Concurrency sweep** (`--concurrency 1,2,4,8`, closed loop): exactly N requests in flight
+  until the level's requests are done. Shows how latency degrades as load grows.
+- **Request rate** (`--rate 0.5,1,2,inf`, open loop): Poisson arrivals at R req/s, whether or
+  not earlier requests finished; `inf` sends everything at once, `--max-concurrency` caps it.
+  This is how you find the point where a server falls over.
+
+Each level gets `--num-requests` requests (default `max(16, 4N)` for concurrency, 64 for
+rate). Two warm-up requests run first and are not measured. Each run uses a new random
+prompt seed (printed and saved in run.json): with a fixed seed, a second run sends the same
+prompts and a server with prompt caching skips prefill (on Ollama TTFT dropped from 43 ms to
+20 ms), so you would measure the cache. Pass `--seed N` to repeat a run exactly.
+
+## Find capacity
+
+`find-capacity` answers "how much load can this server take within my latency targets?"
+with one number:
+
+Real run: Ollama with `OLLAMA_NUM_PARALLEL=4` on the RTX 3050 from the results above.
+
+```bash
+servebench find-capacity --url http://127.0.0.1:11434/v1 --model qwen2.5:0.5b \
+    --max 64 --num-requests 64 --out results/ollama-np4.json
+```
+```
+         c=1  64 ok, 0 failed, 188.5 tok/s, TTFT p50 45 ms, 100% in SLO  -> pass
+         c=2  64 ok, 0 failed, 274.0 tok/s, TTFT p50 71 ms, 100% in SLO  -> pass
+         c=4  64 ok, 0 failed, 384.6 tok/s, TTFT p50 101 ms, 100% in SLO  -> pass
+         c=8  64 ok, 0 failed, 375.7 tok/s, TTFT p50 1424 ms, 6% in SLO  -> FAIL
+         c=6  64 ok, 0 failed, 405.2 tok/s, TTFT p50 566 ms, 47% in SLO  -> FAIL
+         c=5  64 ok, 0 failed, 369.8 tok/s, TTFT p50 367 ms, 72% in SLO  -> FAIL
+...
+Capacity: 4 concurrent requests. At 4, 100% met the SLO; at 5, only 72%.
+SLO: TTFT < 500 ms and TPOT < 50 ms for 90% of requests.
+```
+
+- A level **passes** when no request failed and at least `--target` (default 90%) of the
+  requests met `--slo-ttft-ms` and `--slo-tpot-ms`.
+- The search doubles the load from `--start` (1, 2, 4, 8, ...) until a level fails, then
+  binary-searches between the last pass and the first fail until the gap is within
+  `--tolerance` (10%) of the passing value. It never goes above `--max` (256).
+- `--mode rate` searches Poisson arrival rates (req/s) instead of concurrency.
+- Every level it tried is saved, so `servebench report` charts it like any sweep.
+- Each level is measured once and the search assumes latency grows with load. Near the
+  limit a noisy server can pass a level above one that failed; rerun to confirm.
+
+## Prompts
+
+- `--prompts synthetic` (default): `--input-len` tokens of random common words, a different
+  prompt per request so prefix caches cannot reuse one prompt's work for the next.
+  `--ignore-eos` (on by default) asks the server to always generate `--output-len` tokens;
+  vLLM, SGLang and llama.cpp honour it, and servers that don't know it ignore it, so check
+  `out tok/s` against `--output-len` when comparing.
+- `--prompts dolly`: real prompts from
+  [databricks-dolly-15k](https://huggingface.co/datasets/databricks/databricks-dolly-15k)
+  (CC BY-SA 3.0, © Databricks), downloaded once (12.8 MB) into `~/.cache/servebench` (set
+  `SERVEBENCH_CACHE` to move it). Not bundled with this repo. `--input-len` caps the prompt
+  length in words.
+- `--prompts my_prompts.jsonl` (`{"prompt": ...}` per line) or a `.txt` file, one prompt per
+  line.
+
+## How it works
+
+```
+prompts.py ──► load.py ─────────────► client.py ──HTTP/SSE──► server
+ synthetic      concurrency workers    one streaming request,
+ dolly          or Poisson arrivals    perf_counter per chunk
+ file           + event-loop lag check
+                     │
+                     ▼
+               metrics.py ──► run.json ──► report.py
+               percentiles,               terminal table,
+               goodput                    PNG charts, MD / HTML
+```
+
+- One `asyncio` process with `aiohttp` (the HTTP client vLLM's and SGLang's own serving
+  benchmarks use). Timings use `time.perf_counter()`. servebench started on `httpx`; profiling
+  showed its connection pool re-checks every connection on every request, so at 128
+  concurrent requests the *client* capped out at ~45 req/s and inflated TTFT from 100 ms to
+  1.6 s. With aiohttp the same test reaches ~400 req/s with TTFT 135 ms.
+- Every request's chunk arrival times are saved in `run.json`, so reports can be recomputed
+  (for example with different SLOs) without rerunning anything.
+- The client checks itself: a background task measures how long a ready callback waits for
+  the event loop. If the p99 is above 10 ms, the report warns that the client, not the server,
+  may be the bottleneck.
+## How it's tested
+
+You can't check a benchmark's numbers against a real model, because nobody knows the true
+answer in advance. So the tests use `servebench mock-server`: a FastAPI server that speaks the
+same OpenAI streaming API but, instead of running a model, sends placeholder tokens with
+timings we set exactly (TTFT, time per token, tokens per chunk, slowdown under load). The
+tests then check servebench measures what was set:
+
+- TTFT and TPOT within a few ms of the set delays, on Linux and Windows (CI on both)
+- role-only and empty chunks don't count as the first token; several tokens per chunk
+- N concurrent requests really means N in flight (the mock counts them); Poisson arrival rates
+- connections are reused (the mock counts TCP connections: 4 requests, 1 connection)
+- `find-capacity` finds the known limit: with TTFT = 80 ms × requests in flight and a 360 ms
+  target, capacity must be exactly 4
+
+Example: a mock set to TTFT 80 ms, 15 ms per token and 15% slowdown per extra request in
+flight should show TPOT 15 × (1 + 0.15 × 15) ≈ 49 ms at 16 concurrent requests, and
+servebench measures 49 ms ([examples/report.md](examples/report.md)). The mock is a test
+tool only; every number under [Results](#results) comes from a real server.
+
+## Limitations
+
+- One client process. Measured on a laptop (Ryzen 5 6600H, Windows) against the mock
+  server: accurate to ~128 concurrent requests / ~400 req/s / ~12k streamed tokens/s (client
+  loop lag p99 under 10 ms); at 256 concurrent it starts to work hard (lag ~20 ms). That
+  covers what a single GPU serves; it is not a multi-machine load generator. The lag check
+  warns when the client is struggling.
+- The first requests of each level include opening TCP connections, as a real client would.
+- TPOT and ITL are only as good as the token counts: without `usage` or `--tokenizer`, a
+  server that sends several tokens per chunk will look slower per token than it is.
+- Measures what the client sees over HTTP, including network and serialization, not the
+  engine's internal timings.
+- Text endpoints only (chat and completions); no images, tool calls or embeddings.
+
+## Related tools
+
+servebench does not try to replace the bigger tools; use them if they fit:
+[vLLM's `vllm bench serve`](https://docs.vllm.ai/),
+[NVIDIA GenAI-Perf](https://github.com/triton-inference-server/perf_analyzer),
+[guidellm](https://github.com/vllm-project/guidellm),
+[LLMPerf](https://github.com/ray-project/llmperf).
+servebench is a small install that works against any engine, makes clean multi-run
+comparisons, and is used to measure the rest of this series of projects on free hardware.
+
+## Development
+
+```bash
+uv sync                      # creates .venv and installs the package + dev tools
+uv run ruff check src tests
+uv run pytest -q
+```
+
+No need to create or activate a virtualenv yourself; `uv run` uses the project's `.venv`.
+
+## License
+
+Apache 2.0. The dolly-15k dataset, if you use it, is CC BY-SA 3.0 and is downloaded from
+Hugging Face at runtime, not distributed here.