soup/docs
Alpamys 894cb632dd chore: release v0.71.0 — split heavy deps into [train] extra
Heavy training stack (torch, transformers, peft, trl, datasets,
bitsandbytes, accelerate) moves out of the core install into a new
[train] optional-dependency extra. `pip install soup-cli` is now a
light CLI + data-tools install with no PyTorch; `pip install
'soup-cli[train]'` adds the training stack.

- pyproject: new [train] + [all] extras; [dev] self-references [train]
  so CI (`pip install -e ".[dev]"`) still gets torch. Pins unchanged.
- errors.py: missing torch/transformers/peft/trl/datasets/bitsandbytes/
  accelerate now surface a single 'install soup-cli[train]' fix.
- Dockerfile: install soup-cli[train,serve,data,eval] so the GPU image
  can still fine-tune.
- README + docs/models.md: split install into light core vs [train].
- CHANGELOG: cut [0.71.0]; bump version 0.70.0 -> 0.71.0.
2026-06-01 12:27:08 +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 docs: trim README to a 238-line front door; move feature reference to docs/ 2026-05-31 20:10:59 +05:00
backends-and-ops.md docs: fix src-layout path refs and repoint public docs off gitignored CLAUDE.md 2026-06-01 11:49:11 +05:00
commands.md docs: trim README to a 238-line front door; move feature reference to docs/ 2026-05-31 20:10:59 +05:00
data.md docs: trim README to a 238-line front door; move feature reference to docs/ 2026-05-31 20:10:59 +05:00
evaluation.md docs: trim README to a 238-line front door; move feature reference to docs/ 2026-05-31 20:10:59 +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 docs: fix src-layout path refs and repoint public docs off gitignored CLAUDE.md 2026-06-01 11:49:11 +05:00
training.md docs: trim README to a 238-line front door; move feature reference to docs/ 2026-05-31 20:10:59 +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.