github-starred/TinyTorch
2
0
Fork 0
mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-03-11 23:03:33 -05:00
Code Issues 7 Packages Projects Releases Wiki Activity

Update documentation references to reflect current repository structure

Browse Source 
- Fix README.md: Replace broken references to non-existent files
  - Remove STUDENT_VERSION_TOOLING.md references (file does not exist)
  - Remove .claude/ directory references (internal development files)
  - Remove book/ directory references (does not exist)
  - Update instructor documentation links to point to existing files
  - Point to INSTRUCTOR.md, TA_GUIDE.md, and docs/ for resources

- Fix paper.tex: Update instructor resources list
  - Replace non-existent MAINTENANCE.md with TA_GUIDE.md
  - Maintenance commitment details remain in paragraph text
  - All referenced files now exist in repository

All documentation links now point to actual files in the repository
This commit is contained in:
Vijay Janapa Reddi
2025-11-22 21:57:21 -05:00
parent ba482bab71
commit 6722c3f1bc
2 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -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

2
paper/paper.tex
View File

@@ -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.