diff --git a/README.md b/README.md index 11480949..6d82a4ac 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ > 📢 **December 2024 Release** - TinyTorch is ready for community review! All 20 modules (Tensor → Transformers → Optimization → Capstone) are implemented with complete solutions. **Seeking feedback on pedagogy, implementation quality, and learning progression.** Student version tooling exists but is untested. This release focuses on validating the educational content before classroom deployment. > -> 🎯 **For Reviewers**: Read the [📚 Jupyter Book](https://mlsysbook.github.io/TinyTorch/) to evaluate pedagogy. Clone the repo to run implementations. See [STUDENT_VERSION_TOOLING.md](STUDENT_VERSION_TOOLING.md) for classroom deployment plans. +> 🎯 **For Reviewers**: Read the [📚 Jupyter Book](https://mlsysbook.github.io/TinyTorch/) to evaluate pedagogy. Clone the repo to run implementations. See [INSTRUCTOR.md](INSTRUCTOR.md) for classroom deployment and grading strategies. ## 📖 Table of Contents - [Why TinyTorch?](#why-tinytorch) @@ -429,14 +429,15 @@ pytest tests/ - **[Module READMEs](/modules/)** - Individual module documentation ### 👨‍🏫 For Instructors -- **[Instructor Guide](instructor/README.md)** - Complete teaching resources -- **[NBGrader Workflow](book/instructor-guide.md)** - Automated grading setup -- **[System Architecture](book/system-architecture.md)** - Technical overview +- **[Instructor Guide](INSTRUCTOR.md)** - Complete teaching resources +- **[TA Guide](TA_GUIDE.md)** - Teaching assistant preparation and common student errors +- **[Team Onboarding](docs/TEAM_ONBOARDING.md)** - Getting started as an instructor or TA +- **[NBGrader Integration](docs/nbgrader/)** - Automated grading setup and style guide ### 🛠️ For Developers -- **[Agent Coordination](.claude/guidelines/AGENT_COORDINATION.md)** - Development workflow -- **[Module Development](.claude/guidelines/MODULE_DEVELOPMENT.md)** - Creating new modules -- **[Testing Standards](.claude/guidelines/TESTING_STANDARDS.md)** - Quality assurance +- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute to TinyTorch +- **[Module Development](docs/development/module-rules.md)** - Creating and maintaining modules +- **[Privacy & Data](docs/PRIVACY_DATA_RETENTION.md)** - Data handling policies ## TinyMLPerf Competition & Leaderboard @@ -494,7 +495,7 @@ Modern ML education accepts that solutions are findable (Chegg, Course Hero, Dis **✅ Honor codes** (trust students to learn honestly) **✅ Focus on journey** (building > having built) -See [STUDENT_VERSION_TOOLING.md](STUDENT_VERSION_TOOLING.md) for classroom deployment strategies. +See [INSTRUCTOR.md](INSTRUCTOR.md) for classroom deployment strategies and academic integrity approaches. ### Honor Code diff --git a/paper/paper.tex b/paper/paper.tex index 3303f384..7d832aab 100644 --- a/paper/paper.tex +++ b/paper/paper.tex @@ -998,7 +998,7 @@ Connection maps transform isolated modules into coherent curriculum. Students se \subsection{Open Source Infrastructure} \label{subsec:opensource} -TinyTorch is released as open source to enable community adoption and evolution.\footnote{Code released under MIT License, curriculum materials under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA). Repository: \url{https://github.com/harvard-edge/TinyTorch}} The repository includes instructor resources: \texttt{CONTRIBUTING.md} (guidelines for bug reports and curriculum improvements), \texttt{INSTRUCTOR.md} (30-minute setup guide, grading rubrics, common student errors), and \texttt{MAINTENANCE.md} (support commitment through 2027, succession planning for community governance). +TinyTorch is released as open source to enable community adoption and evolution.\footnote{Code released under MIT License, curriculum materials under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA). Repository: \url{https://github.com/harvard-edge/TinyTorch}} The repository includes instructor resources: \texttt{CONTRIBUTING.md} (guidelines for bug reports and curriculum improvements), \texttt{INSTRUCTOR.md} (30-minute setup guide, grading rubrics, common student errors), and \texttt{TA\_GUIDE.md} (teaching assistant preparation and debugging strategies). \textbf{Maintenance Commitment}: The author commits to bug fixes and dependency updates through 2027, community pull request review within 2 weeks, and annual releases incorporating educator feedback. Community governance transition (2026--2027) will establish an educator advisory board and document succession planning to ensure long-term sustainability beyond single-author maintenance.