mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-04-28 05:17:39 -05:00
cb3476702e
- Add TESTING_QUICK_REFERENCE.md for quick access to common testing commands - Add comprehensive-module-testing-plan.md with module-by-module test requirements - Add gradient-flow-testing-strategy.md for gradient flow test coverage analysis - Add testing-architecture.md explaining two-tier testing approach - Update TEST_STRATEGY.md to reference master testing plan These documents define clear boundaries between unit tests (modules/), integration tests (tests/), and milestones, with comprehensive coverage analysis and implementation roadmap.
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