mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-03-12 02:09:16 -05:00
2cb887e9e4
- Moved tools/py_to_notebook.py to bin/py_to_notebook.py - Updated tito.py to reference the new location - Made py_to_notebook.py executable for direct invocation - Removed empty tools/ directory - Updated documentation to reflect new location - All tools now consolidated in bin/ directory for consistency Benefits: - Conventional organization (bin/ for executables) - Can invoke tools directly: ./bin/py_to_notebook.py - Cleaner project structure - Consistent with other tools (tito.py, generate_student_notebooks.py)
📚 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