Commit Graph

319 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
6fa4bde3d1 Fix tensor module learning objectives formatting
- Added bold formatting to match other modules' style
- Enhanced clarity with more specific descriptors
- Added 'efficiently' and 'with proper broadcasting' for precision
- Now consistent with activations and other modules formatting
- Improves visual hierarchy and readability in built book
2025-07-16 08:32:25 -04:00
Vijay Janapa Reddi
8433ede633 Enhances intro with motivational content
Updates the introduction with additional motivational context and a clearer explanation of TinyTorch's purpose.

Emphasizes the hands-on learning approach and the benefits of building ML frameworks from scratch.

Replaces a sentence with an analogy to enhance the message's impact.
2025-07-16 08:29:46 -04:00
Vijay Janapa Reddi
42da141c8c Merge remote-tracking branch 'origin/dev' into dev 2025-07-16 08:29:35 -04:00
Vijay Janapa Reddi
c56034a301 Add prominent author attribution
- Added 'Prof. Vijay Janapa Reddi (Harvard University)' right after title
- Positioned prominently for proper academic/course attribution
- Matches book config author field for consistency
- Standard practice for educational materials and courses
2025-07-16 08:24:36 -04:00
Vijay Janapa Reddi
a991a21004 Final intro cleanup: remove redundancy and dashes
- Removed redundant 'How This Works' section (covered by Learning Philosophy)
- Removed academic jargon sentence about educational framework
- Cleaned up all em dashes, hyphens, and arrows per user preference
- Changed 'Build → Use → Master' to 'Build, Use, Master'
- Result: Much cleaner, more direct presentation
2025-07-16 08:23:46 -04:00
Vijay Janapa Reddi
d60d1193ef Streamline intro for natural visitor flow
Key improvements:
- Moved educational framework positioning up front where visitors need it
- Blended 'Science vs Engineering' into more natural 'Core Difference'
- Removed defensive 'Our unique contribution' language
- Changed 'What Makes Different' to conversational 'How This Works'
- Removed bullet points for more natural paragraph flow
- Simplified acknowledgments without academic defensiveness

Result: Much more welcoming and confident presentation
2025-07-16 08:21:03 -04:00
Vijay Janapa Reddi
e3f83f4cfe Add Machine Learning Systems book reference
- Added complementary learning reference to mlsysbook.ai
- Positioned as comprehensive systems knowledge companion
- TinyTorch = build systems, ML Systems book = systems context
- Perfect educational pairing for complete ML systems understanding
2025-07-16 08:19:08 -04:00
Vijay Janapa Reddi
03a6e395c9 🙏 Add proper Acknowledgments section with unique positioning
Replaced 'Academic Foundation' with 'Acknowledgments' that:
- Credits Harvard CS249r origins properly
- Acknowledges inspiration from tinygrad and micrograd projects
- Emphasizes TinyTorch's unique value as 'minimalistic educational framework'
- Differentiates from research/production focus of other projects
- Highlights systematic pedagogy and course infrastructure
- Reinforces transformation from 'users to builders'

Result: Proper attribution while clearly establishing TinyTorch's distinct educational mission.
2025-07-16 08:14:20 -04:00
Vijay Janapa Reddi
ae3107b136 📚 Align Course Journey with navigation structure
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.
2025-07-16 08:13:42 -04:00
Vijay Janapa Reddi
83d4c923ec 🧹 Clean up punctuation: remove em dashes throughout
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.
2025-07-16 08:13:04 -04:00
Vijay Janapa Reddi
93d244e26b 🔧 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
5c502d3ddb 💡 Add Science vs Engineering differentiation to landing page
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.
2025-07-16 08:08:00 -04:00
Vijay Janapa Reddi
453a71cbdc Refined landing page with better balance and substance
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.
2025-07-16 08:03:40 -04:00
Vijay Janapa Reddi
f12005bbff 🎨 Redesign landing page with UI/UX best practices
Applied conversion optimization principles:
- Move CTA above the fold: 'Start Building Now' at top
- Stronger hook: 'Most ML education teaches use, TinyTorch teaches understanding'
- Clear hierarchy: Build → Prove → Guide action
- Condensed benefits: Bullet-heavy sections → scannable blocks
- Progressive disclosure: Core difference → Why it works → Course journey
- Single focused outcome: 'You become the expert others ask'
- Reduced cognitive load: Less text walls, more visual breaks
- Action-oriented language: 'Try', 'Build', 'Start' vs passive descriptions

Result: Cleaner, more converting landing page optimized for first-time visitors.
2025-07-16 07:51:17 -04:00
Vijay Janapa Reddi
5c34f7affe Update book intro.md to match new README structure
- 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
2025-07-16 07:49:59 -04:00
Vijay Janapa Reddi
d078c5e2b7 Restructure README: Lead with big picture and key differentiators
- 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
2025-07-16 07:45:31 -04:00
Vijay Janapa Reddi
97ad65d30e Update README.md 2025-07-16 07:42:28 -04:00
Vijay Janapa Reddi
cfe334721b Remove unnecessary breadcrumb navigation from book chapters
- 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
2025-07-16 07:41:21 -04:00
Vijay Janapa Reddi
fd205549e6 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
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
9f8a5a8aa3 PILOT: Implement standardized module README structure (Tensor module)
New Standard Structure Applied:
 📊 Module Info - Consistent difficulty, time, prerequisites
 🎯 Learning Objectives - Clear, measurable outcomes
 🧠 Build → Use → Understand - Pedagogical framework
 📚 What You'll Build - Concrete code examples
 🚀 Getting Started - Prerequisites check + workflow
 🧪 Testing Your Implementation - Inline + module + manual tests
 🎯 Key Concepts - Real-world connections + core ideas
 🎉 Ready to Build? - Motivational ending + grid cards

Benefits for Students:
- Predictable navigation structure
- Clear learning outcomes upfront
- Concrete examples of what they'll build
- Multiple testing approaches for confidence
- Real-world context for motivation

Benefits for Instructors:
- Professional consistency across modules
- Clear pedagogical progression
- Easy to maintain and update
- Coherent course experience

Next: Review this pilot, then apply to remaining 13 modules
2025-07-16 01:31:00 -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
00b11a6bf6 Improve module formatting and navigation consistency
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
2025-07-16 01:22:09 -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
13b1ac49ca Streamline interactive elements - remove redundant section header
- 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
2025-07-16 01:12:28 -04:00
Vijay Janapa Reddi
816a421777 Use grid card format from main branch merge for interactive elements
- 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
2025-07-16 01:09:15 -04:00
Vijay Janapa Reddi
d03cd82c26 Restore original interactive elements format - detailed admonition boxes with Bootstrap buttons
- 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
2025-07-16 01:07:23 -04:00
Vijay Janapa Reddi
7f79425b90 Simplify interactive elements to match usage paths style - clean text links only 2025-07-16 01:03:17 -04:00
Vijay Janapa Reddi
8a292234c3 Update interactive elements to match intro page style - cleaner admonition format 2025-07-16 00:59:54 -04:00
Vijay Janapa Reddi
7e08a7f328 Add interactive learning elements (Builder, Jupyter, Colab links) to all chapters 2025-07-16 00:58:59 -04:00
Vijay Janapa Reddi
f219f41c78 Remove old notebook files, now using README-based chapters 2025-07-16 00:56:41 -04:00
Vijay Janapa Reddi
eb4e04b174 Implement README-to-chapter conversion for cleaner website workflow 2025-07-16 00:56:36 -04:00
Vijay Janapa Reddi
775da8e445 Merge branch 'main' into dev 2025-07-16 00:45:19 -04:00
Vijay Janapa Reddi
232087a0cf Update book/_toc.yml and tito/commands/book.py with latest fixes and notebook generation logic 2025-07-16 00:44:22 -04:00
Vijay Janapa Reddi
2c6d348227 Auto-generate notebooks during book build process 2025-07-15 23:53:26 -04:00
Vijay Janapa Reddi
074f695fb3 Generate notebook files from Python modules for direct access 2025-07-15 23:51:56 -04:00
Vijay Janapa Reddi
1296722175 Fix GitHub Actions: install requirements.txt before tito CLI to include rich dependency 2025-07-15 23:36:14 -04:00
Vijay Janapa Reddi
a81321b373 Fix GitHub Actions: create and activate virtual environment for tito CLI 2025-07-15 23:33:43 -04:00
Vijay Janapa Reddi
99f4a1234f Revert "Fix tito CLI: skip virtual environment validation in CI environments"
This reverts commit de505f5fd0747273be343e878da6cd57a2a6b5a7.
2025-07-15 23:33:04 -04:00
Vijay Janapa Reddi
1a8e184015 Fix tito CLI: skip virtual environment validation in CI environments 2025-07-15 23:32:33 -04:00
Vijay Janapa Reddi
308f57ff2f Fix GitHub Actions workflow: remove virtual environment complexity in CI 2025-07-15 23:29:09 -04:00
Vijay Janapa Reddi
4f052f5914 Fix GitHub workflow to properly activate virtual environment
- 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
2025-07-15 23:26:34 -04:00
Vijay Janapa Reddi
3fecb39065 Merge branch 'dev' 2025-07-15 22:54:03 -04:00
Vijay Janapa Reddi
c3644c7620 Streamline GitHub workflow to use tito commands
- Replace manual steps with tito book build
- Install tito CLI in workflow
- Add tito/** to trigger paths
- Simplify build process for consistency
2025-07-15 22:53:34 -04:00
Vijay Janapa Reddi
9317fb2d94 Merge branch 'feature/interactive-access' into dev 2025-07-15 22:37:46 -04:00
Vijay Janapa Reddi
3ef215f78f Finalize book intro and author attribution
- 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
2025-07-15 21:49:05 -04:00
Vijay Janapa Reddi
90ddf530c5 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
01e4aec62b 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
bb03b4b2f1 Update README.md 2025-07-15 21:09:16 -04:00