mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-04-29 00:59:17 -05:00
d3a126235c
Major directory restructure to support both developer and learner workflows: Structure Changes: - NEW: src/ directory for Python source files (version controlled) - Files renamed: tensor.py → 01_tensor.py (matches directory naming) - All 20 modules moved from modules/ to src/ - CHANGED: modules/ now holds generated notebooks (gitignored) - Generated from src/*.py using jupytext - Learners work in notebooks, developers work in Python source - UNCHANGED: tinytorch/ package (still auto-generated from notebooks) Workflow: src/*.py → modules/*.ipynb → tinytorch/*.py Command Updates: - Updated export command to read from src/ and generate to modules/ - Export flow: discovers modules in src/, converts to notebooks in modules/, exports to tinytorch/ - All 20 modules tested and working Configuration: - Updated .gitignore to ignore modules/ directory - Updated README.md with new three-layer architecture explanation - Updated export.py source mappings and paths Benefits: - Clean separation: developers edit Python, learners use notebooks - Better version control: only Python source committed, notebooks generated - Flexible learning: can work in notebooks OR Python source - Maintains backward compatibility: tinytorch package unchanged Tested: - Single module export: tito export 01_tensor ✅ - All modules export: tito export --all ✅ - Package imports: from tinytorch.core.tensor import Tensor ✅ - 20/20 modules successfully converted and exported
TinyTorch Documentation
This directory contains essential documentation for TinyTorch development and usage.
📚 User Documentation
STUDENT_QUICKSTART.md- Getting started guide for studentsINSTRUCTOR_GUIDE.md- Setup and grading guide for instructorscifar10-training-guide.md- Complete guide to achieving the north star goal (75% CIFAR-10 accuracy)
🔧 Development Documentation
tinytorch-assumptions.md- CRITICAL: TinyTorch complexity framework and implementation guidelines
Development Standards
development/module-rules.md- Module development standards and patterns
NBGrader Integration
nbgrader/NBGrader_Quick_Reference.md- Daily use commands and workflownbgrader/NBGRADER_STYLE_GUIDE.md- Style guide for NBGrader cellsnbgrader/NBGrader_Text_Response_Technical_Implementation.md- Technical implementation details
Start here:
- Students: Read
STUDENT_QUICKSTART.md - Instructors: Read
INSTRUCTOR_GUIDE.md - Developers: Read
tinytorch-assumptions.mdFIRST, thendevelopment/module-rules.md