quantgap 0.1.0__tar.gz

quantgap-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+.venv/
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+quantgap-results/
+tests/fixtures/tiny_model/
+tests/fixtures/tiny_pack/
+*.gguf
+site/dist/
+.env
+.DS_Store
+packs/

quantgap-0.1.0/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 0.1.0 (unreleased)
+
+First version.
+
+- `quantgap pack`: run a reference model once, save a shareable pack (top-k log probabilities,
+  hashes, manifest). Optional upload to the Hugging Face Hub.
+- `quantgap score`: KLD (mean, worst 1%, worst 0.1%, bootstrap interval), top-1 agreement,
+  perplexity ratio, per-group numbers, and visible-damage checks (loops, wrong script, JSON).
+- `quantgap compare`: score many quants, table, quality-vs-size chart, memory-budget recommendation.
+- `quantgap submit`: dry-run or open a pull request with a hashed result.
+- Backends: llama.cpp (GGUF), MLX (untested), any OpenAI-compatible server with prompt logprobs,
+  Transformers.
+- Probe set v1: 160 openly licensed texts in 6 groups.
+- Static leaderboard builder (`site/build.py`).

quantgap-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

quantgap-0.1.0/PKG-INFO

@@ -0,0 +1,311 @@
+Metadata-Version: 2.5
+Name: quantgap
+Version: 0.1.0
+Summary: How much did this quant lose? Measure how far a quantized LLM drifts from the original, without running the original.
+Project-URL: Homepage, https://github.com/saqlain2204/quantgap
+Project-URL: Issues, https://github.com/saqlain2204/quantgap/issues
+Project-URL: Changelog, https://github.com/saqlain2204/quantgap/blob/main/CHANGELOG.md
+Author-email: Mohammed Saqlain <saqlain2204@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: benchmark,gguf,kl-divergence,llama.cpp,llm,local-llm,mlx,quantization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: huggingface-hub>=0.24
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: numpy>=1.26
+Requires-Dist: pyarrow>=15
+Requires-Dist: pydantic>=2.7
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Provides-Extra: all
+Requires-Dist: accelerate>=0.33; extra == 'all'
+Requires-Dist: llama-cpp-python>=0.3; extra == 'all'
+Requires-Dist: protobuf; extra == 'all'
+Requires-Dist: sentencepiece; extra == 'all'
+Requires-Dist: torch>=2.3; extra == 'all'
+Requires-Dist: transformers>=4.44; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: accelerate>=0.33; extra == 'dev'
+Requires-Dist: gguf>=0.10; extra == 'dev'
+Requires-Dist: protobuf; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Requires-Dist: sentencepiece; extra == 'dev'
+Requires-Dist: tokenizers>=0.19; extra == 'dev'
+Requires-Dist: torch>=2.3; extra == 'dev'
+Requires-Dist: transformers>=4.44; extra == 'dev'
+Provides-Extra: hf
+Requires-Dist: accelerate>=0.33; extra == 'hf'
+Requires-Dist: torch>=2.3; extra == 'hf'
+Requires-Dist: transformers>=4.44; extra == 'hf'
+Provides-Extra: llamacpp
+Requires-Dist: llama-cpp-python>=0.3; extra == 'llamacpp'
+Provides-Extra: mlx
+Requires-Dist: mlx-lm>=0.20; extra == 'mlx'
+Provides-Extra: pack
+Requires-Dist: accelerate>=0.33; extra == 'pack'
+Requires-Dist: protobuf; extra == 'pack'
+Requires-Dist: sentencepiece; extra == 'pack'
+Requires-Dist: torch>=2.3; extra == 'pack'
+Requires-Dist: transformers>=4.44; extra == 'pack'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/saqlain2204/quantgap/main/assets/logo-banner.svg" alt="quantgap: how much did this quant lose?" width="560">
+</p>
+
+<h1 align="center">quantgap: how much did this quant lose?</h1>
+
+<p align="center">
+  <a href="https://github.com/saqlain2204/quantgap/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/saqlain2204/quantgap/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://huggingface.co/quantgap-packs"><img alt="Packs on Hugging Face" src="https://img.shields.io/badge/packs-Hugging%20Face-f59e0b"></a>
+  <a href="https://saqlain2204.github.io/quantgap/"><img alt="Leaderboard" src="https://img.shields.io/badge/leaderboard-site-f59e0b"></a>
+  <img alt="Python 3.11+" src="https://img.shields.io/badge/python-3.11%2B-3b82f6">
+  <a href="LICENSE"><img alt="License: Apache-2.0" src="https://img.shields.io/badge/license-Apache--2.0-3b82f6"></a>
+</p>
+
+**quantgap measures how far a quantized model drifts from the original, on your own machine, without running the original.**
+
+```text
+Which quant should I download?   Q4_K_M?  UD-Q4_K_XL?  IQ3_XXS?  NVFP4?
+```
+
+People answer that with feelings. quantgap answers it with a number: how much each quant moved away
+from the real model, measured the same way for every publisher and every format.
+
+## Quickstart
+
+```bash
+pip install "quantgap[llamacpp]"
+
+# how much did this one file lose?
+quantgap score hf://<publisher>/<model>-GGUF/<file>.gguf
+
+# score many quants of one model, draw a chart, and get a pick for your memory
+quantgap compare --repo <publisher>/<model>-GGUF --glob "*Q4*" --budget 16GB --chart chart.svg
+```
+
+You need a **pack** for the model (the original's answers on a fixed set of texts, made once and
+shared). Pass one with `--pack`, or let quantgap look one up on the Hub. See
+[Make a pack for your own model](#make-a-pack-for-your-own-model).
+
+## Sample result (real, small, one machine)
+
+Model: `Qwen/Qwen2.5-0.5B-Instruct` (Apache-2.0). Its pack is public at
+[quantgap-packs/Qwen2.5-0.5B-Instruct](https://huggingface.co/datasets/quantgap-packs/Qwen2.5-0.5B-Instruct),
+so `quantgap score hf://bartowski/Qwen2.5-0.5B-Instruct-GGUF/Qwen2.5-0.5B-Instruct-Q4_K_M.gguf` finds it by itself. The numbers below were measured by quantgap on one
+CPU laptop, against a pack made from the original weights. Full table, hashes and settings:
+[docs/RESULTS.md](docs/RESULTS.md).
+
+| Publisher | Quant | Size | KLD mean (95% interval) | Worst 1% | Top-1 | PPL ratio | Loops (quant / original) | Wrong script | JSON ok |
+|---|---|---|---|---|---|---|---|---|---|
+| bartowski | Q8_0 | 531.1 MB | 0.0027 (0.0024 to 0.0031) | 0.027 | 97.1% | 1.003 | 5 / 6 | 0 | 2 / 2 |
+| bartowski | Q6_K | 505.7 MB | 0.0069 (0.0057 to 0.0083) | 0.064 | 95.5% | 1.008 | 8 / 6 | 0 | 2 / 2 |
+| bartowski | Q5_K_M | 420.1 MB | 0.0241 (0.0190 to 0.0298) | 0.264 | 92.3% | 1.024 | 5 / 6 | 0 | 2 / 2 |
+| bartowski | Q4_K_M | 397.8 MB | 0.0389 (0.0316 to 0.0478) | 0.376 | 89.9% | 1.041 | 6 / 6 | 0 | 2 / 2 |
+| Qwen | Q4_K_M | 491.4 MB | 0.0787 (0.0627 to 0.0950) | 0.807 | 85.8% | 1.064 | 7 / 6 | 0 | 2 / 2 |
+| bartowski | Q3_K_M | 355.5 MB | 0.0828 (0.0672 to 0.1009) | 0.852 | 85.9% | 1.073 | 7 / 6 | 0 | 2 / 2 |
+| bartowski | Q2_K | 338.6 MB | 0.2052 (0.1672 to 0.2386) | 2.080 | 77.8% | 1.200 | 9 / 6 | 0 | 2 / 2 |
+
+Quick mode (first 25% of each group, 12 greedy prompts), llama.cpp on CPU, one machine. Lower KLD is better. Loops are counted out of 12 prompts, so differences of one or two are noise.
+
+![quality versus size](docs/chart.svg)
+
+**One finding worth a second look:** the two files labelled `Q4_K_M` are not the same quality. The official Qwen file (491 MB) drifted about twice as far (KLD 0.0787) as bartowski's (398 MB, KLD 0.0389), and the intervals do not overlap. We did not investigate why. A label like `Q4_K_M` names a recipe, not one fixed result, which is the point of measuring.
+
+The numbers fall steadily with file size: Q8_0 and Q6_K stay close to the original, Q4_K_M is a clear
+step away, and Q2_K has drifted a lot. This is a small model on one machine in quick mode, so treat it as
+a demonstration of the tool, not a verdict on these quants.
+
+## How it works
+
+```
+        (once per model: big machine, Kaggle, or HF Jobs)
+ original model ──► quantgap pack ──► pack (small files) ──► Hugging Face Hub
+                                                                  │
+        (you, on your own laptop)                                 ▼
+ quant file / server ──► backend ──► per-position scores ──► quantgap score ◄── pack
+                                                                  │
+                                                  table + chart + result JSON
+                                                                  │
+                                            quantgap submit ──► pull request ──► leaderboard
+```
+
+1. **Pack (once).** `quantgap pack` runs the full-size model over 160 fixed texts and saves its
+   top 32 next-token guesses at every position. That is about 20 MB, not many GB. **Teacher
+   forcing** means we feed the same text to both models and compare their guesses at every
+   position. Nobody generates anything, so it is fair and fast.
+2. **Score (anyone).** `quantgap score` runs your quant on the same texts on your own machine
+   (llama.cpp, MLX, Transformers, or any vLLM server) and compares.
+3. **Share.** `quantgap submit` sends the result, with the SHA-256 of the quant file and of the
+   pack, so anyone can re-run it and get the same number.
+
+## What the numbers mean
+
+**Lower KLD is better.**
+
+| Number | In plain words |
+|---|---|
+| **KLD mean** | One number for how far the quant's next-token probabilities are from the original's. 0 means identical. A 95% interval comes with it. |
+| **KLD worst 1%** | The 99th percentile. A mean can hide rare big failures. This catches them. |
+| **Top-1 agreement** | How often the quant's best guess is the same as the original's. |
+| **Perplexity ratio** | How much more surprised the quant is by real text. 1.0 means no change. |
+| **Loops** | Short greedy generations where the model repeats itself. Shown next to the original's count. |
+| **Wrong script** | A Chinese, Cyrillic, Arabic or Hindi character appears in English, code, math or JSON text where the original had none. |
+| **Valid JSON** | Of 8 prompts that ask for a JSON object, how many parse. Shown next to the original's count. |
+
+Numbers are also given for each group of texts: general, chat, code, math, multilingual
+(Hindi, Chinese, Spanish, Arabic) and JSON. The maths is explained in plain words in
+[docs/method.md](docs/method.md).
+
+## What quantgap does not tell you
+
+- **It is not a skill benchmark.** It measures drift from the original, not how good the model is
+  at your task. Less drift is not always better for you.
+- **It is not a speed benchmark.** Use `llama-bench` or [llmfit](https://github.com/AlexsJones/llmfit) for speed.
+- **The KLD is a lower bound.** To keep packs small we keep the original's top 32 guesses and
+  lump everything else into one bucket. That can only make two models look closer, never further
+  apart. It ranks quants well. Its absolute values are a little lower than llama.cpp's
+  full-vocabulary numbers. Compare quantgap numbers with quantgap numbers.
+- **Ollama is not supported yet.** Ollama does not return the model's scores for the input text.
+  You can score the GGUF file Ollama already downloaded (`ollama show --modelfile NAME` prints
+  its path).
+- **Big models need someone with a big machine.** The MVP targets models up to about 32B
+  parameters.
+
+## Make a pack for your own model
+
+```bash
+pip install "quantgap[pack]"
+quantgap pack <org>/<model> --revision <full commit sha> --license <license> --push <you>/<name>
+```
+
+Free option: [`notebooks/make_pack_kaggle.ipynb`](notebooks/make_pack_kaggle.ipynb) runs it on a
+Kaggle T4 x2. Details, memory guidance and licensing rules are in [docs/packs.md](docs/packs.md).
+Check that the model's license allows sharing its outputs first.
+
+You fine-tuned a small model and want to know how much Q4_K_M hurts it? Make a pack for your
+fine-tune, then score the GGUF against it.
+
+## Backends
+
+| Backend | For | Install | Status |
+|---|---|---|---|
+| `llamacpp` | GGUF on CPU, CUDA, Metal | `pip install "quantgap[llamacpp]"` | tested here (real GGUF files) |
+| `openai` | any OpenAI-compatible server that returns prompt logprobs (vLLM: NVFP4, AWQ, GPTQ, FP8) | built in, use `--base-url` | tested against a fake server that follows the vLLM docs, not a live GPU |
+| `hf` | Transformers, bitsandbytes | `pip install "quantgap[hf]"` | tested here (the reference path) |
+| `mlx` | Apple silicon | `pip install "quantgap[mlx]"` | **written but not run on a Mac yet** |
+
+```bash
+# a vLLM server
+quantgap score openai://Qwen2.5-0.5B-Instruct-NVFP4 --base-url http://localhost:8000/v1 --pack <pack>
+```
+
+A server only reports its own top-N tokens, so those results are marked **approximate**.
+
+## Submit a result
+
+```bash
+quantgap score ./my-quant.gguf --pack <pack>          # writes quantgap-results/<name>.json
+quantgap submit quantgap-results/<name>.json --dry-run # shows exactly what would be sent
+export HF_TOKEN=hf_...
+quantgap submit quantgap-results/<name>.json           # opens a pull request
+```
+
+`--quick` results are for a fast first look and cannot be submitted.
+
+## Use it in CI
+
+```bash
+quantgap score --backend openai --base-url "$URL" --model-name "$NAME" --json out.json openai://"$NAME"
+python -c "import json,sys; sys.exit(json.load(open('out.json'))['metrics']['kld_mean'] > 0.02)"
+```
+
+Fail the build if your inference engine fork starts to drift.
+
+## Commands
+
+```
+quantgap pack MODEL_REPO [--revision SHA] [--k 32] [--device auto|cuda|cpu] [--out DIR] [--push ORG/NAME]
+quantgap packs list | show PACK_REF
+quantgap score QUANT [--pack PACK_REF] [--backend auto|llamacpp|mlx|openai|hf] [--quick] [--json OUT]
+quantgap compare QUANT... | --repo ORG/REPO --glob "*Q4*.gguf" [--budget 16GB] [--chart out.svg]
+quantgap submit RESULT.json [--dry-run]
+quantgap inspect RESULT.json
+quantgap doctor [--selftest]
+```
+
+`quantgap doctor` tells you which backends are installed and which extra to add.
+
+## Comparison with other tools
+
+| Project | What it does | What quantgap adds |
+|---|---|---|
+| llama.cpp `llama-perplexity --kl-divergence` | Built-in KLD of a GGUF against a saved logits file from the BF16 model. | You must run the BF16 model yourself and the logits file is huge. quantgap shares small packs, works beyond GGUF, and adds a report. We learned from it: it is the prior art. |
+| [kld-sweep](https://github.com/cmhamiche/kld-sweep) | Loops `llama-perplexity` over a folder of GGUFs, with CSV and a chart. | Same idea, nice and simple. quantgap removes the need for a local BF16 run and adds damage checks and a shared leaderboard. |
+| [mlx-kld](https://github.com/asher/mlx-kld) | KLD for MLX and GGUF with a local teacher cache. | quantgap makes the "teacher cache" a shareable pack and covers more backends. |
+| [GGUF-Tool-Suite](https://github.com/Thireus/GGUF-Tool-Suite) | Builds custom mixed quants to a target size. | It makes quants, quantgap judges them. They fit together. |
+| [quant-fidelity-frontier](https://github.com/delirious6423/quant-fidelity-frontier) | Collects numbers that publishers reported. | quantgap measures with one method and records hashes. |
+| [llmfit](https://github.com/AlexsJones/llmfit) | Which models fit your hardware, and how fast. | quantgap is the measured-quality half. |
+
+## FAQ
+
+**Why are my numbers a bit different from llama.cpp's KLD?** quantgap keeps the top 32 guesses and
+a tail bucket, so it is a lower bound. See [docs/faq.md](docs/faq.md).
+
+**Why not Ollama?** Ollama does not return the model's scores for the input text, so we cannot
+compare fairly. Score the GGUF file it downloaded instead.
+
+**Is my data sent anywhere?** No. quantgap has no telemetry. It only talks to the Hugging Face Hub
+(downloads, and uploads you ask for) and to a server you name with `--base-url`.
+
+**Why does it stop with a tokenizer error?** The quant must use the same token ids as the pack.
+quantgap checks and never fixes a mismatch silently.
+
+More in [docs/faq.md](docs/faq.md).
+
+## Not yet
+
+- Scoring through Ollama (it does not return the model's scores for the input text).
+- Task benchmarks such as MMLU or coding pass rates. quantgap measures drift, not skill.
+- Packing models above about 32B parameters (memory limits on free hardware).
+- Vision and audio models.
+- Speed benchmarks (use `llama-bench` or llmfit).
+- KV-cache quantization effects.
+
+## Development
+
+```bash
+git clone https://github.com/saqlain2204/quantgap && cd quantgap
+pip install -e ".[dev]" llama-cpp-python
+python scripts/make_tiny_model.py      # tiny model + tiny GGUF for tests (also built by the tests)
+python -m pytest
+python -m ruff check . && python -m ruff format --check .
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add a backend and how to submit a pack. The
+original build spec is in [docs/SPEC.md](docs/SPEC.md).
+
+## Credits
+
+- **llama.cpp** and its `--kl-divergence` tooling are the prior art this builds on.
+- **[kld-sweep](https://github.com/cmhamiche/kld-sweep)** and **[mlx-kld](https://github.com/asher/mlx-kld)** are related work.
+- Probe texts come from Wikipedia (CC BY-SA 4.0), Dolly-15k (CC BY-SA 3.0) and GSM8K (MIT). See
+  [`SOURCES.md`](src/quantgap/probes/data/SOURCES.md).
+
+## License
+
+Code: Apache-2.0. Results dataset: CC BY 4.0. Each pack's dataset card states the license of the
+original model and that the pack holds model outputs (log probabilities), not weights.