mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-07-20 07:58:34 -05:00
Vijay Janapa Reddi
7fd544962d
## New Documentation Pages Integrated into Site Navigation **site/learning-journey-visual.md** - 10 interactive Mermaid diagrams: 1. Complete Learning Flow - Full flowchart through all 20 modules & 6 milestones 2. Module Dependencies - Shows how modules depend on each other 3. Three-Tier Timeline - Visual progression through Foundation/Architecture/Optimization 4. Historical Milestones - Gantt chart showing ML history recreation (1957→2024) 5. Student Learning Paths - Decision tree for different learning approaches 6. Capability Progression - Skill levels unlocked at each tier 7. Workflow Cycle - The edit → export → validate loop 8. Dataset Strategy - When to use shipped vs downloaded datasets 9. Time vs Outcomes Quadrant - Comparing learning path investments 10. Difficulty Curve - Line chart showing module difficulty progression ## Site Navigation Updates (_toc.yml) **Added to "Using TinyTorch" section:** - Student Workflow (student-workflow.md) - Essential edit → export → validate cycle - Datasets Guide (datasets.md) - Complete dataset documentation **Added to "Course Orientation" section:** - Visual Learning Map (learning-journey-visual.md) - NEW Mermaid diagram showcase - FAQ (faq.md) - Comprehensive answers to common questions ## Mermaid Integration - Mermaid already configured in _config.yml (v10.6.1) - All diagrams use color coding: - Blue: Foundation modules - Orange: Critical modules (Autograd, Training) - Purple: Advanced architecture modules - Green: Milestone achievements - Yellow: North Star milestone (CIFAR-10) - Red: Capstone ## Benefits **Visual learners**: Diagrams show the complete learning journey at a glance **Navigation**: All new pages now appear in site sidebar **Discoverability**: FAQ answers "Why TinyTorch vs alternatives" **Dataset clarity**: Students understand shipped vs downloaded data strategy **Journey visualization**: See the path from tensors to transformers [Claude Code](https://claude.com/claude-code)
105 lines
2.7 KiB
YAML
105 lines
2.7 KiB
YAML
# TinyTorch: Build ML Systems from Scratch
|
|
# Table of Contents Structure
|
|
|
|
format: jb-book
|
|
root: intro
|
|
title: "TinyTorch Course"
|
|
|
|
parts:
|
|
- caption: 🚀 Getting Started
|
|
chapters:
|
|
- file: quickstart-guide
|
|
title: "Quick Start Guide"
|
|
- file: usage-paths/classroom-use
|
|
title: "For Instructors"
|
|
|
|
- caption: 🛠️ Using TinyTorch
|
|
chapters:
|
|
- file: tito-essentials
|
|
title: "Essential Commands"
|
|
- file: student-workflow
|
|
title: "Student Workflow"
|
|
- file: learning-progress
|
|
title: "Track Your Progress"
|
|
- file: datasets
|
|
title: "Datasets Guide"
|
|
|
|
- caption: 🧭 Course Orientation
|
|
chapters:
|
|
- file: chapters/00-introduction
|
|
title: "Course Structure"
|
|
- file: chapters/learning-journey
|
|
title: "Learning Journey"
|
|
- file: learning-journey-visual
|
|
title: "Visual Learning Map"
|
|
- file: chapters/milestones
|
|
title: "Historical Milestones"
|
|
- file: faq
|
|
title: "FAQ"
|
|
|
|
- caption: 🏗️ Foundation Tier (01-07)
|
|
chapters:
|
|
- file: ../modules/01_tensor/ABOUT
|
|
title: "01. Tensor"
|
|
- file: ../modules/02_activations/ABOUT
|
|
title: "02. Activations"
|
|
- file: ../modules/03_layers/ABOUT
|
|
title: "03. Layers"
|
|
- file: ../modules/04_losses/ABOUT
|
|
title: "04. Losses"
|
|
- file: ../modules/05_autograd/ABOUT
|
|
title: "05. Autograd"
|
|
- file: ../modules/06_optimizers/ABOUT
|
|
title: "06. Optimizers"
|
|
- file: ../modules/07_training/ABOUT
|
|
title: "07. Training"
|
|
|
|
- caption: 🏛️ Architecture Tier (08-13)
|
|
chapters:
|
|
- file: ../modules/08_dataloader/ABOUT
|
|
title: "08. DataLoader"
|
|
- file: ../modules/09_spatial/ABOUT
|
|
title: "09. Convolutions"
|
|
- file: ../modules/10_tokenization/ABOUT
|
|
title: "10. Tokenization"
|
|
- file: ../modules/11_embeddings/ABOUT
|
|
title: "11. Embeddings"
|
|
- file: ../modules/12_attention/ABOUT
|
|
title: "12. Attention"
|
|
- file: ../modules/13_transformers/ABOUT
|
|
title: "13. Transformers"
|
|
|
|
- caption: ⚡ Optimization Tier (14-19)
|
|
chapters:
|
|
- file: ../modules/14_profiling/ABOUT
|
|
title: "14. Profiling"
|
|
- file: ../modules/15_quantization/ABOUT
|
|
title: "15. Quantization"
|
|
- file: ../modules/16_compression/ABOUT
|
|
title: "16. Compression"
|
|
- file: ../modules/17_memoization/ABOUT
|
|
title: "17. Memoization"
|
|
- file: ../modules/18_acceleration/ABOUT
|
|
title: "18. Acceleration"
|
|
- file: ../modules/19_benchmarking/ABOUT
|
|
title: "19. Benchmarking"
|
|
|
|
- caption: 🏅 Capstone Project
|
|
chapters:
|
|
- file: ../modules/20_capstone/ABOUT
|
|
title: "20. MLPerf® Edu Competition"
|
|
|
|
- caption: 🌍 Community
|
|
chapters:
|
|
- file: community
|
|
title: "Ecosystem"
|
|
|
|
- caption: 🛠️ Resources & Tools
|
|
chapters:
|
|
- file: checkpoint-system
|
|
title: "Progress Tracking"
|
|
- file: testing-framework
|
|
title: "Testing Guide"
|
|
- file: resources
|
|
title: "Additional Resources"
|