mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-03-12 02:53:34 -05:00
06110772b3
- Remove archive directories (docs/archive, modules/source/archive, root archive) - Remove book placeholder files (5 stub chapters) - Remove historical milestone status and analysis files (13 files) - Remove outdated documentation (progressive analysis demo, textbook alignment) - Remove 01-setup chapter (no corresponding module exists) - Renumber book chapters to match actual module structure - Fix module references in tokenization chapter Total: 72 files removed, chapter numbering corrected
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 guidelinestinytorch-textbook-alignment.md- Alignment with ML systems textbooks
Development Standards
development/module-rules.md- Module development standards and patternsdevelopment/nbgrader-standardized-testing.md- Testing standardsdevelopment/nbgrader-testing-template.md- Testing templates
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
📦 Archive
The archive/ directory contains historical documentation that's no longer actively maintained but preserved for reference.
Start here:
- Students: Read
STUDENT_QUICKSTART.md - Instructors: Read
INSTRUCTOR_GUIDE.md - Developers: Read
tinytorch-assumptions.mdFIRST, thendevelopment/module-rules.md