Skip to content

Commit 37538d6

Browse files
Update README: add badges, command reference, test count
- Add Python/License/Tests/CI badges - Add "All Commands" section with full CLI reference - Add lint command to Development section - Update test count to 147 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 5f728c0 commit 37538d6

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,15 @@
1313
<a href="#features">Features</a> &middot;
1414
<a href="#data-tools">Data Tools</a> &middot;
1515
<a href="#experiment-tracking">Tracking</a> &middot;
16-
<a href="#model-evaluation">Eval</a>
16+
<a href="#model-evaluation">Eval</a> &middot;
17+
<a href="#all-commands">Commands</a>
18+
</p>
19+
20+
<p align="center">
21+
<img src="https://img.shields.io/badge/python-3.9%2B-blue" alt="Python 3.9+">
22+
<img src="https://img.shields.io/badge/license-MIT-green" alt="MIT License">
23+
<img src="https://img.shields.io/badge/tests-147%20passed-brightgreen" alt="Tests">
24+
<a href="https://github.com/MakazhanAlpamys/Soup/actions"><img src="https://github.com/MakazhanAlpamys/Soup/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
1725
</p>
1826

1927
---
@@ -245,6 +253,27 @@ soup eval --model ./output --benchmarks mmlu --run-id run_20260223_143052_a1b2
245253
| Web dashboard | 🔜 |
246254
| Cloud mode (BYOG) | 🔜 |
247255

256+
## All Commands
257+
258+
```
259+
soup init [--template chat|code|medical] Create soup.yaml config
260+
soup train --config soup.yaml [--dry-run] Start training
261+
soup chat --model ./output Interactive chat with model
262+
soup push --model ./output --repo user/name Upload to HuggingFace Hub
263+
soup data inspect <path> View dataset stats
264+
soup data validate <path> --format alpaca Check format
265+
soup data convert <path> --to chatml Convert between formats
266+
soup data merge data1.jsonl data2.jsonl Combine datasets
267+
soup data dedup <path> --threshold 0.8 Remove duplicates (MinHash)
268+
soup data stats <path> Extended statistics
269+
soup runs List all training runs
270+
soup runs show <run_id> Detailed run info + loss graph
271+
soup runs compare <run_1> <run_2> Compare two runs
272+
soup runs delete <run_id> Remove a run
273+
soup eval --model ./output --benchmarks mmlu Evaluate on benchmarks
274+
soup version Show version
275+
```
276+
248277
## Requirements
249278

250279
- Python 3.9+
@@ -258,7 +287,10 @@ git clone https://github.com/MakazhanAlpamys/Soup.git
258287
cd Soup
259288
pip install -e ".[dev]"
260289

261-
# Run unit tests (fast, no GPU needed)
290+
# Lint
291+
ruff check soup_cli/ tests/
292+
293+
# Run unit tests (fast, no GPU needed — 147 tests)
262294
pytest tests/ -v
263295

264296
# Run smoke tests (downloads tiny model, runs real training)

0 commit comments

Comments
 (0)