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
e053dc9a71 Improve Jupyter Book styling and configuration
- Replace ugly gray background with clean white theme
- Add proper logo styling and configuration
- Update book chapters from module READMEs
- Add educational-ml-docs-architect agent
- Clean up custom CSS for better readability
- Configure logo.png in correct location
- Update tito book command with proper chapters
2025-09-18 09:48:01 -04:00
Vijay Janapa Reddi
08ab153b64 Fix book conversion script to handle dynamic module names
- Replace hardcoded module names array with dynamic reading from module.yaml files
- Add get_module_names() function to read actual module structure
- Fix IndexError in get_prev_module_name() and get_next_module_name() functions
- Update navigation logic to use actual module count instead of hardcoded assumptions
- Successfully converts all 16 modules to chapters with proper navigation
- Book build now completes without errors
2025-07-18 15:01:16 -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
1cb070c7d6 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
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
12d7f6eec9 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
50d2d63d31 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
8ee4be7951 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
23f3534d82 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
5a145e8615 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
f6e9fb4591 Simplify interactive elements to match usage paths style - clean text links only 2025-07-16 01:03:17 -04:00
Vijay Janapa Reddi
dd94d8d44a Update interactive elements to match intro page style - cleaner admonition format 2025-07-16 00:59:54 -04:00
Vijay Janapa Reddi
0dc3ca16a3 Add interactive learning elements (Builder, Jupyter, Colab links) to all chapters 2025-07-16 00:58:59 -04:00
Vijay Janapa Reddi
e283e95056 Implement README-to-chapter conversion for cleaner website workflow 2025-07-16 00:56:36 -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