mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-05-06 09:38:33 -05:00
Audit (parent commit): every tinytorch/src/NN_xxx/ABOUT.md is a stale duplicate of tinytorch/quarto/modules/NN_xxx.qmd, with the QMD strictly newer/richer (each QMD has additional sections like Your TinyTorch, PyTorch comparison, MLPerf section that ABOUT.md is missing). Drift confirms ABOUT.md is unmaintained: e.g., 12_attention/ABOUT.md still says "GPT-3 training (4x inference)" while the QMD was corrected to 5x. Single-source-of-truth in quarto/modules/ stops the recurrence. The retired Jupyter Book site (tinytorch/site-legacy/) was the only historical consumer; it is deleted in the next commit. Also deleted: - tools/dev/fix_about_titles.py -- one-shot ABOUT.md title fixer - tools/dev/fix_mermaid_diagrams.py -- one-shot ABOUT.md mermaid tweaker Both operated on the now-deleted ABOUT.md files and have no other use. Updated tinytorch/README.md so the documented repo tree no longer shows ABOUT.md under each module folder, and repointed a stale "setup guide" link from site/getting-started.md to quarto/getting-started.qmd.
Development Tools
This directory contains tools for TinyTorch maintainers and contributors.
Structure
dev/- Development environment setup and utilitiesbuild/- Build scripts for generating notebooks and metadatamaintenance/- Maintenance and cleanup scripts
For Students
Students don't need anything in this directory. Use the main setup scripts in the project root.
For Developers
See docs/development/DEVELOPER_SETUP.md for complete developer documentation.