Skip to content

Commit 6b7b8b5

Browse files
author
Atome LM Team
committed
Final review fixes: QUICKSTART weights note, REPRODUCE prereq, export-script docstrings
- QUICKSTART.md: drop stale 'no trained weights ship' line; document the bundled checkpoints/atome_1m_v1.pt path alongside the train-from-scratch flow so first-time cloners aren't misled. - REPRODUCE.md: add explicit scripts/build_corpus.py --source tinystories prerequisite for the 944K training commands that read data/tinystories_full.txt. - scripts/export_to_atome_packed.py and export_to_atome_p3.py: lead the docstring with **Experimental** + a pointer to FRONTIER.md, so it's visible at first glance that these formats don't have a C decoder yet.
1 parent 79c4649 commit 6b7b8b5

4 files changed

Lines changed: 32 additions & 3 deletions

File tree

QUICKSTART.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,16 @@ is absent.
6464

6565
---
6666

67-
**No trained weights ship with this repository** — Atome LM is
68-
train-from-scratch. Pre-trained 944 K-parameter checkpoints, MCU firmware,
69-
and full benchmarks are part of the commercial kit (see [README.md](README.md)).
67+
**Trained weights are bundled** in `checkpoints/``atome_944k.bin`
68+
(packed C-engine blob), `atome_1m_v1.pt` (PyTorch source), and
69+
`vanilla_1m_v1.pt` (FP32 baseline for the 944 K reversal A/B in
70+
[HONEST_RESULTS.md](HONEST_RESULTS.md)). If you want to run the model
71+
without training first:
72+
73+
```bash
74+
python scripts/demo.py --checkpoint checkpoints/atome_1m_v1.pt
75+
```
76+
77+
If you want to train your own from scratch, follow the
78+
`scripts/train_demo.py` flow above — it produces a 60 K-parameter model
79+
in ~30 min on a CPU.

REPRODUCE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ python3 -c "import json; r=json.load(open('ab_results.json')); \
3232

3333
The ckpt that produced val_loss 1.0545 / ppl 2.87.
3434

35+
Prerequisite — build the full TinyStories corpus (one-shot, ~5 min):
36+
37+
```bash
38+
PYTHONPATH=. python3 scripts/build_corpus.py --source tinystories \
39+
--output data/tinystories_full.txt
40+
```
41+
42+
Then train:
43+
3544
```bash
3645
# On the GPU pod:
3746
PYTHONPATH=. python3 scripts/train_atome_1m.py \

scripts/export_to_atome_p3.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#!/usr/bin/env python3
22
"""scripts/export_to_atome_p3.py — write a power-of-3 ATOME-P3 binary.
33
4+
**Experimental.** The C engine in `c_engine/upstream/` does not yet decode
5+
ATOMEP3; this script produces research artifacts only. For an
6+
MCU-deployable blob today, use `scripts/export_to_atome.py` (ATOME01).
7+
See `FRONTIER.md` for the ATOMEP3 / ATOME02 status.
8+
49
Identical wire layout to ATOME01 except every quantized payload stores
510
3-bit power-of-3 codes (3 bits / weight, 8 codes per 3 bytes), not
611
2-bit ternary trits (2 bits / trit, 4 trits per byte).

scripts/export_to_atome_packed.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
#!/usr/bin/env python3
22
"""scripts/export_to_atome_packed.py — write a base-3 packed `ATOME02` binary.
33
4+
**Experimental.** The C engine in `c_engine/upstream/` does not yet decode
5+
ATOME02; this script produces research artifacts only. For an MCU-deployable
6+
blob today, use `scripts/export_to_atome.py` (ATOME01). See `FRONTIER.md`
7+
for the ATOME02 / ATOMEP3 status.
8+
49
Identical wire layout to `export_to_atome.py` (ATOME01) except every
510
"packed trits" payload is laid out as
611

0 commit comments

Comments
 (0)