soup/docs
Alpamys 6ec36b5ff6 feat: live FSDP-shard consolidation + serve KV-cache type + ONNX QA (v0.71.14)
Close the doable tail of the export-QA + deferred-stub family.

- #96 consolidate_shards: lazy-torch safetensors merge, TOCTOU-hardened
  (enforce_under_cwd_and_no_symlink, weights_only=True, atomic_write_bytes),
  16 GiB/shard cap, dup-key shape-conflict reject. --plan-only flag.
- #140 apply_kv_cache_type -> KvCacheRuntime; soup serve --kv-cache-type
  (bf16/f16 dtype, q8_0 quantized cache + hqq probe, fp8 Hopper-gated).
- #71 ONNX export QA: tiny-GPT2 PASS, TinyLlama host-RAM-bound (qa doc).
- #70/#72/#144/#74/#79 deferred to INFRA-BLOCKED tail (kept open).

Tests 13430 -> 13476 (+46). ruff clean. Suite green, 78.52% cov.
2026-06-05 13:39:36 +05:00
..
README.md docs: trim README to a 238-line front door; move feature reference to docs/ 2026-05-31 20:10:59 +05:00
adapters-and-governance.md feat(rag): RAFT span-mask trainer + RA-DIT auto-link + live steering + eval citation (v0.71.10) 2026-06-03 19:28:45 +05:00
backends-and-ops.md feat(v0.71.5): ingest/data/prompt/drift polish 2026-06-02 14:34:36 +05:00
commands.md feat: live FSDP-shard consolidation + serve KV-cache type + ONNX QA (v0.71.14) 2026-06-05 13:39:36 +05:00
data.md feat(build): manifest-level dotted-path custom transforms (#255) 2026-06-04 17:37:12 +05:00
evaluation.md feat(rag): RAFT span-mask trainer + RA-DIT auto-link + live steering + eval citation (v0.71.10) 2026-06-03 19:28:45 +05:00
models.md chore: release v0.71.0 — split heavy deps into [train] extra 2026-06-01 12:27:08 +05:00
peft-and-efficiency.md docs: fix src-layout path refs and repoint public docs off gitignored CLAUDE.md 2026-06-01 11:49:11 +05:00
performance-and-quantization.md docs: trim README to a 238-line front door; move feature reference to docs/ 2026-05-31 20:10:59 +05:00
serving-and-export.md feat: architecture + distill + adapter-train live wiring (v0.71.12) 2026-06-04 19:36:04 +05:00
training.md feat: architecture + distill + adapter-train live wiring (v0.71.12) 2026-06-04 19:36:04 +05:00

README.md

Soup Documentation

← Back to the main README

The main README is the 5-minute front door. This directory holds the full feature reference — every soup capability, grouped by area.

Guide Covers
Training tasks & methods SFT, DPO/GRPO/PPO/KTO/ORPO/SimPO/IPO/BCO, tool-calling, PRM, pre-training, distillation, classification, vision/audio/TTS, unlearning, RAFT/RA-DIT, loop-hardening detectors
PEFT, long context & efficiency DoRA, LoRA+, rsLoRA, VeRA, OLoRA, NEFTune, PiSSA, ReLoRA, optimizer & PEFT zoo, LLaMA Pro, GaLore, YaRN/LongLoRA, packing, curriculum, auto-tuning
Performance & quantization QAT, FP8, Quant Menu (I + II), KV-cache, NVFP4, save formats, Cut Cross-Entropy, gradient checkpointing, kernels, activation offloading, multi-GPU / DeepSpeed / FSDP
Data engineering Formats, the Axolotl/LF-parity pipeline, data tools, synthetic generation & forge, quality scorecards, trace tooling, remote datasets, mixing, recipe DAGs
Evaluation & probes Eval design/gate, eval-gated training, benchmarks, NLG metrics, calibration, Elo arena, diagnose, post-train X-ray probes, A/B, drift, tunability, soup advise
Serving & export OpenAI-compatible server, batch inference, benchmarking, merge/export, Anthropic Messages endpoint, speculative decoding, deploy autopilot, Web UI, Agent Forge
Adapters, registry & governance Adapter lifecycle/management, model registry, Soup Cans, the data flywheel (soup loop), knowledge editing, steering, supply-chain controls
Backends, platform & ops MLX/Unsloth backends, alternative hubs, HF Hub integration, autopilot, experiment tracking, plan/apply, env lockfiles, hardware-fit, completions, plugins, utility commands
Command reference The full soup command list
Supported models & extras Recommended model families, the VRAM size guide, the pip extras matrix

Per-release notes live on the GitHub Releases page; see also the repo-root CHANGELOG.md.