Commit Graph

17 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
2b27429892 fix(site): PDF build improvements and community section
- Add npx pre-flight check for Mermaid CLI in PDF build
- Configure mermaid_cmd to use npx (no global install needed)
- Add Unicode box-drawing fallbacks for LaTeX
- Add Community section to PDF table of contents
2026-02-17 13:53:18 -05:00
Vijay Janapa Reddi
8a39107461 docs(toc): add Developer Testing to TITO CLI Reference section
Add testing.md to both web and PDF table of contents.
2026-01-23 13:17:57 -05:00
Vijay Janapa Reddi
dbad2637e3 fix(docs): standardize Perceptron year to 1958
- Rename milestone directory from 01_1957_perceptron to 01_1958_perceptron
- Update all references to use 1958 (publication year) for consistency
  with academic citation format (rosenblatt1958perceptron)
- Changes affect: READMEs, docs, tests, milestone tracker

Rationale: Using 1958 aligns with the publication year and standard
academic citations, while 1957 was the development year.

Cherry-picked from: 28ca41582 (feature/tito-dev-validate)
2026-01-17 12:15:49 -05:00
Vijay Janapa Reddi
8a259e4a42 docs(tinytorch): reorganize site navigation and add update documentation
- Reorganize TOC: move datasets from TITO CLI to new Reference section
- Add complete TITO CLI Reference section to PDF build (was missing)
- Add System Updates section to troubleshooting guide with code safety info
- Fix datasets.md styling for consistency (add border-radius to all boxes)
- Improve logical flow: TITO CLI → Reference → Community

Changes:
- HTML TOC: Create Reference section, move datasets + resources
- PDF TOC: Add full TITO CLI section (overview, modules, milestones, data, troubleshooting)
- troubleshooting.md: Add 4 new sections on updating TinyTorch safely
- datasets.md: Standardize styling with rounded corners

Result: Clean separation between workflow docs (TITO CLI) and reference materials
2026-01-17 10:39:49 -05:00
Vijay Janapa Reddi
f67dd99501 docs: add conclusion chapter for TinyTorch PDF guide
- Create conclusion.md summarizing the TinyTorch journey
- Add to PDF table of contents before Appendix
- Close the "Don't import torch. Build it." theme
- Cover accomplishments, mindset shift, paths forward
2025-12-21 18:13:02 -05:00
Vijay Janapa Reddi
aed246959c docs: update site with optimization tier flow explanation 2025-12-19 19:30:39 -05:00
Vijay Janapa Reddi
c8161a7408 docs(tinytorch): update TOC and tier documentation for module reordering
- Update _toc.yml: Foundation (01-08), Architecture (09-13)
- Update _toc_pdf.yml: same tier ranges
- Update foundation.md: add DataLoader as module 05, renumber autograd/optimizers/training
- Update architecture.md: remove DataLoader, start with Convolutions at 09
- Update all Mermaid diagrams and tier references
2025-12-18 13:10:30 -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
63802849f0 docs: streamline PDF table of contents for lab guide
- Rename to 'TinyTorch Lab Guide'
- Remove tier overview pages (redundant in PDF)
- Simplify section captions
- Remove FAQ from appendix
2025-12-14 11:04:24 -05:00
Vijay Janapa Reddi
9f9b20600c fix: rename Welcome to Preface in PDF TOC for consistency
Matches the naming change made in website _toc.yml to ensure
consistent terminology across all formats.

Generated with Claude Code https://claude.com/claude-code

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-13 17:02:22 -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
8705ec1308 docs: add ABOUT.md reference files for all 6 historical milestones
- Create milestones/ABOUT.md overview introducing milestone system
- Add individual ABOUT.md files for each milestone (01-06)
- Create site/milestones/ directory with symlinks for PDF inclusion
- Update PDF TOC with new Historical Milestones section
- Rename chapters/milestones entry to "ML History Timeline" to avoid confusion

Milestone ABOUTs provide:
- Quick reference format matching module ABOUTs
- Prerequisites and expected results
- Systems insights and historical context
- Running instructions
2025-12-13 15:23:02 -05:00
Vijay Janapa Reddi
ff37f3ec49 feat(pdf): enhance preface, add Unicode support, update downloads
- Add Welcome section and "What You Will Build" list to preface
- Add TinyTorch link (mlsysbook.ai/tinytorch) in preface
- Add Unicode character support for arrows, math symbols, Greek letters
- Remove number prefixes from module chapter headings (01. → just title)
- Update PDF TOC to use pdf_intro.md as root with Getting Started as part
- Update TinyTorch-Guide.pdf and TinyTorch-Paper.pdf in downloads
- Remove duplicate tinytorch-course.pdf from downloads
2025-12-07 19:16:34 -08:00
Vijay Janapa Reddi
28e3512bd1 fix(pdf): clean up header/footer styling and preface formatting
- Move page numbers to centered footer (not header)
- Remove chapter titles from header, keep only centered tiny🔥torch branding
- Override Sphinx 'normal' and 'plain' page styles for consistency
- Make page numbers non-bold
- Use preface as root document for proper front matter formatting
- Add unnumbered chapter format for front matter sections
2025-12-07 18:01:16 -08:00
Vijay Janapa Reddi
6ed685534d refactor(site): enhance PDF build with XeLaTeX and TinyTorch branding
- Switch from LuaLaTeX to XeLaTeX for better font handling and Unicode support
- Add comprehensive TinyTorch brand colors matching the logo
- Implement syntax-highlighted code blocks with flame accent
- Enhance title page with professional logo placement
- Add clean headers/footers with branded styling
- Reorganize TOC structure with semantic parts and captions
- Improve chapter titles for better pedagogical clarity
- Update build process to use latexmk for robust compilation
2025-12-07 10:09:03 -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