Commit Graph

36 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
35c752e4b9 Remove test carousel GIF files 2025-11-16 22:18:22 -05:00
Vijay Janapa Reddi
faa073a3fc Update carousel terminal configs: optimized dimensions and styling
Configuration updates:
- Reduced terminal width from 160 to 100 columns for better text density
- Increased font size from 12px to 14px for improved readability
- Added ANSI green color codes to shell prompts
- Updated base-config.yml as single source of truth

Generated new GIFs:
- 01-clone-setup.gif: Regenerated with new 100-column layout
- Other GIFs pending regeneration with ./render-all.sh

Documentation:
- Updated README with current dimensions and font size
- Documented configuration inheritance pattern

These changes optimize the carousel display by reducing wasted whitespace
while maintaining readability with larger fonts. The 100-column width
provides better visual balance in the carousel container.
2025-11-16 22:18:08 -05:00
Vijay Janapa Reddi
87187112f1 Update carousel with wider terminal GIFs (160x24) and colored prompts
- Increased terminal dimensions from 80x24 to 160x24 for wider, more cinematic format
- Added ANSI green color codes to prompts for better visual appeal
- Updated all 4 Terminalizer YAML configs with consistent styling
- Created base-config.yml as single source of truth for shared settings
- Updated CSS to use dark terminal background instead of gray
- Changed object-fit from contain to cover for better width filling
- Added render-all.sh batch script for regenerating all GIFs
- Updated README with complete documentation and troubleshooting

Generated GIFs:
- 01-clone-setup.gif (7.0M)
- 02-build-jupyter.gif (1.3M)
- 03-export-tito.gif (1.9M)
- 04-validate-history.gif (3.3M)
2025-11-16 21:33:04 -05:00
Vijay Janapa Reddi
33adb79de5 Update all carousel GIFs with wider dimensions (120x30)
All 4 GIFs regenerated with new format:
- 01-clone-setup.gif (2.7M)
- 02-build-jupyter.gif (565K)
- 03-export-tito.gif (890K)
- 04-validate-history.gif (1.5M)

Consistent 120×30 dimensions fill carousel width nicely
2025-11-16 18:49:27 -05:00
Vijay Janapa Reddi
7941899b70 Update GIFs with wider dimensions (120x30)
Regenerated carousel GIFs with new wider format:
- 120 columns × 30 rows (previously 80×24)
- Better fills carousel width
- More professional appearance
2025-11-16 18:26:55 -05:00
Vijay Janapa Reddi
53f93ba96e Add shared base config for demo styling consistency
- Create base-config.yml as single source of truth for styling
- Document that Terminalizer doesn't support config inheritance
- Individual demo configs are manually kept in sync with base config
- Makes it easier to maintain consistent look across all demos
2025-11-16 18:21:46 -05:00
Vijay Janapa Reddi
bce95c11b9 Add animated carousel demos with Terminalizer
- Add 4 workflow demo GIFs (Clone & Setup, Build in Jupyter, Export with TITO, Validate with History)
- Create Terminalizer YAML configs for reproducible renders (120x30, vibrant color themes)
- Add render-all.sh script for batch GIF generation
- Update carousel CSS for proper GIF display with emoji fallbacks
- Update intro.md carousel to reference GIFs
- Add comprehensive README with setup instructions

All configs use consistent styling:
- Dimensions: 120 columns × 30 rows (wider format)
- Theme: Vibrant colors with good contrast
- Font: Monaco 12px monospace
- Quality: 100% for crisp output
2025-11-16 18:20:12 -05:00
Vijay Janapa Reddi
34542a8140 Fix static assets deployment: add missing JS files to conf.py and ensure .nojekyll is copied to build output 2025-11-15 12:00:59 -05:00
Vijay Janapa Reddi
3599623716 Update custom CSS styling for Mermaid diagrams 2025-11-15 11:37:35 -05:00
Vijay Janapa Reddi
3627090ae7 Update custom CSS styling 2025-11-14 18:35:36 -05:00
Vijay Janapa Reddi
5597e600f0 Simplify pip install indicator to inline coming soon text
- Remove separate badge, add inline (coming soon) text
- Cleaner design that works with existing under construction banner
2025-11-14 18:33:47 -05:00
Vijay Janapa Reddi
9632d634f7 Add Work in Progress indicator for pip install
- Add alpha release badge above pip install command on intro page
- Update README status badge to reflect alpha status
- Clarify that package is in active development
2025-11-14 18:31:26 -05:00
Vijay Janapa Reddi
5ff776673b Update site content and documentation
- Refactor resources.md to focus on ML Systems textbook as primary companion
- Remove Academic Foundation section from credits.md (moved to resources)
- Update quickstart guide, FAQ, and student workflow documentation
- Improve classroom use documentation with updated guidance
2025-11-14 18:27:22 -05:00
Vijay Janapa Reddi
03ecc5ccac Update build scripts and site configuration
- Update PDF build scripts for site directory structure
- Update Jupyter Book configuration files
- Update site README with current build instructions
2025-11-14 18:27:20 -05:00
Vijay Janapa Reddi
e4bfd0ee84 Enhance intro page with interactive hero carousel and ML timeline
- Add hero carousel component with auto-advance and keyboard navigation
- Add interactive ML history timeline with milestone popups
- Add comprehensive CSS styling for carousel and timeline components
- Update intro page content with tier-based structure and improved messaging
- Add install command display and enhanced visual design
2025-11-14 18:27:17 -05:00
Vijay Janapa Reddi
6e15d91800 Update site navigation to include tier overview pages
- Add tier overview pages to each tier section in navigation
- Reorder resources section to place Learning Resources before Credits
- Improve navigation structure for better tier-based learning flow
2025-11-14 18:27:15 -05:00
Vijay Janapa Reddi
a787bcbba4 Add tier overview pages for Foundation, Architecture, Optimization, and Capstone
- Add foundation.md: Overview of Foundation Tier (modules 01-07)
- Add architecture.md: Overview of Architecture Tier (modules 08-13)
- Add optimization.md: Overview of Optimization Tier (modules 14-19)
- Add olympics.md: Overview of Capstone Competition (module 20)

These pages provide comprehensive tier-level context and learning objectives
2025-11-14 18:27:13 -05:00
Vijay Janapa Reddi
4520fb1a9c Improve WIP banner functionality and styling
- Change banner positioning from relative to fixed for better visibility
- Add header spacing to accommodate fixed banner
- Enhance banner injection with dynamic HTML creation
- Add comments explaining banner implementation details
2025-11-13 17:50:53 -05:00
Vijay Janapa Reddi
08143b0f7f Update site branding and add documentation comments
- Update site title to Tiny🔥Torch branding
- Add emojis to tier captions for visual consistency
- Update intro page heading and description
- Add comprehensive comments explaining branding and UI changes
2025-11-13 17:50:52 -05:00
Vijay Janapa Reddi
d953790f45 Update site intro: refine title and quickstart link 2025-11-13 11:47:39 -05:00
Vijay Janapa Reddi
0d2560c490 Update site documentation and development guides
- Improve site navigation and content structure
- Update development testing documentation
- Enhance site styling and visual consistency
- Update release notes and milestone templates
- Improve site rebuild script functionality
2025-11-13 10:42:51 -05:00
Vijay Janapa Reddi
afd1cd442d Fix failing module tests
- Fix 14_profiling: Replace Tensor with Linear model in test_module, fix profile_forward_pass calls
- Fix 15_quantization: Increase error tolerance for INT8 quantization test, add export marker for QuantizedLinear
- Fix 19_benchmarking: Return Tensor objects from RealisticModel.parameters(), handle memoryview in pred_array.flatten()
- Fix 20_capstone: Make imports optional (MixedPrecisionTrainer, QuantizedLinear, compression functions)
- Fix 20_competition: Create Flatten class since it doesn't exist in spatial module
- Fix 16_compression: Add export markers for magnitude_prune and structured_prune

All modules now pass their inline tests.
2025-11-12 14:19:33 -05:00
Vijay Janapa Reddi
29619da811 Standardize emoji usage across all site pages for professional consistency
- Removed emojis from all section headers (## and ###)
- Reduced emojis in body text and callout boxes
- Standardized link references (removed emoji prefixes)
- Maintained professional tone while keeping content accessible
- Updated quickstart-guide, student-workflow, tito-essentials, faq, datasets, community, resources, testing-framework, learning-progress, checkpoint-system, and all chapter files
2025-11-12 11:42:03 -05:00
Vijay Janapa Reddi
f84e7f16ac Restructure site navigation: modules-first, separate capstone, streamline sections
- Reorganized navigation to prioritize modules (Foundation/Architecture/Optimization tiers)
- Separated Capstone Competition from Optimization tier
- Removed Visual Learning Map from Course Orientation (broken mermaid diagrams)
- Streamlined Using TinyTorch section
- Redesigned landing page for professional, student-focused experience
- Reduced emojis in navigation captions
- Fixed build error by excluding modules directory patterns
- Created symlinks for all module ABOUT files in site/modules/
2025-11-12 11:39:57 -05:00
Vijay Janapa Reddi
3c48662263 Fix Optimization Tier range in TOC: 14-19 → 14-20 2025-11-12 10:31:20 -05:00
Vijay Janapa Reddi
1a1e3d7457 Simplify and condense site documentation content 2025-11-11 22:23:21 -05:00
Vijay Janapa Reddi
b96f988bb2 Add visual learning journey with Mermaid diagrams and integrate new pages
## New Documentation Pages Integrated into Site Navigation

**site/learning-journey-visual.md** - 10 interactive Mermaid diagrams:
1. Complete Learning Flow - Full flowchart through all 20 modules & 6 milestones
2. Module Dependencies - Shows how modules depend on each other
3. Three-Tier Timeline - Visual progression through Foundation/Architecture/Optimization
4. Historical Milestones - Gantt chart showing ML history recreation (1957→2024)
5. Student Learning Paths - Decision tree for different learning approaches
6. Capability Progression - Skill levels unlocked at each tier
7. Workflow Cycle - The edit → export → validate loop
8. Dataset Strategy - When to use shipped vs downloaded datasets
9. Time vs Outcomes Quadrant - Comparing learning path investments
10. Difficulty Curve - Line chart showing module difficulty progression

## Site Navigation Updates (_toc.yml)

**Added to "Using TinyTorch" section:**
- Student Workflow (student-workflow.md) - Essential edit → export → validate cycle
- Datasets Guide (datasets.md) - Complete dataset documentation

**Added to "Course Orientation" section:**
- Visual Learning Map (learning-journey-visual.md) - NEW Mermaid diagram showcase
- FAQ (faq.md) - Comprehensive answers to common questions

## Mermaid Integration

- Mermaid already configured in _config.yml (v10.6.1)
- All diagrams use color coding:
  - Blue: Foundation modules
  - Orange: Critical modules (Autograd, Training)
  - Purple: Advanced architecture modules
  - Green: Milestone achievements
  - Yellow: North Star milestone (CIFAR-10)
  - Red: Capstone

## Benefits

**Visual learners**: Diagrams show the complete learning journey at a glance
**Navigation**: All new pages now appear in site sidebar
**Discoverability**: FAQ answers "Why TinyTorch vs alternatives"
**Dataset clarity**: Students understand shipped vs downloaded data strategy
**Journey visualization**: See the path from tensors to transformers [Claude Code](https://claude.com/claude-code)
2025-11-11 22:13:31 -05:00
Vijay Janapa Reddi
94b25debbd Prepare TinyTorch for December 2024 community release
## Documentation Consistency
- Fix module count: All docs now correctly show 20 modules (01-20)
- Update Optimization Tier: Modules 14-20 (added 19 Benchmarking, 20 Competition)
- Correct tier descriptions across student-workflow, learning-progress, classroom-use

## New Documentation
- **FAQ (site/faq.md)**: Comprehensive FAQ addressing:
  - Why TinyTorch vs PyTorch/TensorFlow direct usage
  - Why TinyTorch vs micrograd/nanoGPT
  - Who should use TinyTorch
  - Course structure and flexibility
  - Practical getting started questions

- **Datasets (site/datasets.md)**: Complete dataset documentation:
  - Ship-with-repo datasets (TinyDigits 310KB, TinyTalks 40KB)
  - Downloaded datasets (MNIST 10MB, CIFAR-10 170MB)
  - Design philosophy and rationale
  - Usage instructions per milestone

- **Release Checklist (DECEMBER_2024_RELEASE.md)**:
  - Comprehensive pre-launch checklist
  - Documentation, technical, community preparation tasks
  - Version recommendation: v0.9.0
  - Success metrics and launch timeline

## Module Count Corrections
- learning-progress.md: 18→20 modules, added Benchmarking & Competition to table
- student-workflow.md: 18→20 modules, updated Optimization tier description
- classroom-use.md: 18→20 modules in feature list

## Version Recommendation
Proposed **v0.9.0** for December 2024 release:
- Signals feature-complete for individual learners
- Reserves v1.0 for classroom integration (Spring 2025)
- Allows v0.9.x patches for post-launch refinements [Claude Code](https://claude.com/claude-code)
2025-11-11 22:04:36 -05:00
Vijay Janapa Reddi
c7bc68fa37 Complete Phase 2 and 3 workflow documentation updates
Updated remaining documentation to clarify the actual TinyTorch workflow and mark optional/future features appropriately.

**Phase 2 (Important files):**
- **learning-progress.md**: Added workflow context at top, clear modules vs checkpoints vs milestones explanation, module progression tables by tier, marked checkpoints as optional
- **checkpoint-system.md**: Added prominent "Optional Progress Tracking" banner at top, clarified this is not required for core workflow

**Phase 3 (Supporting files):**
- **classroom-use.md**: Added "Coming Soon" banner for NBGrader integration, clarified current status vs planned features, updated to reflect 18 modules (not 20)

Key clarifications across all files:
- Core workflow: Edit modules → `tito module complete N` → Run milestone scripts
- Checkpoints are optional capability tracking (helpful for self-assessment)
- Instructor features marked as "coming soon" / "under development"
- All pages reference canonical student-workflow.md

Completes the workflow documentation audit identified by website-manager.
2025-11-11 21:49:37 -05:00
Vijay Janapa Reddi
770d27c21b Add canonical student workflow documentation
Created new student-workflow.md as the single source of truth for the TinyTorch development cycle. Updated quickstart-guide.md, tito-essentials.md, and intro.md to emphasize the simple workflow and reference the canonical guide.

Key changes:
- **New file**: site/student-workflow.md - Complete workflow guide
- **quickstart-guide.md**: Added workflow context and step-by-step examples
- **tito-essentials.md**: Simplified to focus on essential commands, marked checkpoint system as optional
- **intro.md**: Added workflow section early, simplified getting started, marked instructor features as "coming soon"

The actual workflow:
1. Edit modules in modules/source/
2. Export with `tito module complete N`
3. Validate by running milestone scripts

Checkpoint system and instructor features are documented as optional/coming soon, not primary workflow.
2025-11-11 21:31:38 -05:00
Vijay Janapa Reddi
4c0a046953 Remove emoji prefixes from markdown headers in milestones and site chapters 2025-11-11 21:17:22 -05:00
Vijay Janapa Reddi
f4a40ab655 Update milestones.md to reflect standardized milestone structure
Aligned website milestone documentation with the comprehensive README files:

1. Updated milestone naming consistency:
   - M06: '2024 Systems Age' → '2018 MLPerf' (historically accurate)
   - Updated Acts table to reflect correct module ranges

2. Fixed all script paths to match new naming convention:
   - M01: perceptron_trained.py → 01_rosenblatt_forward.py + 02_rosenblatt_trained.py
   - M02: xor_crisis folder → xor folder, updated script names
   - M05: vaswani_shakespeare.py → 01_vaswani_generation.py + 02_vaswani_dialogue.py
   - M06: optimize_models.py → 01_baseline_profile.py + 02_compression.py + 03_generation_opts.py

3. Enhanced M06 (MLPerf) section:
   - Added historical context (2018 MLCommons establishment)
   - Explained systematic optimization methodology
   - Included quantitative results (8-16× compression, 12-40× speedup)
   - Shows 3-script progressive optimization workflow

4. Maintained excellent 'Two Dimensions' framing:
   - Pedagogical Acts (WHY you're learning)
   - Historical Milestones (WHAT you can build)
   - Connection table showing how they relate

Documentation hierarchy: Milestone READMEs are canonical source,
website milestones.md provides overview + navigation.
2025-11-11 18:31:04 -05:00
Vijay Janapa Reddi
4bf15af074 Add pedagogical narrative: The Learning Journey
Created comprehensive six-act narrative explaining module progression:
- Act I: Foundation (01-04) - Building atomic components
- Act II: Learning (05-07) - The gradient revolution
- Act III: Data & Scale (08-09) - Real-world complexity
- Act IV: Language (10-13) - Sequential intelligence
- Act V: Production (14-19) - Optimization & deployment
- Act VI: Integration (20) - Complete AI systems

Changes:
1. Created site/chapters/learning-journey.md
   - Complete pedagogical narrative (6 acts, ~500 lines)
   - Explains WHY modules flow this way
   - Shows HOW each act builds on previous
   - Connects to milestones and tier structure
   - Student guidance for using the narrative

2. Updated site/intro.md (landing page)
   - Added "Understanding Your Complete Learning Journey" section
   - Three-card navigation: Tiers + Acts + Milestones
   - Guides students to three complementary views

3. Updated site/chapters/milestones.md
   - Added "Two Dimensions of Your Progress" section
   - Shows pedagogical (acts) vs historical (milestones) dimensions
   - Mapping table connecting acts to unlocked milestones

4. Updated site/chapters/00-introduction.md
   - Added cross-reference to learning-journey.md
   - Links pedagogical narrative to tier structure

5. Updated site/_toc.yml
   - Added learning-journey.md to Course Orientation section
   - Reorganized: Structure → Journey → Milestones

Rationale:
Website had WHAT (tiers), WHEN (milestones), WHERE (progress),
but lacked WHY (pedagogical progression) and HOW (learning story).
Learning journey fills this gap - explains module flow from atoms
to intelligence through narrative arc.

Uses both "tiers" (structure) and "acts" (narrative) complementarily.(https://claude.com/claude-code)
2025-11-11 18:22:35 -05:00
Vijay Janapa Reddi
56419ea4c2 Standardize milestone naming with numbered sequence and historical anchors
Applied consistent naming pattern: 0X_[figure]_[task].py

M01 (1957 Perceptron):
- forward_pass.py → 01_rosenblatt_forward.py
- perceptron_trained.py → 02_rosenblatt_trained.py

M02 (1969 XOR):
- xor_crisis.py → 01_xor_crisis.py
- xor_solved.py → 02_xor_solved.py

M03 (1986 MLP):
- mlp_digits.py → 01_rumelhart_tinydigits.py
- mlp_mnist.py → 02_rumelhart_mnist.py

M04 (1998 CNN):
- cnn_digits.py → 01_lecun_tinydigits.py
- lecun_cifar10.py → 02_lecun_cifar10.py

M05 (2017 Transformer):
- vaswani_chatgpt.py → 01_vaswani_generation.py
- vaswani_copilot.py → 02_vaswani_dialogue.py
- profile_kv_cache.py → 03_vaswani_profile.py

Benefits:
- Clear execution order (01, 02, 03)
- Historical context (rosenblatt, lecun, vaswani)
- Descriptive purpose (generation, dialogue, profile)
- Consistent structure across all milestones

Updated documentation:
- README.md: Updated all milestone examples
- site/chapters/milestones.md: Updated bash commands
2025-11-11 12:20:36 -05:00
Vijay Janapa Reddi
9ad2524bf2 Add jupyter-book to site/requirements.txt
- Added jupyter-book>=0.15.0,<1.0.0 dependency for documentation builds
- This dependency is referenced by GitHub Actions workflows
- Required for both HTML and PDF book generation
2025-11-11 11:56:25 -05:00
Vijay Janapa Reddi
a5679de141 Update documentation after module reordering
All module references updated to reflect new ordering:
- Module 15: Quantization (was 16)
- Module 16: Compression (was 17)
- Module 17: Memoization (was 15)

Updated by module-developer and website-manager agents:
- Module ABOUT files with correct numbers and prerequisites
- Cross-references and "What's Next" chains
- Website navigation (_toc.yml) and content
- Learning path progression in LEARNING_PATH.md
- Profile milestone completion message (Module 17)

Pedagogical flow now: Profile → Quantize → Prune → Cache → Accelerate
2025-11-10 19:37:41 -05:00