Commit Graph

16 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
92781736a1 Restructure TinyTorch: Move TinyGPT to examples, improve testing framework
Major changes:
- Moved TinyGPT from Module 16 to examples/tinygpt (capstone demo)
- Fixed Module 10 (optimizers) and Module 11 (training) bugs
- All 16 modules now passing tests (100% health)
- Added comprehensive testing with 'tito test --comprehensive'
- Renamed example files for clarity (train_xor_network.py, etc.)
- Created working TinyGPT example structure
- Updated documentation to reflect 15 core modules + examples
- Added KISS principle and testing framework documentation
2025-09-22 09:37:18 -04:00
Vijay Janapa Reddi
b41565445b Fix module dependency diagram and add mermaid support
- Corrected module dependencies based on actual YAML files
- Fixed diagram to show accurate prerequisite relationships:
  - Tensor directly enables both Activations and Autograd
  - DataLoader depends directly on Tensor (not through Spatial)
  - Training depends on Dense, Spatial, Attention, Optimizers, and DataLoader
  - TinyGPT depends on Attention, Optimizers, and Training
- Added sphinxcontrib-mermaid to requirements for diagram rendering
- Updated both intro.md and README.md with corrected diagrams
- Ensured mermaid extension is configured in _config.yml
2025-09-18 13:03:11 -04:00
Vijay Janapa Reddi
9f77d1047e Fix spacing, add links, and improve content structure
- Tighten line spacing from 1.8 to 1.6 for better readability
- Reduce header margins for more compact appearance
- Add educational links (Binder, Colab) with proper URLs
- Fix time duplication in badges (use difficulty stars instead)
- Simplify setup module content for better clarity
- Improve content hierarchy with proper nesting
- Professional ML Engineering Skills section now properly organizes steps
- Consistent badge formatting across all modules
- More compact and professional appearance overall
2025-09-18 10:47:32 -04:00
Vijay Janapa Reddi
6d895891f9 Enhance typography with Inter and JetBrains Mono fonts
- Replace Source Sans/Serif Pro with Inter for better screen readability
- Add JetBrains Mono for superior code display
- Increase body font size from 16px to 17px for better readability
- Optimize line height to 1.8 for comfortable reading
- Add proper font weights and letter spacing hierarchy
- Improve color contrast for accessibility
- Add CSS custom properties for maintainable design tokens
- Enhanced focus states and text selection
- Professional academic typography matching top educational platforms
2025-09-18 10:18:33 -04:00
Vijay Janapa Reddi
91418a2a8e Transform to professional academic design
- Remove excessive emojis while maintaining strategic usage
- Update CSS with academic typography (Source Sans Pro, Source Serif Pro)
- Professional color scheme with academic blues (#2c3e50, #3498db)
- Clean navigation without emoji decorations
- Enhanced visual hierarchy with professional spacing
- University-level styling consistent with Harvard standards
- Maintained pedagogical effectiveness and engagement
- Improved readability with clean, accessible design
- Professional tone throughout all content
- Academic credibility without sacrificing approachability
2025-09-18 10:08:52 -04:00
Vijay Janapa Reddi
df67eb4a0a Rename milestone to checkpoint system with enhanced Rich CLI visualizations
Major changes:
- Renamed entire system from "milestone" to "checkpoint" for academic framing
- Checkpoints are now positioned as academic progress markers in learning journey
- Implemented enhanced Rich CLI timeline with progress bars and connecting lines
- Added overall progress tracking (16/16 modules = 100%)

Enhanced timeline visualization:
- Horizontal view shows progress bar with filled/unfilled segments
- Visual connecting lines between checkpoints showing completion status
- Color-coded progress: green (complete), yellow (in-progress), dim (future)
- Percentage indicators for each checkpoint and overall progress

CLI improvements:
- `tito checkpoint status` - Shows overall and per-checkpoint progress
- `tito checkpoint timeline --horizontal` - Rich visual progress line
- `tito checkpoint timeline` - Vertical tree view with module details
- Better progress indicators with filled bars and connecting lines

Documentation updates:
- Renamed milestone-system.md to checkpoint-system.md
- Updated all references from milestone to checkpoint terminology
- Emphasized academic checkpoint philosophy and progress markers
- Added descriptions of new Rich CLI visualizations

Benefits:
- More academic framing aligns with educational context
- Visual progress bars provide immediate feedback on learning journey
- Checkpoint terminology is more familiar to students
- Rich CLI visualizations make progress tracking engaging
2025-09-16 13:27:43 -04:00
Vijay Janapa Reddi
a9028691a9 Rebuild book with streamlined resources page 2025-07-18 12:18:47 -04:00
Vijay Janapa Reddi
7cda82daa7 build: Update generated book content with all improvements
- Regenerated all chapters with YAML-based difficulty ratings
- Updated book with improved navigation and fixed appendix links
- Applied copyright year 2025 across all pages
- Integrated inclusive language changes throughout generated content
- Book now reflects all UX and consistency improvements
2025-07-16 11:48:38 -04:00
Vijay Janapa Reddi
1f66a6053c Fix capstone difficulty rating and improve timeline messaging
- Updated book generation to include 15_capstone with 5-star difficulty rating
- Changed time estimate from '20-40 hours' to 'Capstone Project' for better visitor experience
- Removed specific week references from project phases for more encouraging presentation
- Maintained detailed project structure while making timeline more flexible
- Ensures consistent 5-star rating for expert-level modules across the framework
2025-07-16 11:11:58 -04:00
Vijay Janapa Reddi
97d8cbf29a 🔧 Update tagline: 'understand' → 'build' for clarity
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.
2025-07-16 08:09:04 -04:00
Vijay Janapa Reddi
6597043dba Fix broken grid cards across all book chapters
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
2025-07-16 07:39:13 -04:00
Vijay Janapa Reddi
ff2d60f227 Update book footer and remove copyright
- Changed author from 'TinyTorch Team' to 'Vijay Janapa Reddi, Harvard University'
- Removed copyright notice (© Copyright 2025)
- Updated book title to match new tagline
- Footer now shows clean author attribution without copyright clutter
2025-07-15 21:23:42 -04:00
Vijay Janapa Reddi
25497661fc Update module numbering from 00-13 to 01-14 and refresh tagline
- 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)
2025-07-15 21:11:07 -04:00
Vijay Janapa Reddi
827aaabff6 🧪 Test publish command 2025-07-15 20:39:51 -04:00
Vijay Janapa Reddi
b34f3681dd 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
Vijay Janapa Reddi
cb68c0e1bb Simplify book directory structure
 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
2025-07-15 18:21:59 -04:00