mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-03-12 03:13:35 -05:00

Files

Vijay Janapa Reddi a16bfc8a32 feat: Complete educational module-developer framework with progressive disclosure

- Enhanced module-developer agent with Dr. Sarah Rodriguez persona
- Added comprehensive educational frameworks and Golden Rules
- Implemented Progressive Disclosure Principle (no forward references)
- Added Immediate Testing Pattern (test after each implementation)
- Integrated package structure template (📦 where code exports to)
- Applied clean NBGrader structure with proper scaffolding
- Fixed tensor module formatting and scope boundaries
- Removed confusing transparent analysis patterns
- Added visual impact icons system for consistent motivation

🎯 Ready to apply these proven educational principles to all modules

2025-09-28 05:33:38 -04:00

README.md

TinyTorch Documentation

This directory contains essential documentation for TinyTorch development and usage.

📚 User Documentation

STUDENT_QUICKSTART.md - Getting started guide for students
INSTRUCTOR_GUIDE.md - Setup and grading guide for instructors
cifar10-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
tinytorch-textbook-alignment.md - Alignment with ML systems textbooks

Development Standards

development/module-rules.md - Module development standards and patterns
development/nbgrader-standardized-testing.md - Testing standards
development/nbgrader-testing-template.md - Testing templates

NBGrader Integration

nbgrader/NBGrader_Quick_Reference.md - Daily use commands and workflow
nbgrader/NBGRADER_STYLE_GUIDE.md - Style guide for NBGrader cells
nbgrader/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.md FIRST, then development/module-rules.md