crit-eval 0.1.1__tar.gz

crit_eval-0.1.1/LICENSE

@@ -0,0 +1,208 @@
+
+                                 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.
+
+crit
+Copyright 2026 crit contributors.
+
+Original crit source is licensed under the Apache License, Version 2.0.
+Third-party components retain their own licenses and notices.

crit_eval-0.1.1/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: crit-eval
+Version: 0.1.1
+Summary: crit-eval: one speed, quality and exactness suite that every inference engine runs the same way
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/crit-labs/crit-eval
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: crit-core<0.11,>=0.10.0
+Provides-Extra: reference
+Requires-Dist: torch; extra == "reference"
+Requires-Dist: transformers>=5.20; extra == "reference"
+Requires-Dist: safetensors; extra == "reference"
+Requires-Dist: numpy; extra == "reference"
+Dynamic: license-file
+
+<div align="center">
+
+<p align="center">
+  <img src="docs/assets/wordmark-light.png#gh-light-mode-only" width="200" alt="crit" />
+  <img src="docs/assets/wordmark.png#gh-dark-mode-only" width="200" alt="crit" />
+  <br />
+</p>
+
+### Speed and quality measurement tool to compare inference engines honestly.
+
+[![Version 0.1.1](docs/assets/badge-version.svg)](CHANGELOG.md)
+[![License Apache-2.0](docs/assets/badge-license.svg)](LICENSE)
+[![Python 3.11+](docs/assets/badge-python.svg)](pyproject.toml)
+
+[Summary](#summary) • [Quick start](#quick-start) • [What `crit-eval` solves](#what-crit-eval-solves) •
+[What `crit-eval` measures](#what-eval-measures) • [Commands](#commands) • 
+[Limitations](#limitations) • [Documentation](#documentation)
+
+</div>
+
+---
+
+<a id="summary"></a>
+
+## Summary
+
+**`crit-eval` runs one fixed suite against every inference engine, so results compare.**
+> [!IMPORTANT]
+> The same prompts, output lengths, stop handling and quality references, through the same
+> OpenAI-compatible API a client uses. Every score is reported against its physical limit on your
+> GPU, and quality is measured as the drift the engine itself adds to the checkpoint you chose.
+> Results from different runs, agents and machines therefore compare, and engines submitted to
+> [crit-hub](https://github.com/crit-labs/crit-hub) are measured with its hub profile.
+
+---
+
+<a id="quick-start"></a>
+
+## Quick start
+
+```sh
+python -m pip install "crit-core @ git+https://github.com/crit-labs/crit#subdirectory=core/python"
+python -m pip install "crit-eval[reference] @ git+https://github.com/crit-labs/crit-eval"
+```
+
+Serve your engine behind an OpenAI-compatible API, then measure it:
+
+```sh
+crit-eval probe --out device.json
+crit-eval fetch --model MODEL_DIR --data EVAL_DATA_DIR --packages PACKAGES
+crit-eval run --url http://127.0.0.1:8000/v1 --model MODEL_DIR --data EVAL_DATA_DIR --device device.json \
+  --profile hub --out result.json
+crit-eval status result.json
+```
+
+`fetch` gets the checkpoint's [reference package](docs/MEASUREMENTS.md#quality) from `PACKAGES` (a folder or an
+https base URL) when it has one; without it,
+`crit-eval reference` scores the reference once on your GPU (the `reference` extra installs torch and
+transformers for that). Inside crit the same commands are `crit eval ...`. An engine without a server
+plugs in through a Python [adapter](docs/ADAPTER.md) instead of `--url`.
+
+---
+
+<a id="what-crit-eval-solves"></a>
+
+## What `crit-eval` solves
+
+**There is no shared way to measure a bespoke inference engine.**
+> Different bespoke inference engines report vastly different types of numbers. An honest comparison requires
+> downloading and running the engines yourself. `crit-eval` finally makes apples-to-apples comparison possible.
+
+**Physics-based evaluation lets you see what performance is left on the table.**
+> `crit-eval` measures your GPU's memory bandwidth and matrix-multiply rates and turns them into a limit for each
+> score. Its evaluation report can tell your coding agent how much performance can still be squeezed out of your
+> inference engine.
+
+**Speed that can't hide a quality loss.**
+> Many inference engines push decode and prefill speed with no regard for quality. `crit-eval` treats quality
+> as a first-class KPI. It measures not only inference speed but also quality regressions.
+
+**A hardware report rounds out the evaluation.**
+> The same model on the same inference engine but on two different machines can also lead to different inference
+> speeds, even if the GPU is the same. We make this transparent by also reporting the runner's hardware configuration.
+
+---
+
+<a id="what-eval-measures"></a>
+
+## What `crit-eval` measures
+
+| KPI or record | In the result | What it records |
+| --- | --- | --- |
+| **decode_greedy** | `status.kpis.decode_greedy` | Greedy decode tokens per second over six workloads (chat, code, math, tool calls, a long document, a 14K-token agent session), with run-to-run noise |
+| **decode_sampled** | `status.kpis.decode_sampled` | Decode tokens per second at the model's own sampling, the headline decode, and tokens per round for speculative engines; a case whose three seeds disagree is repeated at further seeds (up to 9) until its standard error is within 3%, and each case's error is reported |
+| **prefill** | `status.kpis.prefill` | Prompt tokens per second on the two long prompts |
+| **ttft** | `status.kpis.ttft` | Milliseconds to the first token over every workload |
+| **long-context decode and ttft** | `status.kpis.context` | The same scores along a curve of prompts up to the required context (262,144 tokens by default) |
+| **perplexity** | `status.kpis.perplexity` | The engine's perplexity over the reference's: the worst quality set (prompt and served tokens, each long length) against its limit; per set in `quality.sets` |
+| **kl_divergence** | `status.kpis.kl_divergence` | Mean and p99 KL divergence of the engine's token distributions from the reference's: the worst set against its limits; per set in `quality.sets` |
+| limits and gaps | `headroom` | Each KPI's physical limit on this machine, from the probe's best rate per format (cuBLASLt GEMM or raw tensor cores), and what each term (model pass, draft steps, verify pass, draft width, drafter acceptance, prefill, first token) would give at its floor |
+| prefill by activation format | `headroom.activations` | The prefill and TTFT ceilings with the quantized matrices' prompt activations at BF16, FP16 accumulation, FP8 and the stored format, which of them the quality evidence rules out, and the reachable limit: the fastest shown to pass |
+| prefill by term | `crit-eval status --kernels` | With a kernel trace, each prefill term (matmul per weight format, attention, recurrence, other kernels, host) against its floor, a gap per term, and a speculative round split into verify pass and draft steps |
+| time to first token by part | `headroom.ttft` | Each case's time to first token split into the engine's own prefill and first token and the rest (server, tokenizer, HTTP) |
+| quality noise and attribution | `quality.sets.*.budget_spread`, `quality.attribution` | Each set's share of the drift budget with its spread over its positions; with `--attribute-drift`, each matrix group's share of the budget |
+| free device memory | `context.device_memory` | Device memory left free with the engine built for the required context, beside the capacity gate |
+| gates | `status.gates` | Repeatable output, request history, prompt cache, retrieval, exactness, sampling and quality, each passed or not, with every KPI against its limit (`status.kpis`) |
+| retrieval | `context.retrieval` | Facts at the start, middle and end of long prompts, found or not |
+| exactness | `exactness` | Whether speculative output equals plain greedy, case by case |
+| sampling | `sampling_check` | Whether sampled tokens follow the model's distribution |
+| request history | `history` | Whether the same greedy requests give the same tokens after a long request history |
+| prompt cache | `followup` | Follow-up turns answered from a prompt cache: the same answer, and their prefill and ttft |
+| held-out prompts | `heldout` | Speed on ten prompts in other languages and styles, never used for tuning |
+| hardware | `host`, `device` | OS, CPU, RAM and GPUs (name, VRAM, driver, PCIe link), and the measured GPU bandwidth and matmul rates, PCIe transfer rates, host memory bandwidth and CPU throughput |
+| engine | `engine` | What the engine reported: name, configuration, max context, drafting, bytes read per pass |
+| model | `model`, `model_sha256` | Name, repository and revision, format, architecture and quantization |
+| reference | `reference` | The reference that computed the quality scores (version, transformers, torch, GPU) and the package they came from |
+| run | `crit_eval_version`, `protocol`, `profile`, `requirements`, `timing` | Which `crit-eval`, protocol and profile measured it, the drift budget it was held to, and how long each part took |
+
+---
+
+<a id="commands"></a>
+
+## Commands
+
+| Command | Does |
+| --- | --- |
+| `probe` | Measure the device's bandwidth, cuBLASLt GEMM rates per weight format and raw tensor-core rates per input and accumulator format (needs nvcc) |
+| `context` | The max context for a model on a device: the model's positions and the device's memory |
+| `prepare` | Freeze the suite as token ids for one model |
+| `reference` | Score the prepared quality texts once on the checkpoint |
+| `fetch` / `pack` | Get a checkpoint's reference package, or add one to a package folder |
+| `pin` | Record an engine's plain greedy output of every speed case as the data's decode text |
+| `run` | Evaluate one engine, through `--url` or an `--adapter`; with an adapter, `--only quality` checks quality in process (development evidence) and `--attribute-drift` attributes the drift to matrix groups |
+| `status` / `compare` | Gates, goals, KPIs against their limits and gaps (`--kernels` joins a kernel trace to the prefill floor, `--device` and `--data` price a result again); results side by side |
+| `ab` | Alternate two engines' speed runs in one session and report paired ratios |
+| `kernels` | Trace every kernel of the speed cases (CUPTI, Linux), prefill on a fresh prompt, and rank them by GPU time per phase and prefill-floor term |
+
+---
+
+<a id="limitations"></a>
+
+## Limitations
+
+| Area | Current status |
+| --- | --- |
+| Quality reference | Quality is measured against the checkpoint as stored, for example an NVFP4 quantization, not against the full-precision model. `crit-eval` reports the drift the engine adds, never the quantization loss of the checkpoint itself, so quality results of two different quantizations of a model do not compare. |
+| What quality covers | Drift on fixed texts: six conversations (prose, code, math, tool calls and more) and one long text each at 1K, 4K and 32K tokens, as perplexity ratio and KL divergence. It is not a task benchmark: no accuracy on MMLU-style questions, coding tests or agent tasks. |
+| Reference coverage | The reference runs the model through transformers' modeling code in FP32, so it needs an architecture transformers implements and a CUDA GPU with the machine to itself for 5 to 25 minutes. Checkpoints in exl2 or exl3 are refused. Reference packages exist for three checkpoints and are not published yet. |
+| Rounding-sensitive models | Where a model amplifies rounding (MoE routing near-ties, sparse-attention ties, recurrent state), two valid FP32 runs of the reference disagree; quality is then judged against twice the reference's own spread instead of the budget, which is looser for those models. |
+| Speed | One request at a time: `crit-eval` measures single-stream decode, prefill and time to first token, not throughput under concurrent requests or batching. A noisy sampled decode is repeated at up to nine seeds per case, so an engine whose speed swings with the drawn text takes longer to measure (`--no-adaptive-sampled` keeps three, an override the result records). |
+| Hardware | NVIDIA GPUs only: the probe builds with nvcc and measures one GPU. Multi-GPU engines are not measured as such. PCIe, host memory and CPU rates are recorded, but no limit uses them yet, so engines that offload weights or compute on the CPU get GPU-only limits. On Windows the CPU probe uses AVX2, which under-reports an AVX-512 CPU. |
+| Long context | The hub profile measures the long-context curve at its two ends and interpolates the points between; only the full profile measures every point. |
+| Comparability | Results compare only under the same protocol series and profile, on prepared data of the same checkpoint. |
+
+---
+
+<a id="documentation"></a>
+
+## Documentation
+
+| To… | Read |
+| --- | --- |
+| Run `crit-eval` and read its results | [Guide](docs/README.md) |
+| See every case, score, limit and gate | [Measurements](docs/MEASUREMENTS.md) |
+| Set the required context | [Context](docs/CONTEXT.md) |
+| Plug in an engine without a server | [Adapter](docs/ADAPTER.md) |
+| Build an engine to measure | [crit](https://github.com/crit-labs/crit) · [Building engines](https://github.com/crit-labs/crit/blob/main/docs/BUILDING_ENGINES.md) |
+| See release history | [Changelog](CHANGELOG.md) |
+

crit_eval-0.1.1/README.md

@@ -0,0 +1,169 @@
+<div align="center">
+
+<p align="center">
+  <img src="docs/assets/wordmark-light.png#gh-light-mode-only" width="200" alt="crit" />
+  <img src="docs/assets/wordmark.png#gh-dark-mode-only" width="200" alt="crit" />
+  <br />
+</p>
+
+### Speed and quality measurement tool to compare inference engines honestly.
+
+[![Version 0.1.1](docs/assets/badge-version.svg)](CHANGELOG.md)
+[![License Apache-2.0](docs/assets/badge-license.svg)](LICENSE)
+[![Python 3.11+](docs/assets/badge-python.svg)](pyproject.toml)
+
+[Summary](#summary) • [Quick start](#quick-start) • [What `crit-eval` solves](#what-crit-eval-solves) •
+[What `crit-eval` measures](#what-eval-measures) • [Commands](#commands) • 
+[Limitations](#limitations) • [Documentation](#documentation)
+
+</div>
+
+---
+
+<a id="summary"></a>
+
+## Summary
+
+**`crit-eval` runs one fixed suite against every inference engine, so results compare.**
+> [!IMPORTANT]
+> The same prompts, output lengths, stop handling and quality references, through the same
+> OpenAI-compatible API a client uses. Every score is reported against its physical limit on your
+> GPU, and quality is measured as the drift the engine itself adds to the checkpoint you chose.
+> Results from different runs, agents and machines therefore compare, and engines submitted to
+> [crit-hub](https://github.com/crit-labs/crit-hub) are measured with its hub profile.
+
+---
+
+<a id="quick-start"></a>
+
+## Quick start
+
+```sh
+python -m pip install "crit-core @ git+https://github.com/crit-labs/crit#subdirectory=core/python"
+python -m pip install "crit-eval[reference] @ git+https://github.com/crit-labs/crit-eval"
+```
+
+Serve your engine behind an OpenAI-compatible API, then measure it:
+
+```sh
+crit-eval probe --out device.json
+crit-eval fetch --model MODEL_DIR --data EVAL_DATA_DIR --packages PACKAGES
+crit-eval run --url http://127.0.0.1:8000/v1 --model MODEL_DIR --data EVAL_DATA_DIR --device device.json \
+  --profile hub --out result.json
+crit-eval status result.json
+```
+
+`fetch` gets the checkpoint's [reference package](docs/MEASUREMENTS.md#quality) from `PACKAGES` (a folder or an
+https base URL) when it has one; without it,
+`crit-eval reference` scores the reference once on your GPU (the `reference` extra installs torch and
+transformers for that). Inside crit the same commands are `crit eval ...`. An engine without a server
+plugs in through a Python [adapter](docs/ADAPTER.md) instead of `--url`.
+
+---
+
+<a id="what-crit-eval-solves"></a>
+
+## What `crit-eval` solves
+
+**There is no shared way to measure a bespoke inference engine.**
+> Different bespoke inference engines report vastly different types of numbers. An honest comparison requires
+> downloading and running the engines yourself. `crit-eval` finally makes apples-to-apples comparison possible.
+
+**Physics-based evaluation lets you see what performance is left on the table.**
+> `crit-eval` measures your GPU's memory bandwidth and matrix-multiply rates and turns them into a limit for each
+> score. Its evaluation report can tell your coding agent how much performance can still be squeezed out of your
+> inference engine.
+
+**Speed that can't hide a quality loss.**
+> Many inference engines push decode and prefill speed with no regard for quality. `crit-eval` treats quality
+> as a first-class KPI. It measures not only inference speed but also quality regressions.
+
+**A hardware report rounds out the evaluation.**
+> The same model on the same inference engine but on two different machines can also lead to different inference
+> speeds, even if the GPU is the same. We make this transparent by also reporting the runner's hardware configuration.
+
+---
+
+<a id="what-eval-measures"></a>
+
+## What `crit-eval` measures
+
+| KPI or record | In the result | What it records |
+| --- | --- | --- |
+| **decode_greedy** | `status.kpis.decode_greedy` | Greedy decode tokens per second over six workloads (chat, code, math, tool calls, a long document, a 14K-token agent session), with run-to-run noise |
+| **decode_sampled** | `status.kpis.decode_sampled` | Decode tokens per second at the model's own sampling, the headline decode, and tokens per round for speculative engines; a case whose three seeds disagree is repeated at further seeds (up to 9) until its standard error is within 3%, and each case's error is reported |
+| **prefill** | `status.kpis.prefill` | Prompt tokens per second on the two long prompts |
+| **ttft** | `status.kpis.ttft` | Milliseconds to the first token over every workload |
+| **long-context decode and ttft** | `status.kpis.context` | The same scores along a curve of prompts up to the required context (262,144 tokens by default) |
+| **perplexity** | `status.kpis.perplexity` | The engine's perplexity over the reference's: the worst quality set (prompt and served tokens, each long length) against its limit; per set in `quality.sets` |
+| **kl_divergence** | `status.kpis.kl_divergence` | Mean and p99 KL divergence of the engine's token distributions from the reference's: the worst set against its limits; per set in `quality.sets` |
+| limits and gaps | `headroom` | Each KPI's physical limit on this machine, from the probe's best rate per format (cuBLASLt GEMM or raw tensor cores), and what each term (model pass, draft steps, verify pass, draft width, drafter acceptance, prefill, first token) would give at its floor |
+| prefill by activation format | `headroom.activations` | The prefill and TTFT ceilings with the quantized matrices' prompt activations at BF16, FP16 accumulation, FP8 and the stored format, which of them the quality evidence rules out, and the reachable limit: the fastest shown to pass |
+| prefill by term | `crit-eval status --kernels` | With a kernel trace, each prefill term (matmul per weight format, attention, recurrence, other kernels, host) against its floor, a gap per term, and a speculative round split into verify pass and draft steps |
+| time to first token by part | `headroom.ttft` | Each case's time to first token split into the engine's own prefill and first token and the rest (server, tokenizer, HTTP) |
+| quality noise and attribution | `quality.sets.*.budget_spread`, `quality.attribution` | Each set's share of the drift budget with its spread over its positions; with `--attribute-drift`, each matrix group's share of the budget |
+| free device memory | `context.device_memory` | Device memory left free with the engine built for the required context, beside the capacity gate |
+| gates | `status.gates` | Repeatable output, request history, prompt cache, retrieval, exactness, sampling and quality, each passed or not, with every KPI against its limit (`status.kpis`) |
+| retrieval | `context.retrieval` | Facts at the start, middle and end of long prompts, found or not |
+| exactness | `exactness` | Whether speculative output equals plain greedy, case by case |
+| sampling | `sampling_check` | Whether sampled tokens follow the model's distribution |
+| request history | `history` | Whether the same greedy requests give the same tokens after a long request history |
+| prompt cache | `followup` | Follow-up turns answered from a prompt cache: the same answer, and their prefill and ttft |
+| held-out prompts | `heldout` | Speed on ten prompts in other languages and styles, never used for tuning |
+| hardware | `host`, `device` | OS, CPU, RAM and GPUs (name, VRAM, driver, PCIe link), and the measured GPU bandwidth and matmul rates, PCIe transfer rates, host memory bandwidth and CPU throughput |
+| engine | `engine` | What the engine reported: name, configuration, max context, drafting, bytes read per pass |
+| model | `model`, `model_sha256` | Name, repository and revision, format, architecture and quantization |
+| reference | `reference` | The reference that computed the quality scores (version, transformers, torch, GPU) and the package they came from |
+| run | `crit_eval_version`, `protocol`, `profile`, `requirements`, `timing` | Which `crit-eval`, protocol and profile measured it, the drift budget it was held to, and how long each part took |
+
+---
+
+<a id="commands"></a>
+
+## Commands
+
+| Command | Does |
+| --- | --- |
+| `probe` | Measure the device's bandwidth, cuBLASLt GEMM rates per weight format and raw tensor-core rates per input and accumulator format (needs nvcc) |
+| `context` | The max context for a model on a device: the model's positions and the device's memory |
+| `prepare` | Freeze the suite as token ids for one model |
+| `reference` | Score the prepared quality texts once on the checkpoint |
+| `fetch` / `pack` | Get a checkpoint's reference package, or add one to a package folder |
+| `pin` | Record an engine's plain greedy output of every speed case as the data's decode text |
+| `run` | Evaluate one engine, through `--url` or an `--adapter`; with an adapter, `--only quality` checks quality in process (development evidence) and `--attribute-drift` attributes the drift to matrix groups |
+| `status` / `compare` | Gates, goals, KPIs against their limits and gaps (`--kernels` joins a kernel trace to the prefill floor, `--device` and `--data` price a result again); results side by side |
+| `ab` | Alternate two engines' speed runs in one session and report paired ratios |
+| `kernels` | Trace every kernel of the speed cases (CUPTI, Linux), prefill on a fresh prompt, and rank them by GPU time per phase and prefill-floor term |
+
+---
+
+<a id="limitations"></a>
+
+## Limitations
+
+| Area | Current status |
+| --- | --- |
+| Quality reference | Quality is measured against the checkpoint as stored, for example an NVFP4 quantization, not against the full-precision model. `crit-eval` reports the drift the engine adds, never the quantization loss of the checkpoint itself, so quality results of two different quantizations of a model do not compare. |
+| What quality covers | Drift on fixed texts: six conversations (prose, code, math, tool calls and more) and one long text each at 1K, 4K and 32K tokens, as perplexity ratio and KL divergence. It is not a task benchmark: no accuracy on MMLU-style questions, coding tests or agent tasks. |
+| Reference coverage | The reference runs the model through transformers' modeling code in FP32, so it needs an architecture transformers implements and a CUDA GPU with the machine to itself for 5 to 25 minutes. Checkpoints in exl2 or exl3 are refused. Reference packages exist for three checkpoints and are not published yet. |
+| Rounding-sensitive models | Where a model amplifies rounding (MoE routing near-ties, sparse-attention ties, recurrent state), two valid FP32 runs of the reference disagree; quality is then judged against twice the reference's own spread instead of the budget, which is looser for those models. |
+| Speed | One request at a time: `crit-eval` measures single-stream decode, prefill and time to first token, not throughput under concurrent requests or batching. A noisy sampled decode is repeated at up to nine seeds per case, so an engine whose speed swings with the drawn text takes longer to measure (`--no-adaptive-sampled` keeps three, an override the result records). |
+| Hardware | NVIDIA GPUs only: the probe builds with nvcc and measures one GPU. Multi-GPU engines are not measured as such. PCIe, host memory and CPU rates are recorded, but no limit uses them yet, so engines that offload weights or compute on the CPU get GPU-only limits. On Windows the CPU probe uses AVX2, which under-reports an AVX-512 CPU. |
+| Long context | The hub profile measures the long-context curve at its two ends and interpolates the points between; only the full profile measures every point. |
+| Comparability | Results compare only under the same protocol series and profile, on prepared data of the same checkpoint. |
+
+---
+
+<a id="documentation"></a>
+
+## Documentation
+
+| To… | Read |
+| --- | --- |
+| Run `crit-eval` and read its results | [Guide](docs/README.md) |
+| See every case, score, limit and gate | [Measurements](docs/MEASUREMENTS.md) |
+| Set the required context | [Context](docs/CONTEXT.md) |
+| Plug in an engine without a server | [Adapter](docs/ADAPTER.md) |
+| Build an engine to measure | [crit](https://github.com/crit-labs/crit) · [Building engines](https://github.com/crit-labs/crit/blob/main/docs/BUILDING_ENGINES.md) |
+| See release history | [Changelog](CHANGELOG.md) |
+