docs: update README file structure and fix typo

Update the file structure section to reflect the current repository
layout, including benchmarks/, bridge/, training_dynamic/, and newly
added header files, scripts, and training variants. Fix missing space
in "Fork it, build on it" section.
This commit is contained in:
sehawq 2026-03-04 17:27:38 +03:00
parent efcf193075
commit d5eb7d28e7
1 changed files with 42 additions and 17 deletions

View File

@ -98,17 +98,42 @@ Key optimizations:
├── inmem_peak.m # Peak TFLOPS measurement (2048x2048 matmul) ├── inmem_peak.m # Peak TFLOPS measurement (2048x2048 matmul)
├── sram_bench.m # ANE SRAM bandwidth probing ├── sram_bench.m # ANE SRAM bandwidth probing
├── sram_probe.m # SRAM size/layout exploration ├── sram_probe.m # SRAM size/layout exploration
├── benchmarks/
│ ├── ANE_BENCHMARK_REPORT.md # Cross-chip benchmark report
│ └── community_results.json # Community-submitted benchmark data
├── bridge/
│ ├── Makefile
│ ├── ane_bridge.h # ANE bridge header
│ └── ane_bridge.m # ANE bridge implementation
└── training/ └── training/
├── Makefile
├── README.md # Training pipeline documentation
├── ane_runtime.h # ANE private API wrapper (compile, eval, IOSurface) ├── ane_runtime.h # ANE private API wrapper (compile, eval, IOSurface)
├── ane_mil_gen.h # MIL program generation helpers ├── ane_mil_gen.h # MIL program generation helpers
├── ane_classifier.h # ANE-offloaded classifier
├── ane_rmsnorm_bwd.h # ANE RMSNorm backward pass
├── model.h # Model weight initialization and blob builders ├── model.h # Model weight initialization and blob builders
├── forward.h # Forward pass MIL generators ├── forward.h # Forward pass MIL generators
├── backward.h # Backward pass MIL generators ├── backward.h # Backward pass MIL generators
├── stories_config.h # Stories model configuration
├── stories_cpu_ops.h # CPU-side operations for Stories model
├── stories_io.h # Stories data I/O (TinyStories loading)
├── stories_mil.h # Stories MIL program generators
├── train.m # Minimal training loop (early prototype) ├── train.m # Minimal training loop (early prototype)
├── tiny_train.m # 2-layer tiny model training ├── tiny_train.m # 2-layer tiny model training
├── train_large.m # Main: single-layer dim=768 training (optimized) ├── train_large.m # Main: Stories110M training (static pipeline)
├── train_large_ane.m # Stories110M training (ANE classifier)
├── test_*.m # Unit tests for individual kernels ├── test_*.m # Unit tests for individual kernels
└── Makefile ├── dashboard.py # Live training dashboard (power, throughput)
├── tokenize.py # TinyStories pretokenization script
├── download_data.sh # Training data download script
└── training_dynamic/ # Dynamic pipeline (no recompilation)
├── Makefile
├── config.h
├── cpu_ops.h
├── io.h
├── mil_dynamic.h
└── train.m
``` ```
## Training Data ## Training Data