16 Commits
Author SHA1 Message Date
7001bde828 docs: update all references — PR #45 merged to main
Weight compression is now on feature/turboquant-kv-cache (main).
No separate branch needed. PR #45 remains open for community logs.

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-03 11:27:00 -05:00
ae7f05cc8e docs: add community results page for TQ4_1S weight compression
12+ GPUs, 11+ models, 6 families, 10+ independent testers. All data
from PR #45 community testing. Includes GPU compatibility matrix,
model results by family, stacking validation, decode speed comparison,
known issues, confidence ratings, and contribution template.

Linked from getting-started.md.

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-03 10:20:38 -05:00
71fecb3aae docs: point test results to PR #45, update backend support (Metal + CUDA + AMD HIP)
Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 11:09:09 -05:00
3cba8d2601 docs: add AMD HIP Windows build instructions with required optimization flags
clang on Windows does not inherit CMake Release flags. Without -O3 -DNDEBUG
the build runs ~50x slower. Tested on RX 9070 XT (gfx1201, RDNA 4).

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 11:02:27 -05:00
826f926cc1 docs: remove duplicate quantize steps, reference Quick Test instead
Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 10:06:40 -05:00
8ef30366df docs: include filenames in size comparison output
Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 10:03:26 -05:00
e1c0c69211 docs: show model size before/after compression in quick test
Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 10:01:38 -05:00
0a5a151c37 docs: add quick test workflow for PR #45 testers
- Update backend support: Metal + CUDA (was Metal only)
- Add copy-paste Quick Test section: clone, build, compress, bench
- Recommend Qwen3.5-27B as test model (known good, fits 32GB)
- Explicit instructions to paste results back in PR #45
- Note Windows MSVC support

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-02 10:00:55 -05:00
f15e998190 docs: add PR #45 link to paper and getting-started
Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-01 21:25:14 -05:00
d860058da9 docs: TQ4_1S weight compression paper and getting-started update
Add weight-compression-tq4.md paper documenting:
- TQ4_1S format design (4-bit WHT-rotated, 16 Lloyd-Max centroids)
- Config I policy discovery through systematic tensor-role isolation
- V2.1 fused Metal kernel (zero threadgroup memory, NR0=8)
- Cross-model validation: Qwen 1.5B/27B/35B-MoE/72B, Phi-4, Llama 70B
- Llama-specific hybrid/premium configs with Q4_K/Q5_K FFN
- Model family sensitivity analysis (Llama 6-8x per-layer error vs Qwen)

Update getting-started.md:
- Add weight compression section with correct --tensor-type-file commands
- Add tested models table with compressed sizes
- Add predicted model compatibility matrix
- Add Config I / Hybrid / Premium definitions
- Note Metal-only runtime limitation

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-01 21:13:36 -05:00
05fde211c0 Add head_dim=64 limitation warning to getting-started guide
Models with head_dim=64 (e.g., GPT-OSS-120B) may crash or produce
degraded output with turbo compression. WHT requires sufficient
dimensionality for CLT convergence. Reported by NigelTufnel12345.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: tturney@psyguard.ai
2026-04-01 12:17:43 -05:00
c760dc58d1 Update docs with community validation and benchmarking guide improvements
- Add compression reference table and config warning to getting-started.md
- Add independent validation from sztlink, Madreag, and mudler (APEX/LocalAI) across asymmetric, layer-aware, MoE, and sparse V papers
- Update sparse-v-dequant.md with Madreag 4-GPU cross-validation
- Minor README wording fix (branch -> repository)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: tturney@psyguard.ai
2026-04-01 11:25:15 -05:00
81360216b5 Fix wikitext download link in getting started guide
Replace parquet link with direct raw text download. Add HF CLI as
alternative. Credit: @henkiespenkie44

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-31 13:38:15 -05:00
14280a6f91 Add missing branch checkout step to getting started guide
Users were building from main instead of feature/turboquant-kv-cache,
resulting in "Unsupported cache type: turbo4" errors.

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-31 13:07:45 -05:00
c122fd0320 Add Sparse V and Boundary V sections to getting started guide
Document built-in optimizations: Sparse V dequant (Metal, auto-enabled),
Boundary V (auto-enabled with turbo2-V), and maximum V compression config.

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-31 11:13:55 -05:00
7f5043ba2f Add getting started guide for new testers
Standalone doc with build instructions (Metal, CUDA, HIP, Windows),
config selection table, benchmarking steps, and how to share results.
Community requested.

Co-Authored-By: tturney@psyguard.ai
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-31 11:00:21 -05:00