Commit Graph

25 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
eec214e335 fix: resolve Jupyter Book build warnings and PDF diagram readability
- Fix broken symlink for 09_convolutions_ABOUT.md
- Fix header level warnings (H1 to H3 jumps) in community.md and intro.md
- Remove broken cross-references to deleted files across site pages
- Fix lexing errors by using text blocks for Unicode characters
- Update mermaid diagram in big-picture.md to use light fill colors
  for PDF compatibility (mermaid-cli does not respect inline color styles)
2025-12-14 14:58:47 -05:00
Vijay Janapa Reddi
19aa640af1 feat: improve big-picture diagram with top-down layout and module numbers
- Change mermaid diagram from LR to TB (top-down) layout
- Add module numbers to node labels (01: Tensor, 02: Activations, etc.)
- Color nodes by tier: blue (foundation), purple (architecture), orange (optimization)
- Add zoom:1.5 for larger display on website
2025-12-14 14:27:58 -05:00
Vijay Janapa Reddi
d392c12dd3 fix: constrain mermaid diagram sizes for PDF output
- Update mermaid params to use PDF output with pdfcrop
- Add width and height constraints with keepaspectratio in LaTeX
- Redesign Module Flow diagram to LR layout with TB subgraphs
- Shorten labels to fit better on page
2025-12-14 14:06:30 -05:00
Vijay Janapa Reddi
ff810c02f1 fix: update test dependency chains to correct module numbering
- Update MODULE_DEPENDENCIES dict to match current 01-20 structure
- Fix dependency chain comments in test_progressive_integration.py files
- Update CHECKPOINTS in test_checkpoint_integration.py
- Update module_mappings in package_manager_integration.py
- Update module_order in module_complete_orchestrator.py

The old test files referenced incorrect module numbers (06_spatial instead
of 09_convolutions) from an outdated module structure.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2025-12-14 13:21:59 -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
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
9433612b65 fix: add TOC depth settings to PDF preamble for subsection numbering
Add \setcounter{secnumdepth}{3} and \setcounter{tocdepth}{3} to the
LaTeX preamble to ensure subsections (### headings) appear numbered
in the PDF table of contents (e.g., 6.8.1, 6.8.2).

The previous tocdepth setting in latex_elements was incorrectly parsed
by Sphinx, causing a LaTeX compilation error. Moving to preamble fixes
this and properly enables 3-level TOC depth.
2025-12-13 13:31:08 -05:00
Vijay Janapa Reddi
6c09c7021d fix: use TeX Gyre fonts for PDF build compatibility
Reverts to TeX Gyre fonts (Pagella, Heros, Cursor) which are available
in both TeX Live (CI) and can be installed locally on macOS. The macOS
system fonts (Palatino, Helvetica Neue, Menlo) were accidentally
reintroduced and broke CI builds.
2025-12-11 20:41:05 -08:00
Vijay Janapa Reddi
a6102cbd59 Updates PDF draft edition and cover page
Updates the date on the PDF draft edition and adjusts the image trim on the cover page.

Removes footnote on page with quote from Vijay, and removes year from his title page.
2025-12-11 16:32:50 -08:00
Vijay Janapa Reddi
fe2a3098ac Refines preface and introduction for clarity
Improves the introduction and preface of the documentation by
clarifying the goals and prerequisites. It emphasizes the
practical application of TinyTorch and includes a footnote.

Also, the tito.png image is now centered and slightly larger
with some trimming.
2025-12-11 16:15:57 -08:00
Vijay Janapa Reddi
3457d9e6d7 Refines PDF generation for improved layout
Adjusts spacing and image sizing within the PDF template to
enhance visual appeal and readability. Specifically, it resizes
the TinyTorch logo, modifies vertical spacing, and integrates
a welcome image more effectively. It also corrects a capitalization
in the header.
2025-12-11 15:58:37 -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
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
1b9de066b7 fix: update PDF guide fonts to TeX Gyre for TeX Live compatibility 2025-12-10 12:03:36 -08:00
Vijay Janapa Reddi
b665790869 feat: improve TinyTorch PDF workflow defaults and artifact fallback
- Set build_guide and build_paper to default: true (checked by default)
- Update Last updated date to December 10, 2025 (manual date string)
- Improve artifact fallback to search Live, Dev, and standalone PDF workflows
- Verify artifacts exist before attempting download
2025-12-10 08:14:47 -08:00
Vijay Janapa Reddi
fdf3b9a876 feat: add Last updated date to PDF title pages
- Course Guide: shows on title page with Draft Edition
- Research Paper: shows below author info on first page
2025-12-10 07:15:47 -08: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
980c6b2225 feat(tinytorch): add PDF downloads with 'From Tensors to Systems' subtitle
- Add download links for Guide and Paper PDFs to top navigation bar
- Create manual GitHub Actions workflow for PDF builds (tinytorch-build-pdfs.yml)
- Update title page with 'From Tensors to Systems' in companion box
- Add make targets: paper, downloads
- Include built PDFs in _static/downloads/ for website deployment
2025-12-07 14:21:37 -08:00
Vijay Janapa Reddi
cb595aeb9d feat(pdf): add neural network cover design and header branding
- Add asymmetric neural network decorations to cover page with diagonal flow
- Dense clusters on top-left and bottom-right, sparse on opposite corners
- Add tiny🔥TORCH branding centered above header rule
- Add flame icon to chapter titles (left-aligned)
- Replace LaTeX bigstar with bullet points for difficulty ratings
2025-12-07 14:07:06 -08:00
Vijay Janapa Reddi
15b0fee1a5 style(pdf): refine cover page typography and badge layout
- Badge spacing: 114pt from author block for breathing room
- Internal line spacing: 10pt (line 1-2), 6pt (line 2-3)
- Bottom padding: 14pt for softer feel
- Draft Edition gap: 5pt (lifted closer to badge)
- Badge text: 'The Build-It-Yourself Companion to the'
- Lowercase 'textbook' for academic consistency
2025-12-07 13:39:04 -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
deb2ced61d refactor(site): consolidate build scripts into Makefile
Simplified build system by removing redundant scripts:
- Removed build.sh (functionality moved to Makefile)
- Removed build_pdf.sh (consolidated into Makefile)
- Removed build_pdf_simple.sh (consolidated into Makefile)

Enhanced Makefile with better organization and PDF build support
Updated README with clearer build instructions
Improved _config_pdf.yml with better PDF generation settings
2025-12-07 06:07:46 -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