Updated the course journey section to match the exact navigation structure:
- Foundation: Setup, Tensors, Activations
- Building Blocks: Layers, Networks, CNNs
- Training Systems: DataLoader, Autograd, Optimizers, Training
- Production & Performance: Compression, Kernels, Benchmarking, MLOps
Changes:
- Cleaner bullet format with • separators
- Concise descriptions for each section
- Exact alignment with site navigation
- More scannable and consistent layout
Result: Perfect consistency between landing page and navigation structure.
Changes:
- Replaced em dashes (—) with simpler punctuation
- Used colons (:) for explanatory clauses
- Used periods (.) for sentence breaks
- Removed unnecessary punctuation complexity
Result: Cleaner, more readable text that flows better without distracting typography.
Changed main tagline from:
'Most ML education teaches you to use frameworks. TinyTorch teaches you to understand them.'
To:
'Most ML education teaches you to use frameworks. TinyTorch teaches you to build them.'
Rationale:
- 'Understand' is vague and passive
- 'Build' is concrete and action-oriented
- Aligns perfectly with engineering focus we just established
- Reinforces the hands-on, construction-based learning approach
- More compelling for engineering-minded learners
Updated in both README.md and book/intro.md for consistency.
Key improvement:
- Replaced 'Learning Opportunity' with 'Science vs Engineering' framing
- Clearly positions TinyTorch as ML engineering education vs traditional ML science
- Uses ⚖️ emoji to reinforce the comparison concept
- Bold formatting on key terms: **science** vs **engineering**
- Creates stronger identity formation: 'I want to be an ML engineer'
- Differentiates from theory-heavy courses with concrete value proposition
Result: Transforms value prop from 'better learning' to 'different career path' - much more compelling positioning for engineering-minded learners.
Key improvements:
- Added 'Learning Opportunity' section with positive framing
- Expanded 'What Makes TinyTorch Different' with concrete examples
- Enhanced learning philosophy with complete example cycle
- Moved CTA section lower after building value and understanding
- Added more substance to each section while maintaining scannability
- Improved course journey descriptions with more detail
- Better flow: Hook → Opportunity → Difference → Philosophy → Journey → CTA
- Maintained positive tone without putting other approaches down
Result: More substantial content that builds desire before asking for action.
- Add 'The Big Picture: Why Build from Scratch?' section at top
- Include 'What Makes TinyTorch Different' with 4 key differentiators
- Match the new big-picture-first structure from root README
- Maintain all existing content but improve hierarchy
- Ensure book and README stay consistent
- Move 'The Big Picture: Why Build from Scratch?' to the top
- Add prominent 'What Makes TinyTorch Different' section highlighting unique value
- Emphasize build-first philosophy vs traditional 'use' frameworks approach
- Show concrete code comparison: traditional vs TinyTorch approach
- Better highlight real production skills, progressive mastery, instant feedback
- Reorganize content flow: vision → differentiators → practical details
- Removed 'Home → Module Name' breadcrumbs that added clutter without value
- Chapters now start cleanly with title and difficulty/time badges
- Maintains the useful difficulty stars and time estimates
- Improves visual hierarchy and reduces interface noise
Result: Cleaner, more focused chapter headers
Problem: Grid cards were showing raw HTML code instead of rendering properly
Root cause: README converter was adding new grid cards while preserving
original ones, creating duplicate/conflicting grid sections
Solution:
- Modified book/convert_readmes.py to remove existing grid cards from
source READMEs before adding new interactive elements
- Added regex patterns to clean up grid-related markup
- Regenerated all 14 book chapters with fixed converter
- Grid cards now render properly as interactive buttons
Result: All chapters now have clean, properly formatted grid cards
that render correctly in Jupyter Book
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
Key Improvements:
1. **Meaningful titles**: Keep 'Module: CNN' format instead of just 'CNN'
2. **Clean breadcrumbs**: 'Home → CNN' instead of 'Home → Module 3: 03 Activations'
3. **Remove duplicate info**: Stop generating redundant Module Info boxes
4. **Use source formatting**: Let READMEs control their own presentation
5. **Enhanced README**: Added Jupyter Book admonition formatting to CNN module info
Results:
- More logical navigation and titles
- Single source of truth for module information
- Better formatted content boxes (CNN example with admonitions)
- Eliminated confusing duplicate content
- Cleaner, more professional presentation
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
- Keep the '🎉 Ready to Build?' motivational section
- Keep the grid cards for Binder/Colab/Source access
- Remove the redundant '🚀 Interactive Learning' section header
- Content now flows naturally: motivation → 'Choose your preferred way...' → grid cards
- Eliminates unnecessary section break and improves reading flow
- All chapters updated with cleaner, more streamlined format
- Updated book/convert_readmes.py to use Jupyter Book grid cards instead of Bootstrap buttons
- Format matches what was in main branch at merge commit 3a687aa
- Three interactive options in clean grid layout:
🚀 Launch Binder - Interactive browser environment
⚡ Open in Colab - GPU access and cloud compute
📖 View Source - Browse Python source code
- Added helpful 'Save Your Progress' tip about Binder sessions
- All chapters regenerated with proper grid card format
- Tested successful book build
- Updated book/convert_readmes.py to use original format from git history
- Three environment options: Builder (blue), Jupyter (green), Colab (light blue)
- Each option has descriptive admonition box explaining its purpose
- Bootstrap-style anchor buttons with proper CSS classes
- Matches original commit abac2b7 format exactly
- All chapters regenerated with proper interactive elements
- Combine venv setup and tito execution in same step
- Add pytest installation for tito environment validation
- Add explanatory comments about GitHub Actions shell behavior
- Remove environment skipping hack in favor of proper setup
- Workflow now uses tito CLI consistently for book generation
- Updated title to match new tagline format
- Added humble educational foundation section referencing CS249r course
- Confirmed result-oriented 'What You'll Achieve' section works well
- All branding now consistent across book and documentation
- Clean author attribution without unnecessary copyright notices
- Updated all module references to start from 01 instead of 00
- Changed tagline to 'Build your own ML framework. Start small. Go deep.'
- Added educational foundation section linking to ML Systems book
- Updated README, documentation, CLI examples, and prerequisites
- Regenerated book content with consistent numbering throughout
- Maintains 14 modules total but with natural numbering (01-14)
✅ 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
✅ Show actual implementation code instead of vague descriptions
✅ Contrast 'import torch' with 'class Tensor:' implementations
✅ Display real function definitions students will write
✅ Make clear students build every component from scratch
Changes:
- Replace vague 'Build your own tensors' with 'class Tensor:'
- Show actual method signatures: __add__, backward, forward
- Include concrete loss function: mse_loss implementation
- Display real optimizer logic: param.data -= lr * param.grad
- Change ending: 'I built this!' → 'I implemented every line!'
✅ Clean source file headers: 'Module X:' → clean descriptive titles
✅ Regenerate overview pages with clean headers
✅ More flexible content that works in any context
✅ Numbers still provided by book TOC structure
Changes:
- Remove 'Module X: ' prefix from all source file headers
- Headers now focus on descriptive content titles
- Book maintains proper chapter ordering via _toc.yml
- Content is more reusable across different presentations
✅ Remove unnecessary nesting: book/tinytorch-course/ → book/
✅ Update all path references in scripts and workflows
✅ Cleaner development experience with shorter paths
✅ Book builds successfully with simplified structure
Changes:
- Move all book files up one directory level
- Update convert_modules.py paths
- Update GitHub Actions workflow paths
- Update book configuration paths
- Test confirms everything works correctly
✅ Add learning goals extraction with beautiful admonition blocks
✅ Create hybrid book approach (overview pages + interactive buttons)
✅ Generate both notebooks (Binder/Colab) and book pages
✅ Update GitHub Actions for main branch deployment
✅ All 14 modules now have consistent formatting
Features:
- Extract content from source files (no duplication)
- Interactive launch buttons (GitHub/Binder/Colab)
- Learning objectives as 🎯 tip admonitions
- Notebooks generated in-place for direct access
- Clean separation: dev → main → website deployment
