Files
TinyTorch/docs
Vijay Janapa Reddi e8a55f4252 Update demo GIFs with improved workflow and command fixes
Regenerated all 4 demo GIFs with:
- Added cleanup step (rm -rf /tmp/TinyTorch) to prevent "directory exists" errors
- Fixed command names (tito status → tito module status)
- Validated workflow with test_demo_workflow.sh script

The test script ensures reproducible demo generation by:
1. Cleaning /tmp/TinyTorch before clone
2. Running actual setup and TITO commands
3. Logging all output for verification

GIF sizes after regeneration:
- 01-zero-to-ready.gif: 814KB → 494KB (optimized)
- 02-build-test-ship.gif: 200KB (stable)
- 03-milestone-unlocked.gif: 86KB → 87KB
- 04-share-journey.gif: 105KB → 108KB
2025-11-28 05:43:17 +01:00
..

TinyTorch Documentation

This directory contains essential documentation for TinyTorch development and usage.

📚 User Documentation

  • STUDENT_QUICKSTART.md - Getting started guide for students
  • INSTRUCTOR_GUIDE.md - Setup and grading guide for instructors
  • cifar10-training-guide.md - Complete guide to achieving the north star goal (75% CIFAR-10 accuracy)

🔧 Development Documentation

  • tinytorch-assumptions.md - CRITICAL: TinyTorch complexity framework and implementation guidelines

Development Standards

  • development/module-rules.md - Module development standards and patterns

NBGrader Integration

  • nbgrader/NBGrader_Quick_Reference.md - Daily use commands and workflow
  • nbgrader/NBGRADER_STYLE_GUIDE.md - Style guide for NBGrader cells
  • nbgrader/NBGrader_Text_Response_Technical_Implementation.md - Technical implementation details

Start here:

  • Students: Read STUDENT_QUICKSTART.md
  • Instructors: Read INSTRUCTOR_GUIDE.md
  • Developers: Read tinytorch-assumptions.md FIRST, then development/module-rules.md