Commit Graph

6 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
7b620d98aa refactor: Replace "Master" with "Reflect" in learning framework
- Updated learning philosophy from "Build, Use, Master" to "Build, Use, Reflect"
- Changed setup module: "Build → Use → Reflect"
- Changed capstone module: "Build → Optimize → Reflect"
- Promotes inclusive language and emphasizes metacognition over dominance
- Better pedagogical approach focusing on thoughtful analysis and system thinking
2025-07-16 11:48:28 -04:00
Vijay Janapa Reddi
19a8123333 Standardize all 14 module READMEs with consistent structure
 Complete standardization of all TinyTorch module READMEs:

📊 **Module Info**: Consistent difficulty, time, prerequisites, next steps
🎯 **Learning Objectives**: Clear, measurable, action-oriented outcomes
🧠 **Pedagogical Framework**: Build → Use → [Context-specific verb]
📚 **What You'll Build**: Concrete code examples and implementations
🚀 **Getting Started**: Prerequisites check + development workflow
🧪 **Testing**: Comprehensive test coverage + inline feedback
🎯 **Key Concepts**: Real-world applications + technical foundations
🎉 **Ready to Build**: Motivational + grid cards for all modules

 All 14 modules now follow identical structure:
- 01_setup: Foundation workflow mastery
- 02_tensor: Core data structures
- 03_activations: Neural network fundamentals
- 04_layers: Building blocks
- 05_networks: Architecture design
- 06_cnn: Computer vision foundations
- 07_dataloader: Data pipeline engineering
- 08_autograd: Automatic differentiation
- 09_optimizers: Learning algorithms
- 10_training: End-to-end orchestration
- 11_compression: Model optimization
- 12_kernels: Performance optimization
- 13_benchmarking: Systematic evaluation
- 14_mlops: Production deployment (capstone)

🎓 **Student Experience**: Predictable navigation, clear expectations, motivational flow
👨‍🏫 **Instructor Experience**: Professional consistency, easy maintenance, coherent course

This establishes the single source of truth that will automatically convert to
clean website chapters via book/convert_readmes.py
2025-07-16 01:44:49 -04:00
Vijay Janapa Reddi
647b5677b5 Add consistent 'Ready to Build?' endings to README modules
Standardize module endings with motivational section + grid cards:

Added to 4 key modules:
- 01_setup: Foundation workflow mastery message
- 03_activations: Neural networks come alive message
- 06_cnn: Computer vision implementation message
- 09_optimizers: Learning algorithms message

Standard Format:
## 🎉 Ready to Build?
[Module-specific motivational content about what they're building]
Take your time, test thoroughly, and enjoy building something that really works! 🔥

[Grid cards automatically follow via converter]

Progress: 6/14 modules now have consistent endings
-  01_setup, 02_tensor, 03_activations, 06_cnn, 07_dataloader, 09_optimizers
- 🔄 8 more modules to standardize

Result: Better user experience with consistent motivation + clear next steps
2025-07-16 01:29:00 -04:00
Vijay Janapa Reddi
672f959dde Achieve complete emoji consistency across all modules for student materials
Decision: Keep emojis in section headers for better student experience

Rationale:
- 📊 🎯 🧠 📚 emojis provide visual scanning and semantic meaning
- More engaging and approachable for students
- Clear information architecture (Info, Objectives, Concepts, Implementation)
- 13/14 modules already used this pattern - now 14/14 consistent
- Maintains TOC navigation (vs hidden admonition boxes)

Changes:
- Fixed 01_setup: Added 🎯 Learning Objectives, 🧠 Overview, 📚 What You'll Build
- Fixed 11_compression: Added 📊 Module Info, 🎯 Learning Objectives, 🧠 Overview
- Reverted 06_cnn: Back to ## headers (from admonition boxes) for TOC visibility
- All modules now follow: 📊 Module Info → 🎯 Learning Objectives → 🧠 Build/Overview → 📚 What You'll Build

Result: Consistent, student-friendly visual hierarchy across all 14 modules
2025-07-16 01:25:32 -04:00
Vijay Janapa Reddi
e1fd90af2f Standardize module headers - consistent 🔥 emoji and clean chapter titles
README Updates:
- All modules now use consistent '🔥 Module: [Name]' format
- Removed inconsistent emojis (🧠, 🚀, 📊, 🧱, 🏋️)
- Removed module numbers and descriptive subtitles
- Clean, consistent branding across all 14 modules

Converter Updates:
- Added header cleaning logic to strip module prefixes from chapter titles
- Chapters now show clean names: 'CNN', 'Tensor', 'Setup', etc.
- No emoji or module numbers in final website headers
- Maintains clean, professional appearance

Result: Consistent source files + clean website presentation
2025-07-16 01:18:07 -04:00
Vijay Janapa Reddi
d82c75f9dc Renumber modules from 00-13 to 01-14 for natural numbering
 Rename all module directories: 00_setup → 01_setup, etc.
 Update convert_modules.py mappings for new directory names
 Update _toc.yml file paths and titles (1-14 instead of 0-13)
 Regenerate all overview pages with new numbering
 Fix all broken references in usage-paths and intro
 Update chapter references to use natural numbering

Benefits:
- More intuitive course progression starting from 1
- Matches academic course numbering conventions
- Eliminates confusion about 'Module 0' concept
- Cleaner mental model for students and instructors
- All references and links properly updated

Complete transformation: 14 modules now numbered 01-14
2025-07-15 18:51:36 -04:00