mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-07-17 18:33:15 -05:00
78d0ca6afc
Removed redundant and superseded review reports: - Module 15: COMPREHENSIVE_REVIEW_REPORT.md, FINAL_VALIDATION_REPORT.md, REVIEW_SUMMARY.md - Docs: RESTRUCTURING_VERIFICATION.md, book-development/CLEANUP_SUMMARY.md Also removed untracked files: - Module 11: REVIEW_REPORT_FINAL.md (superseded by REVIEW_REPORT.md) - Module 12: REVIEW_SUMMARY.md (redundant with REVIEW_REPORT.md) - Module 20: COMPLIANCE_CHECKLIST.md (redundant with REVIEW_REPORT.md) - Module 6, 8, 14, 18: COMPLIANCE_SUMMARY.md and QUICK_SUMMARY.md files Retained comprehensive REVIEW_REPORT.md files which contain the most complete QA documentation.
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