Commit Graph

29 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
9e73f389a5 docs: fix milestone requirements to match implementation
Updates milestone documentation across all site files to match the
actual MILESTONE_SCRIPTS configuration in tito/commands/milestone.py:

- Milestone 01 (Perceptron): requires modules 01-03 (not 01-04)
- Milestone 02 (XOR Crisis): requires modules 01-03 (not 01-02)
- Milestone 05 (Transformers): requires 01-08 + 11-13 (not 01-13)
- Milestone 06 (MLPerf): requires 01-08 + 14-19 (not 01-19)

Also fixes broken link to chapters/milestones.html (directory does not
exist) and corrects path to student notebooks.
2026-01-25 15:33:59 -05:00
Vijay Janapa Reddi
871d1f473a docs: complete Perceptron 1958 standardization and add tito dev CLI docs
- Update remaining 1957→1958 references across all documentation
- Add tito dev commands (preflight, export, validate) to CLI reference
- Update CLI validation script to recognize new dev subcommands
- Fix milestone year references in tests and workflow code
- Update timeline visualization JavaScript

This completes the Perceptron year standardization to align with
the publication year and academic citation format (rosenblatt1958perceptron).

Cherry-picked from: ebf3fb17b (feature/tito-dev-validate)
2026-01-17 12:18:23 -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
6c108c6323 refactor(cli): reorganize commands and add welcome message
- Move tito update → tito system update
- Move tito logo → tito system logo
- Remove tito grade (use tito nbgrader instead)
- Add first-run welcome message for new users
- Update demo scripts and docs for new command paths
2026-01-14 16:51:06 -05:00
Vijay Janapa Reddi
4d776ee8ee fix(tinytorch): support Python 3.8+ instead of 3.10+
- Use typing.Optional and typing.Tuple for 3.8 compatibility
- Update installer to check for 3.8+ instead of 3.10+
- Update docs to reflect 3.8+ requirement
- Matches pyproject.toml classifiers
2026-01-13 14:46:48 -05:00
Vijay Janapa Reddi
e5fc460975 docs(tinytorch): fix Python version and add version badge
- Fix Python badge: 3.8+ → 3.10+ (matches installer requirement)
- Add version badge (v0.1.1) to README
- Add tito --version and tito update to getting-started docs
2026-01-13 14:44:46 -05:00
Vijay Janapa Reddi
a9d90c5d94 docs: fix cross-reference warnings for PDF build
Remove references to pages not included in PDF (community.md,
tiers/foundation, tito/milestones) to eliminate build warnings.
2025-12-21 18:24:20 -05:00
Vijay Janapa Reddi
0d076aee26 fix: update tier boundaries across all documentation
Comprehensive update to reflect correct module assignments:
- Foundation Tier: 01-08 (was incorrectly 01-07 in many places)
- Architecture Tier: 09-13 (was incorrectly 08-13 in many places)

Updated files:
- Site pages: intro.md, big-picture.md, getting-started.md
- Tier docs: olympics.md, optimization.md
- TITO docs: milestones.md
- Source ABOUT.md: 09, 10, 11, 12, 13, 14, 16
- Paper diagrams: module_flow.dot, module_flow_horizontal.tex
- Milestones: README.md, 02_1969_xor/ABOUT.md
- Tests: integration/README.md
- CLI: tito/commands/module/test.py
2025-12-19 20:12:24 -05:00
Vijay Janapa Reddi
7f2b504041 fix(tinytorch): update install URL to mlsysbook.ai/tinytorch/install.sh 2025-12-16 08:35:03 -05:00
Vijay Janapa Reddi
c7cf3f04e8 refactor(tinytorch): consolidate install script to single location
- Move install script to site/extra/install (served at /install URL)
- Remove duplicate scripts from scripts/ and _static/install/
- Add comprehensive documentation header to install script
- Document what files are kept vs removed for students
- Update getting-started.md to reflect idempotent tito setup

Students get: src/, tinytorch/, tito/, milestones/, tests/, datasets/,
bin/, modules/, requirements.txt, pyproject.toml, settings.ini

Removed: paper/, instructor/, site/, scripts/, tools/, binder/, etc/,
assignments/, benchmark_results/, IDE configs, dev scripts

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-15 13:36:30 -05:00
Vijay Janapa Reddi
778d3ba730 docs(tinytorch): remove horizontal rule separators from getting-started 2025-12-14 19:51:30 -05:00
Vijay Janapa Reddi
f0f58ec48a docs(tinytorch): add text language hint to code block 2025-12-14 19:49:28 -05:00
Vijay Janapa Reddi
bc88e43bfe docs(tinytorch): use ASCII-friendly milestone output for PDF compatibility 2025-12-14 19:41:39 -05:00
Vijay Janapa Reddi
5b70251353 docs(tinytorch): add MLPerf teaser to getting-started 2025-12-14 19:38:45 -05:00
Vijay Janapa Reddi
c7a7549c4f docs(tinytorch): update getting-started with real milestone output
- Restructure getting-started.md with clearer user flow
- Add actual tito milestone run perceptron output
- Update intro.md hero text to match og:description
- Simplify page structure: Install -> Module -> Milestone cycle
2025-12-14 19:36:30 -05:00
Vijay Janapa Reddi
7432aae15c docs: improve figure captions with bold titles and descriptions
Updated all mermaid diagram captions across the site to follow a consistent format:
- Bold title followed by a period
- Descriptive explanation of the diagram
- Ends with a period

Files updated:
- big-picture.md: TinyTorch Module Flow
- getting-started.md: TinyTorch Build Cycle
- milestones.md: Pedagogical Acts, Journey Through ML History
- intro.md: Build-Use-Reflect Learning Cycle
- learning-journey.md: Six-Act Learning Narrative
- optimization.md: Optimization Module Flow, Production Timeline
- foundation.md: Module Dependencies, Tier Milestones
- architecture.md: Module Flow, Tier Milestones
- modules.md: Module Development Workflow
- data.md: Progress Tracking Flow

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2025-12-14 15:05:13 -05:00
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
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
ea8569c04f docs: update milestone commands to use tito CLI
Replace manual cd/python commands with tito milestone run:
- milestones.md: use tito milestone run <name>
- getting-started.md: simplify milestone instructions
- student-workflow.md: simplify milestone instructions
- quick-reference.md: update milestone examples
- ml-timeline.js: update interactive timeline commands
2025-12-14 11:04:13 -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
69a3e19f2f style: rebrand "Your TinyTorch" to "Your Tiny🔥Torch" across codebase
Consistent branding with flame emoji in all module ABOUTs,
milestone files, site documentation, and Python scripts.
2025-12-13 15:23:28 -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
d21dd1dca0 fix: correct invalid tito CLI commands in documentation
- Fix 56+ invalid CLI references across markdown files
- Replace nonexistent commands with valid alternatives:
  - tito checkpoint → tito module status
  - tito milestones → tito milestone
  - tito system check/doctor → tito system health
  - tito community leave → tito community logout
  - tito reset all → tito module reset XX
  - tito status → tito module status / tito milestone status
- Add pre-commit hook to prevent future CLI documentation drift
- Organize pre-commit config for monorepo (book + tinytorch sections)
2025-12-12 15:56:26 -05:00
Vijay Janapa Reddi
ac4bb708ea Refactors project for preview release
Updates the project's documentation and status to reflect its preview release state.

Focuses on gathering community feedback and shaping the direction of the project.
Replaces the old CI badge with a status badge.
Links to a discussion forum for feedback.
2025-12-11 21:49:05 -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
daa3e25308 feat(installer): add safe one-line installer with tito update support
- Add install.sh with safety checks (location, prerequisites, confirmation)
- Block dangerous locations (/, /tmp, system dirs), warn on Downloads/home
- Show progress during download and installation steps
- Update tito update command to work without git (re-downloads, preserves modules/)
- Update README and getting-started docs with new curl install method
- Add install.sh to site static files for tinytorch.ai/install redirect

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-11 11:10:07 -08:00
Vijay Janapa Reddi
00f1e8588a fix(docs): replace LaTeX textcolor commands in site documentation
- Convert remaining LaTeX markup to Unicode symbols
- \textcolor{green!60!black}{$\sim$} → ~
- \textcolor{torchnavy}{$\nearrow$} → ↗
- \textcolor{torchnavy}{$\triangleright$} → ▶
2025-12-07 13:39:54 -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