github-starred/cs249r_book

mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-03-09 07:15:51 -05:00

Files

History

kai 81373c5dd7 bug fix user manual account broken

2026-02-27 17:06:38 -05:00

..

fix(tinytorch): resolve navbar icon links from subdirectories

2025-12-20 18:34:53 -05:00

chore(tinytorch): bump version to tinytorch-v0.1.9

2026-02-18 00:02:21 +00:00

bug fix user manual account broken

2026-02-27 17:06:38 -05:00

instructor/tools

refactor(tinytorch): clean up orphaned docs and reset package for student use

2025-12-15 18:41:35 -05:00

chore(tinytorch): add VS Code extension and sync module updates

2026-02-15 14:02:09 -05:00

fix(site): update module symlinks for correct TOC references

2025-12-19 21:05:03 -05:00

feat(site): auto-generate team page from .all-contributorsrc

2026-02-05 20:25:02 -05:00

fix(docs): standardize Perceptron year to 1958

2026-01-17 12:15:49 -05:00

fix(docs): align notebook filenames with tito convention across all docs

2026-02-17 18:31:44 -05:00

_config_pdf.yml

feat(site): convert all 20 ABOUT.md files to MyST notebooks with computed values

2026-02-17 18:11:31 -05:00

_config.yml

feat(site): link Paper to arXiv instead of local PDF

2026-01-28 15:51:36 -05:00

_toc_pdf.yml

fix(site): PDF build improvements and community section

2026-02-17 13:53:18 -05:00

_toc.yml

feat(site): add Team page and reorganize Community section

2026-02-03 13:41:10 -05:00

404.md

feat: ecosystem consistency improvements

2025-12-30 22:23:09 -05:00

big-picture.md

feat(site): add embedded PDF slide viewer to all module pages

2026-02-03 12:06:52 -05:00

build_site.sh

updated the profile to have educator, industry, student

2026-01-19 18:11:53 -05:00

community.md

fix: resolve Jupyter Book build warnings and PDF diagram readability

2025-12-14 14:58:47 -05:00

conclusion.md

fix(docs): standardize Perceptron year to 1958

2026-01-17 12:15:49 -05:00

conf.py

fix: update all GitHub URLs from mlsysbook/TinyTorch to harvard-edge/cs249r_book

2025-12-14 12:36:10 -05:00

credits.md

feat(site): add Team page and reorganize Community section

2026-02-03 13:41:10 -05:00

datasets.md

docs(tinytorch): reorganize site navigation and add update documentation

2026-01-17 10:39:49 -05:00

getting-started.md

fix(site): update notebook filename in getting-started guide

2026-02-17 18:19:58 -05:00

intro.md

docs: add 'Building systems creates irreversible understanding' quote

2026-01-25 15:58:24 -05:00

Makefile

feat(site): convert all 20 ABOUT.md files to MyST notebooks with computed values

2026-02-17 18:11:31 -05:00

myst.yml

fix: update all GitHub URLs from mlsysbook/TinyTorch to harvard-edge/cs249r_book

2025-12-14 12:36:10 -05:00

pdf_intro.md

…

preface.md

fix: replace broken research paper link with arXiv PDF

2026-02-22 12:52:11 -05:00

prepare_notebooks.sh

style: apply consistent whitespace and formatting across codebase

2025-12-13 14:05:34 -05:00

README.md

style: apply consistent whitespace and formatting across codebase

2025-12-13 14:05:34 -05:00

references.bib

…

requirements.txt

feat(tinytorch): add Open Graph metadata for social sharing

2025-12-11 13:27:47 -08:00

resources.md

fix: complete module renumbering across entire codebase

2025-12-19 17:43:41 -05:00

team.md

feat(site): auto-generate team page from .all-contributorsrc

2026-02-05 20:25:02 -05:00

README.md

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 students
instructor-guide.md - Setup and grading guide for instructors
quickstart-guide.md - Quick start guide for all users

🔧 Development Documentation

Development Standards

development/module-rules.md - Module development standards and patterns
development/DEVELOPER_SETUP.md - Developer environment setup
development/MODULE_ABOUT_TEMPLATE.md - Template for module documentation

NBGrader Integration

nbgrader/NBGrader_Quick_Reference.md - Daily use commands and workflow
nbgrader/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