mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-07-18 12:06:22 -05:00
4c538dcfec
Updated all documentation to reflect new directory structure: - Source code: src/XX_name/XX_name.py (developers) - Generated notebooks: modules/XX_name/XX_name.ipynb (students) - Package code: tinytorch/ (auto-generated) Files updated: - site/tito/modules.md: Updated paths and workflow - site/tito/troubleshooting.md: Updated file paths - site/tito/data.md: Clarified data locations - site/student-workflow.md: Updated workflow diagram - site/quickstart-guide.md: Updated quickstart paths - docs/STUDENT_QUICKSTART.md: Updated notebook paths - docs/development/module-rules.md: Complete structure overhaul All documentation now accurately reflects developer vs student workflows
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