Files
TinyTorch/docs
Vijay Janapa Reddi 09cde682b1 Remove cleanup command from demo GIF, handle in scripts instead
Students should see the clean first-time workflow, not our test infrastructure.

Changes:
- VHS tape: Shows 'cd /tmp' then 'git clone' (no rm -rf)
- generate.sh: Cleans /tmp/TinyTorch BEFORE running VHS
- test_demo_workflow.sh: Already cleaned before testing
- README: Documents the separation of concerns

This presents the ideal student experience while maintaining reproducibility:
- Students: See clean setup flow (cd → clone → setup)
- Scripts: Handle cleanup behind the scenes
- Tests: Validate fresh environment every time

GIF size: 494KB → 467KB (optimized further)
2025-11-28 05:54:12 +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