Commit Graph

39 Commits

Author SHA1 Message Date
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
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
2d9089d5f5 Updates funding message for clarity
Refines the wording of the funding message on the introduction page to emphasize that contributions support free ML education.
2025-12-21 09:37:54 -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
2ded5d0701 feat(tinytorch): add GitHub stars counter and mission messaging
Add live star count to hero and community sections with link to
Support This Work page. Stars help fund free ML education.
2025-12-16 20:17:27 -05:00
Vijay Janapa Reddi
3d5fcfb83c fix(tinytorch): set browser tab title to tagline on intro page
Add hidden h1 heading for Sphinx to use as page title, with CSS
to visually hide it while preserving the custom hero layout.
2025-12-16 08:01:43 -05:00
Vijay Janapa Reddi
f81c07e615 fix(tinytorch): update community section CTAs
- Add Community, GitHub Discussion, and Get Updates buttons
- Use action-oriented wording with emojis
- Improve button visibility with better contrast
2025-12-15 17:46:22 -05:00
Vijay Janapa Reddi
e8c9303c82 fix(tinytorch): update branding colors and sidebar tagline
- Change navbar brand text to warm cream (#fef3c7)
- Add "Build-It-Yourself Companion" tagline under sidebar logo
- Remove duplicate tagline from intro page main content
2025-12-15 17:32:27 -05:00
Vijay Janapa Reddi
4c4255b34b refactor(tinytorch): remove redundant title from feature box 2025-12-15 17:27:58 -05:00
Vijay Janapa Reddi
e4896fee5d fix(tinytorch): update favicon, hero styling, and milestone dates
- Replace favicon with flame icon using radial gradients
- Update community hero section to use transparent logo
- Apply modular scale typography (1.75rem subtitle, 180px logo)
- Fix og:title metadata in intro.md frontmatter
- Update milestone dates to historically accurate values
2025-12-15 17:16:24 -05:00
Vijay Janapa Reddi
0139ab559c fix(tinytorch): use correct og:title field list syntax for LinkedIn preview 2025-12-15 16:29:07 -05:00
Vijay Janapa Reddi
5a723c561f Adds ogp_title metadata for intro page
Adds ogp_title metadata to the intro page for better social sharing and SEO.
2025-12-15 14:02:10 -05:00
Vijay Janapa Reddi
f42680985f docs(tinytorch): update tagline to From Tensors to Systems 2025-12-15 13:01:34 -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
1069df0345 fix(tinytorch): finalize tagline 'Don't import torch. Build it.' 2025-12-14 19:05:35 -05:00
Vijay Janapa Reddi
81cb206e44 fix(tinytorch): change tagline to 'Don't import it. Build it.' 2025-12-14 18:58:45 -05:00
Vijay Janapa Reddi
db5ed63dd5 docs(tinytorch): update page title for better LinkedIn preview
Change intro page title to "Don't just import torch. Build it."
for cleaner social media sharing without redundant branding.
2025-12-14 18:38:24 -05:00
Vijay Janapa Reddi
c76c66eb2b feat(tinytorch): redesign landing page for better UX
- Streamline hero with single CTA ("Start Building")
- Add dark "AI Bricks" approach box for visual hierarchy
- Reorder sections: Hero → Approach → Timeline → Code Comparison
- Update personas: Students, Instructors, Self-learners
- Remove redundant title, use subtle preview badge
- Improve code comparison with Build → Use → Reflect pattern
2025-12-14 16:24:28 -05:00
Vijay Janapa Reddi
a7b83a3d84 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
2025-12-14 15:10:14 -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
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
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
6d7eea5c12 fix: simplify footer using built-in Jupyter Book fields
- Add author and copyright fields to _config.yml
- Remove custom extra_footer HTML block
- Simplify CSS footer styling
- Remove redundant inline footer from intro.md
2025-12-12 10:19:22 -08:00
Vijay Janapa Reddi
d932d30cf3 fix: clean up broken links in site documentation
- intro.md: Replace tinytorch.ai/join with GitHub Discussions link
- intro.md: Replace leaderboard with community link
- 00-introduction.md: Fix 01-setup.html to ../tiers/foundation.html
2025-12-12 09:49:41 -08:00
Vijay Janapa Reddi
111149085b docs: update AI Bricks box - history range and end goal 2025-12-12 09:20:33 -08: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
8eeca654c4 fix: correct XOR crisis description in timeline
Updated the 1969 milestone description to accurately reflect
that this demonstrates the crisis (the mathematical impossibility),
not the solution. The solution comes in the 1986 MLP milestone.
2025-12-11 18:56:31 -08:00
Vijay Janapa Reddi
e88b697c2a Updates site styling and footer to match MLSysBook
Improves the website's appearance by aligning its styling and footer with the MLSysBook design.

This includes modifications to the navbar height, addition of a custom footer with relevant links and copyright information, and updates to the subscription link handling for better user experience.
2025-12-11 09:28:11 -08:00
Vijay Janapa Reddi
b1fea14980 feat: add curl-based install system with tito update command
- Add install.sh script using git sparse checkout for minimal downloads
- Add tito update command to check for and install updates
- Add install command box to homepage with copy button
- Unify ASCII logo between install script and tito CLI
- Add flame emoji to tagline and tighten letter spacing
- Remove unused fix-venv and rebuild-site scripts
2025-12-10 10:57:27 -08:00
Vijay Janapa Reddi
d96cf78919 Updates MLPerf timeline to present
Reflects the ongoing nature of the MLPerf benchmarks,
extending the timeline to the present.
2025-12-10 06:23:19 -08:00
Vijay Janapa Reddi
b982424f33 style(tinytorch): update terminal demo to match fire theme
Apply TinyTorch brand colors to the animated terminal demo:
- Orange border (#f97316) matching top navbar
- Fire gradient on active step buttons (red → orange)
- Yellow/amber success messages (#fbbf24)
- Orange prompt color (#f97316)
- Dark gradient background matching site header
- Window dots using brand fire colors
2025-12-08 14:32:39 -08:00
Vijay Janapa Reddi
d2e9ec839c feat(tinytorch): add animated terminal demo carousel to intro page
Replace static GIF placeholders with an auto-rotating terminal animation
showing the TinyTorch journey: Setup, Build, Milestone, Compete. Features
macOS-style window chrome, line-by-line fade animation, and clickable
step buttons. Each scene shows realistic tito CLI commands with "Demos
coming soon..." message.
2025-12-08 12:29:46 -08:00
Vijay Janapa Reddi
c6a614f021 feat(tinytorch): add fancy demo carousel with macOS-style window
Replace broken GIF references with polished carousel placeholder:
- macOS window chrome with red/yellow/green dots
- 4-step journey: Setup → Build → Milestone → Compete
- Glassmorphic navigation arrows with blur effect
- Progress bar with numbered steps and active state glow
- Smooth cubic-bezier slide transitions
- Ready for GIF drop-in when demos are regenerated
2025-12-08 11:04:51 -08:00
Vijay Janapa Reddi
733aacda8a docs(tinytorch): update site content and styling
- Updated PDF guide
- Improved documentation formatting
- Added custom CSS enhancements
- Updated TOC and various guide pages
2025-12-08 10:33: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