diff --git a/README.md b/README.md index b0c523c..9f7cab1 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,15 @@ Features · Data Tools · Tracking · - Eval + Eval · + Commands +

+ +

+ Python 3.9+ + MIT License + Tests + CI

--- @@ -245,6 +253,27 @@ soup eval --model ./output --benchmarks mmlu --run-id run_20260223_143052_a1b2 | Web dashboard | 🔜 | | Cloud mode (BYOG) | 🔜 | +## All Commands + +``` +soup init [--template chat|code|medical] Create soup.yaml config +soup train --config soup.yaml [--dry-run] Start training +soup chat --model ./output Interactive chat with model +soup push --model ./output --repo user/name Upload to HuggingFace Hub +soup data inspect View dataset stats +soup data validate --format alpaca Check format +soup data convert --to chatml Convert between formats +soup data merge data1.jsonl data2.jsonl Combine datasets +soup data dedup --threshold 0.8 Remove duplicates (MinHash) +soup data stats Extended statistics +soup runs List all training runs +soup runs show Detailed run info + loss graph +soup runs compare Compare two runs +soup runs delete Remove a run +soup eval --model ./output --benchmarks mmlu Evaluate on benchmarks +soup version Show version +``` + ## Requirements - Python 3.9+ @@ -258,7 +287,10 @@ git clone https://github.com/MakazhanAlpamys/Soup.git cd Soup pip install -e ".[dev]" -# Run unit tests (fast, no GPU needed) +# Lint +ruff check soup_cli/ tests/ + +# Run unit tests (fast, no GPU needed — 147 tests) pytest tests/ -v # Run smoke tests (downloads tiny model, runs real training)