llmperfscope 0.1.0__tar.gz

llmperfscope-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0
+
+First public release.
+
+- `run`, `serve` and `attach`: profile any command, server, container or running process over its whole life, with no code changes.
+- Per-phase verdicts on what limits it, findings on memory and on data moving between disk, RAM and GPU, and on how serving scales.
+- Support for llama.cpp, vLLM, SGLang, Text Generation Inference, Ollama, transformers and any OpenAI-compatible server, plus phase markers for anything else.
+- `--nsys` for GPU kernels, collectives and copies, `--cpu-profile` for host hot spots without `perf`, `--cold-start` for a first load.
+- `diff`, `matrix` and `noise`: comparisons that judge speed, memory, load time and energy together.
+- `figure`: paper figures as PDF, SVG and PNG, with their data as CSV and suggested captions.
+- `anonymize`: a copy of a run that can be published.
+- `report.html`: every counter on one time axis.

llmperfscope-0.1.0/CITATION.cff

@@ -0,0 +1,17 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "llmperfscope: a whole-lifecycle profiler for LLM inference engines"
+type: software
+authors:
+  - family-names: Kwon
+    given-names: Yonghye
+repository-code: "https://github.com/developer0hye/llmperfscope"
+license: Apache-2.0
+version: 0.1.0
+date-released: "2026-11-01"
+keywords:
+  - llm
+  - profiling
+  - inference
+  - performance
+  - gpu

llmperfscope-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing
+
+Issues and pull requests are welcome. Reports of a wrong number or a misleading verdict are especially useful: please attach the run, copied with `llmperfscope anonymize RUN --out DIR`.
+
+## Setting up
+
+```sh
+git clone https://github.com/developer0hye/llmperfscope && cd llmperfscope
+pip install -e ".[figures]"
+cd tests && python3 -m unittest
+```
+
+The tests need Linux but no GPU: real processes with known behaviour stand in for an engine, and scripted GPUs for hardware. On other systems `test_samples` and `test_docs` still run.
+
+## What a change should do
+
+- **An instrument has to be right.** A new number needs a test where the true answer is known, because the process was made to behave that way. Then the report has to say what happened.
+- **Keep the measuring side free of dependencies.** `pip install llmperfscope` installs nothing else. Only `figures` needs matplotlib, and it loads only when drawing.
+- **Do not disturb the engine.** Anything slow goes on its own thread and at a low rate. If a change could cost the engine speed, show it does not: alternate fresh processes with and without it, on a real engine. See [docs/validation.md](docs/validation.md).
+- **State the evidence.** A finding carries the numbers it rests on, and says so when it cannot tell. It stays silent on short runs and shared machines unless the evidence survives them.
+- **Keep the docs in step.** A new option or finding goes in `docs/`. `tests/test_docs.py` checks that every option and relative link in the docs exists.
+
+## Adding an engine
+
+See [docs/adapters.md](docs/adapters.md). Often a preset is enough. Please add a real sample of the engine's output to `tests/test_parsers.py`.
+
+## Figures
+
+The series colors are validated for color vision deficiency in their fixed order, so assign them in sequence and never cycle them. Render at `--width single` and `--width double` and look at the result, since tests cannot see an overlap. Regenerate the gallery with `docs/gallery/make.sh`.
+
+## Sample runs
+
+`examples/sample-runs` holds real runs, copied with `llmperfscope anonymize`. Check a new one for names before adding it.

llmperfscope-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2026 Yonghye Kwon
+
+   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.

llmperfscope-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include CHANGELOG.md CITATION.cff CONTRIBUTING.md LICENSE README.md
+recursive-include src/llmperfscope/native *.c
+recursive-include tests *.py
+recursive-include docs *.md
+include examples/*.py examples/*.json
+global-exclude *.pyc *.so
+prune examples/sample-runs
+prune docs/gallery
+# It checks links into what the two lines above leave out.
+exclude tests/test_docs.py

llmperfscope-0.1.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: llmperfscope
+Version: 0.1.0
+Summary: Whole-lifecycle profiler for LLM inference engines: load, warmup, prefill, decode, serving and teardown; speed, memory and energy. Works with any engine, needs no code changes.
+Author: Yonghye Kwon
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/developer0hye/llmperfscope
+Project-URL: Documentation, https://github.com/developer0hye/llmperfscope/tree/main/docs
+Project-URL: Issues, https://github.com/developer0hye/llmperfscope/issues
+Project-URL: Changelog, https://github.com/developer0hye/llmperfscope/blob/main/CHANGELOG.md
+Keywords: llm,profiler,inference,performance,gpu,llama.cpp,vllm,sglang,benchmark,bottleneck
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Benchmark
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: figures
+Requires-Dist: matplotlib>=3.7; extra == "figures"
+Dynamic: license-file
+
+# llmperfscope
+
+[![PyPI](https://img.shields.io/pypi/v/llmperfscope)](https://pypi.org/project/llmperfscope/)
+[![tests](https://github.com/developer0hye/llmperfscope/actions/workflows/tests.yml/badge.svg)](https://github.com/developer0hye/llmperfscope/actions/workflows/tests.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/developer0hye/llmperfscope/blob/main/LICENSE)
+
+Tells you what limits an LLM engine, where its memory goes, and how its data moves between disk, RAM, CPU and GPU, over its whole life: load, warmup, prefill, decode, serving and shutdown.
+
+It works with any engine and needs no code changes. Put it in front of the command you already run:
+
+```sh
+pip install llmperfscope
+llmperfscope run -- llama-bench -m model.gguf -ngl 0 -lm mmap
+```
+
+Here is a 0.6 GiB model on the CPU with 450 MiB of RAM, from [a real run](https://github.com/developer0hye/llmperfscope/tree/main/examples/sample-runs/cpu-ram-limited):
+
+```
+## What limits each phase
+
+| phase  | limit | confidence | why                                                                                                       |
+|--------|-------|------------|-----------------------------------------------------------------------------------------------------------|
+| decode | ram   | high       | Host RAM is short: 333 MiB/s of file pages dropped and read again, tasks stalled on memory 13% of the time. |
+
+## Data movement findings
+
+- **warning**: 18.79 GiB read from disk and 49,217 major page faults during decode. The weights or cache are not staying in RAM:
+  evicted pages, mmap of tensors used on the CPU, or an engine offloading to disk.
+- Load read 0.64 GiB from sda (hdd) at 878 MiB/s; 0% of the model was cached before the run.
+```
+
+Each run also writes `report.html` with every counter on one time axis, `run.json` with all the numbers, and, on request, figures ready for a paper:
+
+![The life of a server on 8 GPUs: GPU memory, power and utilization, host memory and CPU, PCIe and NVLink traffic, on one time axis with phases as bands.](https://raw.githubusercontent.com/developer0hye/llmperfscope/main/docs/gallery/lifecycle.png)
+
+## Install
+
+```sh
+pip install llmperfscope               # no dependencies
+pip install "llmperfscope[figures]"    # adds matplotlib, for paper figures
+llmperfscope check                     # what can be measured on this machine
+```
+
+Measuring needs Linux and Python 3.9 or newer. GPU telemetry needs an NVIDIA driver; without one you still get phases, host memory, CPU and disk. A C compiler is needed only for `--cpu-profile`.
+
+## Use it with your engine
+
+Servers are started, loaded, stopped and measured in one command. llmperfscope finds the port, waits until the server is ready, sends streaming requests and reads its metrics.
+
+```sh
+llmperfscope serve -- llama-server -m model.gguf -ngl 99
+llmperfscope serve -- vllm serve Qwen/Qwen3-0.6B
+llmperfscope serve -- python -m sglang.launch_server --model-path Qwen/Qwen3-0.6B
+llmperfscope serve -- text-generation-launcher --model-id Qwen/Qwen3-0.6B
+llmperfscope serve --model qwen2.5:0.5b --pull -- ollama serve
+
+# Containers work the same way. llmperfscope follows the engine inside, not the docker client.
+llmperfscope serve -- docker run --gpus all -p 8000:8000 vllm/vllm-openai --model Qwen/Qwen3-0.6B
+```
+
+Choose the load with `--prompts file.jsonl`, `--concurrency 1,4,8` and `--max-tokens 64`. Any other OpenAI-compatible server works with `--preset openai --url http://host:port`, and something already running with `llmperfscope attach`.
+
+An engine used as a library takes a wrapper and, optionally, a few markers. They do nothing when no profiler is running:
+
+```python
+import llmperfscope
+
+with llmperfscope.phase("load"):
+    model = AutoModelForCausalLM.from_pretrained(name, device_map="auto")
+
+timer = llmperfscope.TokenTimer()
+with llmperfscope.phase("decode", tokens=128):
+    model.generate(**inputs, max_new_tokens=128, streamer=timer)
+print(timer.summary())
+```
+
+```sh
+llmperfscope run -- python script.py
+```
+
+Any other program can mark phases from any language, with no dependency:
+
+```sh
+llmperfscope run --mark 'Model loaded=decode' -- my-engine        # a line in its output starts a phase
+echo decode >> "$LLMPERFSCOPE_MARKERS"                            # or append to this file
+```
+
+Tested end to end with llama.cpp (`llama-bench`, `llama-server`), vLLM 0.32.0 (server and library), SGLang 0.5.22, Text Generation Inference 3.3.7, Ollama 0.40.9 and transformers. See [the engine notes](https://github.com/developer0hye/llmperfscope/blob/main/docs/engines.md).
+
+## What it answers
+
+**What limits this phase?** Each phase gets one verdict with the numbers behind it: `gpu`, `gpu (throttled)`, `gpu imbalance`, `gpu + host wait`, `cpu (one thread)`, `cpu (many threads)`, `cpu contention`, `disk (nvme|ssd|hdd)`, `ram`. It rests on the kernel's pressure stall counters, GPU utilization history, per-thread CPU time and disk activity. A phase too short for these counters is reported as too short.
+
+**Is memory being overused?** llmperfscope reports GPU memory per device and per process, host memory split into anonymous and file-backed, swap, and the engine's own breakdown where it gives one. It flags:
+
+- a GPU or the host running out of headroom
+- a transient peak that decides what fits
+- host memory that keeps growing, as a leak would
+- weights held in RAM next to their GPU copy
+- PyTorch reserving far more than its tensors use, and cache pools that are mostly unused
+- GPUs filled unevenly
+
+**Where does data travel?** Per phase: bytes read and written per disk, with NVMe, SSD and HDD told apart; swap in and out; page cache changes and refaults; major page faults; RAM to GPU and back over PCIe; GPU to GPU over NVLink. Reads from disk during inference are flagged, because they mean the weights are not staying in RAM. `--cold-start` drops the model from the page cache first, without root, so a load can be measured as a user's first run would see it.
+
+**Where does the GPU's time go?** Add `--nsys` for kernels, collectives, copies and idle gaps per phase and per token, the host's time in CUDA calls, and exact bytes copied. Add `--cpu-profile` for the hot functions of the host threads. It samples from inside the process, so it works where `perf` is not allowed. Both slow the engine down, so those runs are marked and never counted as speed results.
+
+**What did a change cost?** `llmperfscope matrix` runs two builds in alternating order across many cases, in fresh processes, re-checking the machine before each arm. It judges speed, memory, load time and energy together, so a speed win that costs memory shows up as a regression. A difference counts only if the arms do not overlap and it exceeds the noise floor. Measure that floor with the same binary on both sides.
+
+```sh
+llmperfscope matrix --cases cases.json --a old=build-old/bin --b new=build-new/bin --out res
+```
+
+## Figures for papers
+
+```sh
+llmperfscope figure RUN_DIR --width single --print-safe --out figures
+```
+
+You get vector PDF with embedded TrueType fonts, editable SVG, 300 dpi PNG, the data behind each figure as CSV, and a suggested caption with the numbers filled in. Widths match common paper layouts, colors stay distinct under color vision deficiency, and the same run gives byte-identical PDF and SVG. `llmperfscope anonymize` makes a copy of a run with no host names or paths, to publish with the paper.
+
+| | |
+|---|---|
+| ![Peak memory by phase, per GPU, and the engine's own table.](https://raw.githubusercontent.com/developer0hye/llmperfscope/main/docs/gallery/memory.png) | ![Share of each GPU's time in kernels, collectives, copies and idle, with the top kernels.](https://raw.githubusercontent.com/developer0hye/llmperfscope/main/docs/gallery/gpu_time.png) |
+| ![Output tokens per second and latency at 1 and 4 clients for five engines. Illustrative: nothing was tuned.](https://raw.githubusercontent.com/developer0hye/llmperfscope/main/docs/gallery/engines_serving.png) | ![The ratio of a patched build to upstream over three cases, with verdicts.](https://raw.githubusercontent.com/developer0hye/llmperfscope/main/docs/gallery/matrix.png) |
+
+See [every figure and how to fit it to your venue](https://github.com/developer0hye/llmperfscope/blob/main/docs/figures.md). The runs behind these are [in the repository](https://github.com/developer0hye/llmperfscope/tree/main/examples/sample-runs), so you can try it with no GPU.
+
+## Trusting the numbers
+
+- **The tool's own cost is measured.** Sampling happens in another process, pinned away from the engine's CPUs when it can be. Speed with llmperfscope against without it, alternating fresh processes, 4 arms each of 10 repetitions, on 8 RTX A6000 (the same binary against itself varies by about 1% at 8 GPUs):
+
+  | Case | Prefill | Decode |
+  |---|---:|---:|
+  | Qwen3-30B-A3B Q8_0, 1 GPU | 1.00 | 1.00 |
+  | Qwen3-30B-A3B Q8_0, 8 GPUs, tensor split | 0.998 | 1.000 |
+  | DeepSeek-V4.1-Flash, 8 GPUs, tensor split | 1.001 | 1.001 |
+
+- **Every run checks itself.** Phase times are compared with the engine's own timers where it has them; it was 1.000 to 1.001 in the runs above. Power from the energy counter is compared with the power gauge, because the counter was caught under-reporting by half when read too often; llmperfscope reads it about twice a second, and a large disagreement is called out in the report.
+- **Known answers.** The RAM-limited run above took decode from 73.9 to 2.5 tokens/s, and the report named `ram`. GPU memory from NVML matched llama.cpp's own table to within driver overhead. GPU kernel times matched a separately written analysis of the same trace.
+- **Every run stores its context.** That means foreign CPU and GPU load, the page cache state of the model, the storage it lives on, binary hashes, the git commit and relevant environment variables. Runs on a busy machine are flagged, and `--precheck wait` waits for it to go quiet.
+- **Hung runs stop.** A collective that spins forever looks busy to every utilization counter, so progress means output or resource changes. A stalled run is killed with a report of what its threads were doing.
+- **Credentials stay out.** Tokens and keys in the command line and environment are never written to the report.
+
+The test suite runs real processes with known behaviour and checks that the report says what happened: `cd tests && python3 -m unittest`. See [how it was validated](https://github.com/developer0hye/llmperfscope/blob/main/docs/validation.md), including the mistakes it has already made.
+
+## Limits
+
+- Linux only for measuring. GPU telemetry is NVIDIA only for now ([other vendors can plug in](https://github.com/developer0hye/llmperfscope/blob/main/docs/adapters.md)); without it you still get host metrics and phases.
+- GPU hardware counters such as cache hit rates need admin rights (`RmProfilingAdminOnly=0`). llmperfscope does not read them yet.
+- Memory bandwidth on the host is not visible without privileges.
+- PCIe traffic is a sample, not a count. Use `--nsys` for exact copy bytes.
+- System-wide counters (disks, swap, pressure) include other processes. On a shared machine, trust the per-process columns.
+- NVML's GPU utilization needs about a second to mean anything, which is why short phases are not judged.
+
+## Documentation
+
+| | |
+|---|---|
+| [Quickstart](https://github.com/developer0hye/llmperfscope/blob/main/docs/quickstart.md) | install, first run, which command to use |
+| [Engines](https://github.com/developer0hye/llmperfscope/blob/main/docs/engines.md) | llama.cpp, vLLM, SGLang, TGI, Ollama, transformers, containers, any other program |
+| [Reading a report](https://github.com/developer0hye/llmperfscope/blob/main/docs/reading-reports.md) | every verdict and finding, and what to do about it |
+| [Figures](https://github.com/developer0hye/llmperfscope/blob/main/docs/figures.md) | paper figures, sizes, fonts, captions, checklist |
+| [Comparing](https://github.com/developer0hye/llmperfscope/blob/main/docs/comparing.md) | A/B runs, noise floors, what counts as a real difference |
+| [Going deeper](https://github.com/developer0hye/llmperfscope/blob/main/docs/deep-dives.md) | `--nsys`, `--cpu-profile`, `--cold-start` |
+| [Run data](https://github.com/developer0hye/llmperfscope/blob/main/docs/run-json.md) | `run.json`, samples and requests, for your own analysis |
+| [Adding an engine](https://github.com/developer0hye/llmperfscope/blob/main/docs/adapters.md) | presets, adapters, GPU backends |
+| [Validation](https://github.com/developer0hye/llmperfscope/blob/main/docs/validation.md) | overhead, known answers, limits |
+
+## Citing
+
+If llmperfscope helps your work, please cite it. GitHub's "Cite this repository" button gives BibTeX from [CITATION.cff](https://github.com/developer0hye/llmperfscope/blob/main/CITATION.cff).
+
+## License
+
+Apache-2.0