mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-08-02 22:07:52 -05:00
Vijay Janapa Reddi
53ee9f17f3
- Move all documentation to docs/ directory with clear organization - Use lowercase-with-dashes naming convention (modern standard) - Organize by audience: students/, development/, pedagogy/ - Create comprehensive docs/README.md index - Clean up root directory (only README.md and quickstart.md remain) Structure: docs/ ├── pedagogy/ # Educational philosophy ├── development/ # Module development guides ├── students/ # Student-facing documentation └── README.md # Documentation index This makes the project more professional and easier to navigate.
49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
# 📚 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](students/project-guide.md) - Track your progress through all 12 modules
|
|
- [Quickstart](../quickstart.md) - Get up and running quickly
|
|
- [Main README](../README.md) - Project overview and introduction
|
|
|
|
## 🎯 Educational Philosophy
|
|
|
|
**Understanding how TinyTorch is designed for learning:**
|
|
|
|
- [Pedagogical Principles](pedagogy/pedagogical-principles.md) - The "Build → Use → Understand" framework
|
|
- [Vision](pedagogy/vision.md) - High-level course philosophy and learning approach
|
|
- [Testing Architecture](pedagogy/testing-architecture.md) - Dual testing system for education
|
|
|
|
## 🔧 For Module Developers
|
|
|
|
**Building new modules or contributing to TinyTorch:**
|
|
|
|
- [Module Development Guide](development/module-development-guide.md) - Complete guide to building modules
|
|
- [Module Generation Guide](development/module-generation-guide.md) - Automated module creation
|
|
- [Standard Module Guide](development/standard-module-guide.md) - Module standards and conventions
|
|
- [Quick Module Reference](development/quick-module-reference.md) - 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](students/project-guide.md)
|
|
- **Building modules?** → Check [Module Development Guide](development/module-development-guide.md)
|
|
- **Understanding the pedagogy?** → Read [Pedagogical Principles](pedagogy/pedagogical-principles.md)
|
|
- **Need quick help?** → Use [Quick Module Reference](development/quick-module-reference.md)
|
|
|
|
---
|
|
|
|
*All documentation follows the TinyTorch pedagogical principle: **Build → Use → Understand → Repeat*** |