Commit Graph

21 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
9ab80d7cc0 fix: replace broken research paper link with arXiv PDF
The GitHub link (github.com/harvard-edge/TinyTorch/blob/main/paper/paper.pdf)
returns 404. Use arxiv.org/pdf/2601.19107 instead.

Fixes harvard-edge/cs249r_book#1198
2026-02-22 12:52:11 -05:00
Vijay Janapa Reddi
4187b0f3d0 docs: add 'Building systems creates irreversible understanding' quote
Adds the core TinyTorch philosophy statement to:
- intro.md: Under 'Why Build Instead of Use?' section
- preface.md: After the 'How to Learn' section guidelines
2026-01-25 15:58:24 -05:00
Vijay Janapa Reddi
e5dab6d12c docs(tinytorch): add xv6 reference to pedagogical precedents
Add MIT's xv6 teaching OS to the Related Work section alongside
Nachos and Pintos. The x86 to RISC-V transition exemplifies the
strip to essentials philosophy that TinyTorch follows.

Also link to the research paper from the preface for readers
interested in the pedagogical foundations.
2025-12-21 09:11:36 -05:00
Vijay Janapa Reddi
dca8359156 style: add warm cream/amber brand text color and emoji tagline
- Brand text uses #fef3c7 (warm cream) with #fbbf24 amber hover
- Preface tagline uses emojis for HTML, plain text for PDF
2025-12-17 20:39:32 -05:00
Vijay Janapa Reddi
24070e2c7c fix: sync PDF build between Makefile and CI workflow
- Add missing --toc _toc_pdf.yml flag to CI workflow
- Simplify Makefile pdf target to match CI workflow structure
- Remove redundant subsection heading in preface
- Remove bold formatting from GPT model in table
2025-12-14 15:50:14 -05:00
Vijay Janapa Reddi
0c3c75678e refactor: rename Module 09 from Spatial to Convolutions
- Rename directories: src/09_spatial → src/09_convolutions,
  tests/09_spatial → tests/09_convolutions
- Rename files: 09_spatial.py → 09_convolutions.py,
  test_spatial_*.py → test_convolutions_*.py
- Update TOC files, TITO CLI mappings, and documentation
- Update navigation links between modules
- Remove misplaced duplicate test file from tests/06_optimizers/
- Use "CNNs" in diagrams, "Convolutions" in prose for consistency

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2025-12-14 13:13:18 -05:00
Vijay Janapa Reddi
fcf3d8bd12 fix: update all GitHub URLs from mlsysbook/TinyTorch to harvard-edge/cs249r_book
- Update all repository references to point to harvard-edge/cs249r_book
- Fix Binder URLs to include tinytorch/ path prefix
- Fix Colab URLs to include tinytorch/ path prefix
- Update marimo-badges.js with correct repo and path
- Fix dataset documentation URLs
- Update module ABOUT.md files with correct source links

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2025-12-14 12:36:10 -05:00
Vijay Janapa Reddi
c2598e827d docs: improve orientation files based on expert review
Critical fixes:
- Add getting-started.md to PDF TOC (students need setup instructions)
- Move Course Orientation to position #2 in website TOC (better discoverability)
- Add prerequisites warning note at top of getting-started.md

High priority improvements:
- Add "What if validation fails?" troubleshooting section
- Add per-module time estimates table (60-80 hours total)
- Clarify autograd prerequisites (chain rule conceptual knowledge needed)
- Standardize Quick Start terminology (fix links to getting-started.md)
- Add persona-based routing in "What to Read Next" sections

Content cleanup:
- Remove redundant prerequisites from preface.md
- Remove tier overview duplication from preface.md
- Remove MLSysBook from prerequisites.md (already in preface)
- Convert prerequisites.md from 65% bullets to 90% prose
- Simplify learning-journey.md intro (remove awkward meta-section)
- Fix checkpoints -> modules terminology in learning-journey.md
- Restore instructor "coming soon" section in getting-started.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-13 16:48:59 -05:00
Vijay Janapa Reddi
4701309c1d style: standardize emoji placement to "Tiny🔥Torch" consistently
Fix remaining instances where emoji was before the name
(🔥 TinyTorch → Tiny🔥Torch) for consistent branding.

Also add "curren" to codespell ignore list (contributor name).
2025-12-13 15:24:33 -05:00
Vijay Janapa Reddi
2e476722ae fix: improve PDF admonition colors and convert to native Sphinx directives
- Add sphinxsetup configuration with distinct colors for each admonition type
  (tip=green, warning=orange, note=blue, caution=red, etc.)
- Convert {admonition} with :class: attribute to native {tip}, {warning},
  {seealso} directives for proper Sphinx type detection in LaTeX output
- Remove unsupported emojis from site markdown files for LaTeX compatibility
- Update codespell ignore list for font names (Heros) and PDF options (FitH)
- Update 20 ABOUT.md files and 16 site/*.md files
2025-12-13 14:58:59 -05:00
Vijay Janapa Reddi
5e26319fbc style: remove extra blank lines from markdown files
Clean up documentation by collapsing multiple consecutive blank lines
into single blank lines for consistency.
2025-12-13 13:32:53 -05:00
Vijay Janapa Reddi
77a40ffea8 feat: add ABOUT.md generation system with agent instructions
- Create about-generator.md agent with YAML frontmatter
- Create about-guidelines.md with 13-section template
- Update Module 01 ABOUT.md as canonical reference
- Add embedded code snippets from .py files
- Add Q5 (views vs copies) and BLAS paper reference
- Use 'Your Tiny🔥Torch' branding in tab-sets
- Remove chapter-level TOC (master TOC handles navigation)
- Configure PDF TOC depth to 3 in _config.yml
2025-12-13 11:14:48 -05:00
Vijay Janapa Reddi
d116f557e4 Updates alt text for the TinyTorch image
Updates the alt text for the Tito image on the welcome page to be more concise and descriptive.

The previous alt text was "Tito the TinyTorch mascot".
The new alt text is simply "TinyTorch".
2025-12-11 15:58:42 -08:00
Vijay Janapa Reddi
401d7faa18 Adds Tito mascot to the welcome page
Enhances the welcome page with the Tito mascot to improve visual appeal and branding.

Removes outdated author and copyright information from the configuration file.

Simplifies the prerequisites section in the preface, focusing on explaining concepts rather than requiring prior knowledge.
2025-12-11 15:10:58 -08:00
Vijay Janapa Reddi
7835e7583a Adds a preface to the TinyTorch documentation
Introduces the TinyTorch project, its purpose, and target audience.

Explains the problem TinyTorch aims to solve: the lack of deep understanding of ML frameworks among users.

Presents TinyTorch as a solution: teaching the AI bricks necessary to build any AI system.

Outlines what users will build, how to use the guide, and learning approach.
2025-12-11 14:39:26 -08:00
Vijay Janapa Reddi
c43492889a fix(tinytorch): cleanup website preface and fix markdown formatting
- Simplify preface to clean academic style (remove flashy HTML/CSS)
- Add astronaut and rocket emojis to opening line
- Fix malformed bold markdown (**See vs ** See)
- Update PDF fonts to use macOS system fonts (Palatino, Helvetica Neue, Menlo)
2025-12-11 14:00:03 -08:00
Vijay Janapa Reddi
ab62ecc4a1 Refine TinyTorch preface based on reviewer feedback
- Clarify why we need builders (people who can debug/optimize/adapt)
- Introduce "AI bricks" concept as stable engineering foundations
- Fix phrasing: "how memory is managed for tensors" (not tensors managing memory)
- Change "doing ML" to "using ML" for clarity
- Replace "notebook operator" with clearer explanation
- Replace "human scale" with "a scale you can fully understand"
- Update footnote about JIT compilation background
2025-12-11 09:42:00 -08:00
Vijay Janapa Reddi
e27f8c61d3 docs: add motivation for learning framework internals in preface
Addresses student feedback that the preface states the problem (most
people do not understand how ML frameworks work) but does not explain
why this matters. Added concrete examples: debugging memory issues,
understanding gradient explosions, finding performance bottlenecks,
and deploying to constrained devices all require systems knowledge.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-10 15:37:55 -08:00
Vijay Janapa Reddi
aee8614645 refactor: rename Preface to Welcome in TOC and page heading 2025-12-09 21:34:18 -08:00
Vijay Janapa Reddi
38e928b60c docs(tinytorch): rewrite preface with builder-focused philosophy
Replace generic ML course preface with compelling narrative about
the gap between users and builders (astronaut vs rocket scientist).
Restructure to emphasize:
- Why TinyTorch exists (the problem/solution)
- Who this is for (students, ML engineers, systems programmers)
- What you will build (concrete deliverables)
- How to use this guide (Build-Use-Reflect cycle)
- Three-tier structure with Module 20 as capstone

Add personal footnote about Pin instrumentation engine to establish
credibility and reinforce the 'building deepens understanding' theme.
2025-12-07 17:13:00 -08:00
Vijay Janapa Reddi
c602f97364 feat: integrate TinyTorch into MLSysBook repository
TinyTorch educational deep learning framework now lives at tinytorch/

Structure:
- tinytorch/src/         - Source modules (single source of truth)
- tinytorch/tito/        - CLI tool
- tinytorch/tests/       - Test suite
- tinytorch/site/        - Jupyter Book website
- tinytorch/milestones/  - Historical ML implementations
- tinytorch/datasets/    - Educational datasets (tinydigits, tinytalks)
- tinytorch/assignments/ - NBGrader assignments
- tinytorch/instructor/  - Teaching materials

Workflows (with tinytorch- prefix):
- tinytorch-ci.yml           - CI/CD pipeline
- tinytorch-publish-dev.yml  - Dev site deployment
- tinytorch-publish-live.yml - Live site deployment
- tinytorch-build-pdf.yml    - PDF generation
- tinytorch-release-check.yml - Release validation

Repository Variables added:
- TINYTORCH_ROOT  = tinytorch
- TINYTORCH_SRC   = tinytorch/src
- TINYTORCH_SITE  = tinytorch/site
- TINYTORCH_TESTS = tinytorch/tests

All workflows use \${{ vars.TINYTORCH_* }} for path configuration.

Note: tinytorch/site/_static/favicon.svg kept as SVG (valid for favicons)
2025-12-05 19:23:18 -08:00