Skip to main content

Tiny, drop-in Hugging Face KV cache compression using KIVI-style low-bit KV storage.

Project description

tiny-turboquant

A transformers.DynamicCache you can swap in for past_key_values= to shrink KV-cache storage by 3–4× on Hugging Face decoder-only models that support DynamicCache / past_key_values. No calibration set, no fine-tuning, no model surgery — just construct and swap.

from tiny_turboquant import TinyKVCache

cache = TinyKVCache(compression="safe")
outputs = model(**inputs, past_key_values=cache, use_cache=True)

That's the whole integration. Everything below is optional.


Install

pip install tiny-turboquant

Or from source:

git clone https://github.com/pradeepboopathy/tiny-turboquant
cd tiny-turboquant && pip install -e .

torch >= 2.2, transformers >= 4.49, numpy, scipy. Python 3.10+.

Quick Start

Drop into any Hugging Face decoder-only model

from transformers import AutoModelForCausalLM, AutoTokenizer
from tiny_turboquant import TinyKVCache
import torch

model = AutoModelForCausalLM.from_pretrained(
    "Qwen/Qwen2.5-3B-Instruct", dtype=torch.float16, device_map="auto",
)
tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen2.5-3B-Instruct")

# Create a compressed cache
cache = TinyKVCache(compression="safe")   # ~3× smaller, quality-first preset

# Use it like a normal past_key_values
inputs = tokenizer("Hello, how are you?", return_tensors="pt").to(model.device)
outputs = model(**inputs, past_key_values=cache, use_cache=True)

Asymmetric K/V (more savings, similar quality)

cache = TinyKVCache(key_bits=4, value_bits=2)   # ~4× smaller

Protect boundary layers (best quality at the same bits)

cache = TinyKVCache.for_model(
    model, compression="balanced", protect_first=2, protect_last=2,
)

Let the library pick bits for you

cache = TinyKVCache.from_pretrained_model(model, tokenizer)

Runs one short forward pass to measure K/V dynamic range, then constructs the cache with the recommended key_bits/value_bits. Pass return_report=True to also get the KVNormReport back.

Run the inference server

Ships with an OpenAI-compatible HTTP server (FastAPI, SSE streaming). Point any OpenAI client at it:

pip install "tiny-turboquant[server]"
tiny-turboquant-server --model Qwen/Qwen2.5-3B-Instruct --compression safe --port 8000
curl http://localhost:8000/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"Hello!"}],"max_tokens":100}'

Set "stream": true in the request body to get token-by-token SSE chunks.

Knobs that actually move the needle

Compression preset. The default knob is a named preset, not a bit count. Four settings cover every real use case:

TinyKVCache(compression="safe")        # K4/V4   default, best quality (~3.3x)
TinyKVCache(compression="balanced")    # K4/V3   recommended tradeoff
TinyKVCache(compression="compact")     # K3/V3   storage-focused
TinyKVCache(compression="aggressive")  # K3/V2 group=32   experimental

Under the hood these map to (key_bits, value_bits) of (4, 4), (4, 3), (3, 3), and (3, 2) respectively. If you want to pick the bits yourself, pass them directly instead of compression=:

TinyKVCache(key_bits=4, value_bits=2)

The two paths are mutually exclusive — mixing them raises ValueError.

Pick a preset from the model itself. Keys usually carry more dynamic range than values in Llama/Qwen/Mistral-family models. The diagnostic runs one forward pass with hooks on every k_proj / v_proj and tells you whether the asymmetric preset will help:

from tiny_turboquant import measure_kv_norm_ratio, recommend_bits

report = measure_kv_norm_ratio(model, tokenizer)

# Quality-first default: safest public recommendation.
rec = recommend_bits(report)  # usually K4/V4

# Tradeoff mode: more compression, validate on your task.
# rec = recommend_bits(report, mode="balanced")  # often K4/V3

cache = TinyKVCache.for_model(
    model,
    key_bits=rec["key_bits"],
    value_bits=rec["value_bits"],
)

Boundary-layer protection. Embedding-adjacent and logit-adjacent layers are noticeably more bit-sensitive than the middle. Keeping the outer layers at FP16 costs little memory and recovers most of the small PPL delta:

TinyKVCache.for_model(
    model, compression="balanced", protect_first=2, protect_last=2,
)

Use for_model (not the bare constructor) whenever you set protect_last or pass negative indices — the cache needs to know model.config.num_hidden_layers.

arg default notes
compression preset: "safe" | "balanced" | "compact" | "aggressive"
bits 4 (advanced) symmetric bit width, used when no preset
key_bits / value_bits (advanced) per-stream bit widths; override bits
protect_first / protect_last 0 keep this many boundary layers at FP16
protected_layers explicit layer indices (negatives allowed via for_model)

Command-line tools

Three ship with the package — all thin wrappers; the actual work happens in TinyKVCache.

# OpenAI-compatible HTTP server (FastAPI + SSE streaming)
pip install "tiny-turboquant[server]"
tiny-turboquant-server --model Qwen/Qwen2.5-3B-Instruct --compression safe

# Sliding-window WikiText-2 perplexity, writes a JSON report
tiny-turboquant-eval --model Qwen/Qwen2.5-3B-Instruct --key-bits 4 --value-bits 2

# Token-by-token agreement A/B against stock DynamicCache
tiny-turboquant-validate --model Qwen/Qwen2.5-3B-Instruct --compression balanced

Server endpoints: POST /v1/chat/completions (supports "stream": true SSE), GET /v1/models, GET /health.

The algorithm in three lines

1. for keys:   per-channel asymmetric affine quant (min/max along token axis)
               within a block of 128 tokens — absorbs outlier channels
2. for values: per-token asymmetric affine quant (min/max along channel axis)
               within the same block — matches the granularity attention
               actually reads at
3. keep the most recent N tokens (default 128) uncompressed in an FP16
               residual window

This matches the KIVI-2 scheme. Earlier versions used random-rotation + a closed-form Beta-distribution codebook from the TurboQuant paper; that path was elegant but assumed a marginal distribution real attention streams don't have, and degraded badly at low bits. Empirical per-channel scaling is both simpler and substantially more accurate on real models.

Measured quality

WikiText-2-raw test split, sliding window 2048, prompt 5230 tokens. Strictly monotone Pareto frontier across both model sizes:

preset bits 3B ratio / ΔPPL 0.5B ratio / ΔPPL status
safe K4/V4 3.34x / +0.07 3.26x / +0.23 default
balanced K4/V3 3.71x / +0.24 3.61x / +0.59 recommended tradeoff
compact K3/V3 4.18x / +0.45 4.05x / +1.41 storage-focused
aggressive K3/V2 gs=32 4.31x / +0.81 4.31x / +2.80 experimental

aggressive applies grouped V quantization (value_group_size=32): each token's value vector is split into head_dim / 32 groups and each group gets its own scale/zero pair. This is what lets 2-bit V stay usable. To opt out, pass value_group_size=None.

safe is the lowest-drift preset in our Qwen2.5 tests and scales with model size — the PPL gap shrinks from +0.23 on 0.5B to +0.07 on 3B. Reach for balanced when you want more compression with mild quality cost; compact when storage matters more than a small PPL bump; aggressive only after validating on your task (the 0.5B numbers warn that quality cliffs exist on small models).

TinyKVCache uses KIVI-style block affine quantization for live KV-cache compression. TinyQuantizer is kept as a standalone experimental vector quantizer and is not used by the cache path. TinyQuantizerIP is deprecated for attention experiments because JL residual noise can be amplified by softmax.

Performance

Decode-loop overhead vs. stock DynamicCache on Qwen2.5-3B-Instruct, T4 GPU, 4096-token context, 64 new tokens, balanced preset:

cache decode ms/tok overhead
DynamicCache fp16 73.0 ms 1.00×
TinyKVCache (PyTorch) 87.9 ms 1.20×
TinyKVCache (Triton) 80.6 ms 1.10×

Overhead is essentially all dequant cost — attention compute is unchanged. The Triton path is opt-in (use_triton=True) in 0.16.x while it accumulates generation/PPL coverage; it replaces the PyTorch dequant with a fused per-(batch, head, token) kernel and is bit-exact vs. the PyTorch path (max |diff| = 0 across all 4 presets on T4). Per-layer dequant cost at (B=1, H=16, D=128, ctx=4096) on T4:

preset PyTorch Triton speedup
safe 2.9 ms 1.3 ms 2.32×
balanced 4.2 ms 2.6 ms 1.63×
aggressive 4.3 ms 2.7 ms 1.59×
compact 5.5 ms 3.9 ms 1.41×

Two non-obvious notes:

  • compact is slower than aggressive, despite using more bits per value. Per-token V scales pay an allocation cost that aggressive's grouped V (one scale per 32 channels) avoids. Pick compact for quality reasons, not perf reasons.
  • T4 is memory-bandwidth-limited; the overhead ratio is smaller on A100/H100. Per-token throughput scales accordingly.

CUDA fast path

TinyKVCache(..., use_triton=...) controls the read-path dequant backend. Two modes:

  • False (default) — always use the PyTorch dequant path.
  • True — use the fused Triton kernel; raises on CUDA tensors if Triton or CUDA is missing.

The Triton path is bit-exact vs. PyTorch on the four shipped presets (max |diff| = 0 across safe / balanced / compact / aggressive on T4, fp16) but is opt-in in 0.16.x until it has broader generation/PPL coverage. It will become the default in a future release. The Triton kernels live in tiny_turboquant.triton_dequant.

Where it earns its keep, where it doesn't

Useful when KV memory is the bottleneck — long contexts on a single GPU, many concurrent serving sessions, or running one model size larger by buying back VRAM from the cache. Not useful for short contexts (< 1k tokens; the cache is already small), for hybrid / recurrent architectures that don't keep a standard KV cache (Mamba, RWKV), or for tasks that need bit-exact reproducibility.

References

Architecture deep-dive: docs/ARCHITECTURE.md.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tiny_turboquant-0.17.0.tar.gz (61.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tiny_turboquant-0.17.0-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

Details for the file tiny_turboquant-0.17.0.tar.gz.

File metadata

  • Download URL: tiny_turboquant-0.17.0.tar.gz
  • Upload date:
  • Size: 61.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for tiny_turboquant-0.17.0.tar.gz
Algorithm Hash digest
SHA256 ceca576005176f6ba5a871c90cacae19c8b83da71fdf50108105d235fd33d965
MD5 f926cad58700b4f1a646c2b12f96810c
BLAKE2b-256 8e1d2903d4bf3daf692b764b249e011e1c294fbd2ff53bd11d328db75b3e82b0

See more details on using hashes here.

File details

Details for the file tiny_turboquant-0.17.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tiny_turboquant-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d5f5f44beea85e6b28112b80814fa6ecd9e18389704faa10cecca96ccdec10c
MD5 c8f13c16aac3073c5473506fb44ae488
BLAKE2b-256 c467a10f7561d5b2d72d44ecc48dc7350059f078be97b7795dc302e2696a2ff7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page