mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-03-11 17:49:25 -05:00
9f2cce16d2
- Fix setup flow across all docs (activate.sh → source .venv/bin/activate, setup-environment.sh → tito setup) - Add missing commands to overview (tito setup, system update/reset, module list/view/test, milestone test/demo, nbgrader commands) - Add module list, view, and test sections to modules.md - Fix phantom AlexNet milestone → XOR Crisis in data.md - Fix Module 10 name (Normalization → Tokenization) in data.md - Fix milestones.md prereq check output (missing Module 08) - Fix troubleshooting.md paths, permission fix, and quick-reference table
Tiny\raisebox{-0.1em}{\includegraphics[height=1em]{../_static/logos/fire-emoji.png}}Torch Documentation Site
This directory contains the TinyTorch course website and documentation.
Building the Site
All builds are managed through the Makefile:
cd tinytorch/site
# Build HTML website
make html
# Build PDF (requires LuaLaTeX)
make pdf
# Clean build artifacts
make clean
# Install dependencies
make install
📚 User Documentation
STUDENT_QUICKSTART.md- Getting started guide for studentsinstructor-guide.md- Setup and grading guide for instructorsquickstart-guide.md- Quick start guide for all users
🔧 Development Documentation
Development Standards
development/module-rules.md- Module development standards and patternsdevelopment/DEVELOPER_SETUP.md- Developer environment setupdevelopment/MODULE_ABOUT_TEMPLATE.md- Template for module documentation
NBGrader Integration
nbgrader/NBGrader_Quick_Reference.md- Daily use commands and workflownbgrader/NBGrader_Text_Response_Technical_Implementation.md- Technical implementation details
Start here:
- Students: Read
STUDENT_QUICKSTART.md - Instructors: Read
instructor-guide.md - Developers: Read
development/module-rules.md