mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-03-19 15:39:39 -05:00
eebb22ebdb
- Add template section to tensor, layers, activations, and cnn modules - Create docs/development/module-template.md for future reference - Clarify learning vs building structure consistently - Show students where their code will live in the final package - Decouple learning modules from production organization
📚 TinyTorch Documentation
Welcome to the TinyTorch documentation! This directory contains all the guides, principles, and references for building and using TinyTorch.
🎓 For Students
Start here if you're taking the ML Systems course:
- Project Guide - Track your progress through all 12 modules
- Quickstart - Get up and running quickly
- Main README - Project overview and introduction
🎯 Educational Philosophy
Understanding how TinyTorch is designed for learning:
- Pedagogical Principles - The "Build → Use → Understand" framework
- Vision - High-level course philosophy and learning approach
- Testing Architecture - Dual testing system for education
🔧 For Module Developers
Building new modules or contributing to TinyTorch:
- Module Development Guide - Complete guide to building modules
- Module Generation Guide - Automated module creation
- Standard Module Guide - Module standards and conventions
- Quick Module Reference - Fast reference for common tasks
🗂️ Documentation Structure
docs/
├── pedagogy/ # Educational philosophy and principles
├── development/ # Module development guides
├── students/ # Student-facing documentation
└── README.md # This file
🚀 Quick Navigation
- New to TinyTorch? → Start with Project Guide
- Building modules? → Check Module Development Guide
- Understanding the pedagogy? → Read Pedagogical Principles
- Need quick help? → Use Quick Module Reference
All documentation follows the TinyTorch pedagogical principle: Build → Use → Understand → Repeat