mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-03-12 07:53:34 -05:00
3215159726
Created unified setup-environment.sh script that: - Detects Apple Silicon and creates arm64-optimized venv - Handles all dependencies automatically - Creates activation helper with architecture awareness - Works across macOS (Intel/Apple Silicon), Linux, Windows Updated all documentation to use ONE setup command: - README.md: Updated Quick Start - docs/STUDENT_QUICKSTART.md: Updated Getting Started - book/quickstart-guide.md: Updated 2-Minute Setup Enhanced tito setup command with: - Apple Silicon detection (checks for Rosetta vs native) - Automatic arm64 enforcement when on Apple Silicon - Architecture verification after venv creation - Changed venv path from tinytorch-env to standard .venv Students now have ONE clear path: ./setup-environment.sh
TinyTorch Documentation
This directory contains essential documentation for TinyTorch development and usage.
📚 User Documentation
STUDENT_QUICKSTART.md- Getting started guide for studentsINSTRUCTOR_GUIDE.md- Setup and grading guide for instructorscifar10-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 guidelinestinytorch-textbook-alignment.md- Alignment with ML systems textbooks
Development Standards
development/module-rules.md- Module development standards and patternsdevelopment/nbgrader-standardized-testing.md- Testing standardsdevelopment/nbgrader-testing-template.md- Testing templates
NBGrader Integration
nbgrader/NBGrader_Quick_Reference.md- Daily use commands and workflownbgrader/NBGRADER_STYLE_GUIDE.md- Style guide for NBGrader cellsnbgrader/NBGrader_Text_Response_Technical_Implementation.md- Technical implementation details
📦 Archive
The archive/ directory contains historical documentation that's no longer actively maintained but preserved for reference.
Start here:
- Students: Read
STUDENT_QUICKSTART.md - Instructors: Read
INSTRUCTOR_GUIDE.md - Developers: Read
tinytorch-assumptions.mdFIRST, thendevelopment/module-rules.md