mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-07-17 23:22:41 -05:00
Removed 42 planning, brainstorming, and status tracking documents that served their purpose during development but are no longer needed for release. Changes: - Root: Removed 4 temporary/status files - binder/: Removed 20 planning documents (kept essential setup files) - docs/: Removed 16 planning/status documents (preserved all user-facing docs and website dependencies) - tests/: Removed 2 status documents (preserved all test docs and milestone system) Preserved files: - All user-facing documentation (README, guides, quickstarts) - All website dependencies (INSTRUCTOR_GUIDE, PRIVACY_DATA_RETENTION, TEAM_ONBOARDING) - All functional configuration files - All milestone system documentation (7 files in tests/milestones/) Updated .gitignore to prevent future accumulation of internal development files (.claude/, site/_build/, log files, progress.json)
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 guidelines
Development Standards
development/module-rules.md- Module development standards and patterns
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
Start here:
- Students: Read
STUDENT_QUICKSTART.md - Instructors: Read
INSTRUCTOR_GUIDE.md - Developers: Read
tinytorch-assumptions.mdFIRST, thendevelopment/module-rules.md