mirror of
https://github.com/MLSysBook/TinyTorch.git
synced 2026-04-27 23:07:32 -05:00
d03435c5c3
Documentation updates across the codebase: Root documentation: - README.md: Updated references from book/ to site/ - CONTRIBUTING.md: Updated build and workflow instructions - .shared-ai-rules.md: Updated AI assistant rules for new structure GitHub configuration: - Issue templates updated for new module locations - Workflow references updated from book/ to site/ docs/ updates: - STUDENT_QUICKSTART.md: New paths and structure - module-rules.md: Updated module development guidelines - NBGrader documentation: Updated for module restructuring - Archive documentation: Updated references Module documentation: - modules/17_memoization/README.md: Updated after reordering All documentation now correctly references: - site/ instead of book/ - modules/XX_name/ instead of modules/source/
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