51 Commits

Author SHA1 Message Date
Rocky
a9609d6475 fix Dropout to use the module-level seeded rng instead of global np.random (#1869)
The module declares rng = np.random.default_rng(7) at the top so that all
stochastic operations are reproducible for a given seed. Dropout ignored this
and called np.random.random(shape), which draws from the global unseeded state.
Masks were different on every run even when the module seed was set, making
Dropout unit tests non-reproducible and causing hard-to-debug numerical
differences between training runs.

Changed to rng.random(shape) so Dropout participates in the same reproducible
stream as every other random operation in the module.
2026-06-16 18:58:38 -04:00
Vijay Janapa Reddi
99249d00b3 fix(tinytorch): restore seeded Linear init, scope unseeding to perceptron demo
#1617 unseeded the module-level rng in tinytorch/src/03_layers/03_layers.py
to make the perceptron milestone produce different weights on every run.
But Linear.__init__ reads weight init from that rng, so the change made
Linear init nondeterministic across the entire codebase. The integration
test tests/integration/test_training_flow.py::test_deep_network_gradient_chain
specifically depends on Linear having stable init; empirical sweep over
5000 random draws shows the test fails 27.5% of the time under unseeded
init, which is why the Windows CI run failed in #1617.

Restore the seed=7 default in 03_layers.py and instead rebind layers.rng
to an unseeded RNG locally inside the perceptron milestone, mirroring
the pattern already used by the XOR milestone (#1618). This keeps the
perceptron's "different weights every run" promise without breaking
unrelated tests.
2026-05-01 13:18:43 -04:00
Vijay Janapa Reddi
6220345038 fix(tinytorch): perceptron weights deterministic across runs (#1611)
The module-level `rng = np.random.default_rng(7)` at the top of
`src/03_layers/03_layers.py` was reused for every `Linear(...)` weight
init, so every run produced identical weights. Milestone 1's UI text
("No random seed - each run will be different!") contradicted this, and
the issue reporter rightly expected weights to vary.

Drop the seed in two places:

- `src/03_layers/03_layers.py`: the module-level `rng` is now unseeded.
  Local seeded RNGs inside test/demo blocks (around lines 829, 848, 981)
  are unchanged - those want determinism for reproducible self-tests.
- `milestones/01_1958_perceptron/01_rosenblatt_forward.py`: the data-gen
  RNG is also unseeded so the cluster points vary too, matching the
  on-screen claim.

Verified by running the milestone twice: cluster positions, predictions,
and accuracy now differ between runs (e.g., 100% "got lucky" vs 0%
"random guessing"). `Linear(...)` weights also differ across fresh
constructions within a single run.

Relates to #1611
2026-04-30 18:35:50 -04:00
Vijay Janapa Reddi
78dd6c1a92 chore(tinytorch): delete 20 stale src/*/ABOUT.md duplicates
Audit (parent commit): every tinytorch/src/NN_xxx/ABOUT.md is a stale
duplicate of tinytorch/quarto/modules/NN_xxx.qmd, with the QMD strictly
newer/richer (each QMD has additional sections like Your TinyTorch,
PyTorch comparison, MLPerf section that ABOUT.md is missing).

Drift confirms ABOUT.md is unmaintained: e.g., 12_attention/ABOUT.md
still says "GPT-3 training (4x inference)" while the QMD was corrected
to 5x. Single-source-of-truth in quarto/modules/ stops the recurrence.

The retired Jupyter Book site (tinytorch/site-legacy/) was the only
historical consumer; it is deleted in the next commit.

Also deleted:
  - tools/dev/fix_about_titles.py     -- one-shot ABOUT.md title fixer
  - tools/dev/fix_mermaid_diagrams.py -- one-shot ABOUT.md mermaid tweaker
Both operated on the now-deleted ABOUT.md files and have no other use.

Updated tinytorch/README.md so the documented repo tree no longer
shows ABOUT.md under each module folder, and repointed a stale
"setup guide" link from site/getting-started.md to quarto/getting-started.qmd.
2026-04-22 15:53:35 -04:00
Vijay Janapa Reddi
d30257577c refactor(tinytorch): migrate from legacy np.random to default_rng(7)
Replace np.random.randn/rand/seed with np.random.default_rng(7) across
all 93 source modules, tests, and milestones for reproducible, isolated
random state.
2026-04-03 17:57:51 -04:00
Vijay Janapa Reddi
743c8df9bd fix(tinytorch): batch 6 medium/low documentation and accuracy fixes
M01: Remove duplicate matmul rows, fix transpose timing O(1),
     "stride reinterpretation" header, deduplicate "statistics"
M02: Fix "sppress" typo, remove false "clipping" claim,
     GELU docstring values to sigmoid approximation
M03: Memory KB values to binary (784/785 KB), FLOPs -> MACs label
M04: Fix analyze_loss_sensitivity hardcoded index (was showing
     prediction=0.98 labeled as 0.5)
M05: Remove nonexistent download_mnist/download_cifar10 imports
M07: SGD momentum formula raw form (not EMA), AdamW prose
     formula to match code (lr * weight_decay)
M08: Memory estimate header 5-6x -> 4-6x with explanation
M13: Remove weight tying hint (not implemented)
M16: Replace "Sequential FORBIDDEN" section with accurate note,
     add T-squared simplification comment to distillation loss
M17: NumPy fusion comment corrected (does not fuse expressions)
2026-03-24 08:49:47 -04:00
Vijay Janapa Reddi
be245aef22 fix(tinytorch): batch 3 critical fixes from module audit
M03 Layers:
- Sequential.forward/.__call__ now accept training= parameter and
  pass it through to Dropout layers (eval mode was broken)

M12 Attention:
- Fix memory multiplier: was 7x (double-counted), now 4x incremental
  (1x forward + 1x grad + 2x optimizer). Aligned ABOUT.md to match.
- Fix mask docstring: True/False -> 1/0 to match implementation

M14 Profiling:
- Add __enter__/__exit__ to Profiler (6 progressive tests used
  context manager but class had no protocol support)
- Fix FLOP prose formula: remove batch_size to match implementation

M15 Quantization:
- Fix "symmetric" -> "asymmetric (min-max)" terminology throughout
- Fix Magic Formula prose to match code: q = x/s + zp (not (x-zp)/s)
- Add parentheses to zero-point hint formula for clarity
2026-03-24 08:49:46 -04:00
Vijay Janapa Reddi
ff3069fbeb Revert "feat: add type hints to modules 03, 04, and 05 (#1167)" 2026-03-20 17:38:40 -04:00
Uday Rathore
4888caef76 feat: add type hints to 03_layers and 04_losses (#1167) 2026-02-21 15:42:39 +05:30
Vijay Janapa Reddi
850a91adc6 fix(docs): align notebook filenames with tito convention across all docs
Notebooks use short names (tensor.ipynb, not 01_tensor.ipynb) but docs
and Binder postBuild scripts used the prefixed form. This caused broken
Binder links and incorrect paths in troubleshooting guides.

Fixes: harvard-edge/cs249r_book#1176
2026-02-17 18:31:44 -05:00
Vijay Janapa Reddi
e7f9223680 feat(site): convert all 20 ABOUT.md files to MyST notebooks with computed values
Replace hardcoded numerical values across all module ABOUT.md files with
Python-computed values using myst_nb glue() references. Each file is now a
MyST Markdown Notebook that executes inline code cells to compute memory
sizes, FLOPs, compression ratios, and other quantitative values.

Key changes:
- Add file_format: mystnb frontmatter and code-cell blocks to all 20 files
- All arithmetic (memory calculations, speedups, ratios) now computed inline
- Fix multiple arithmetic errors discovered during conversion
- Enable execute_notebooks: "cache" in PDF config for glue resolution
- Fix jupyter-book version constraint in Makefile
2026-02-17 18:11:31 -05:00
Vijay Janapa Reddi
910240a3f6 chore(tinytorch): add VS Code extension and sync module updates
Add the TinyTorch VS Code extension source package and align module code/docs references so APIs, milestones, and progression notes remain consistent across the curriculum.
2026-02-15 14:02:09 -05:00
Vijay Janapa Reddi
9c1ca3e441 style(tinytorch): standardize formatting and conventions across all 20 modules
Audit and fix consistency issues across all module source files:

- Standardize ML Systems header to "ML Systems Reflection Questions" (01, 13)
- Fix section ordering: test_module before ML Systems in modules 16, 17
- Rename demo_spatial() to demo_convolutions() to match module name (09)
- Rename demo_*_with_profiler() to explore_*_with_profiler() (15, 16, 17)
- Fix test naming to use test_unit_* prefix consistently (03, 05, 11, 12)
- Add missing emojis in test_module/demo patterns (02, 15)
- Standardize tito command format to number-only (01, 03, 06, 07, 18)
- Fix implementation headers: hyphen to colon separator (09, 12)
- Add missing "Where This Code Lives" package section (13)
- Fix export command in module summary (05, 06)
2026-02-15 09:37:25 -05:00
Vijay Janapa Reddi
81cdbba67b refactor(tinytorch): function decomposition, naming conventions, and progressive disclosure
Three categories of changes across 17 modules:

1. Function decomposition (Modules 01,03,05-15,18-19): Break large
   monolithic functions into focused _helper + orchestrator pattern.
   Each helper teaches one concept with its own unit test.

2. Naming convention fixes (Modules 08,09,11,18,19): Ensure underscore
   convention is consistent — standalone _func in export cells renamed
   to func (public API), monkey-patched method names match target
   visibility, removed unnecessary #| export from internal helpers.

3. Progressive disclosure (Modules 02-05,08,11-15): Remove forward
   references to future modules. Replace "you'll learn in Module N"
   with concrete descriptions. Trim connection maps to only show
   current and prior modules. Keep end-of-module "Next" teasers
   as motivational breadcrumbs.

All 17 modified modules pass their test suites.
2026-02-14 16:52:15 -05:00
Vijay Janapa Reddi
a9c2ba0180 fix(tinytorch): enforce progressive disclosure and move EmbeddingBackward to Module 11
Audit all 20 modules for progressive disclosure violations and fix ~50 issues:

- Module 01: Replace "neural network" framing with "linear transformation" in
  ASCII tables, docstrings, test names, and reflection questions
- Modules 02-04: Remove gradient/neural-network terminology before M06 teaches it
- Module 06: Remove EmbeddingBackward (moved to Module 11 where embeddings are taught)
- Module 11: Add EmbeddingBackward with pedagogical gather/scatter ASCII diagram,
  remove runtime import from autograd, fix "Attention-Ready" forward references
- Modules 12-13: Replace FlashAttention references with generic efficiency language
- Module 17: Fix profiler module number (15 → 14)
- Module 19: Remove Module 20 forward dependency from OlympicEvent
- Module 20: Fix pipeline diagram module numbering and demo ordering

Zero changes to executable logic — all edits target docstrings, comments,
ASCII art, class placement, and test descriptions.
2026-02-13 13:15:24 -05:00
Dang Truong
af23c13999 fix small typo (#1163) 2026-02-06 02:09:30 -05:00
Vijay Janapa Reddi
c1c8c11eec fix(layers): correct Xavier/Glorot initialization terminology
The formula sqrt(1/fan_in) is actually LeCun initialization (1998),
not Xavier/Glorot. True Xavier uses sqrt(2/(fan_in+fan_out)).

- Rename XAVIER_SCALE_FACTOR → INIT_SCALE_FACTOR
- Update all comments to say "LeCun-style initialization"
- Add note explaining difference between LeCun, Xavier, and He init
- Keep the simpler formula for pedagogical clarity

Fixes #1161
2026-02-05 20:11:50 -05:00
Vijay Janapa Reddi
0c7509ff35 feat(site): add embedded PDF slide viewer to all module pages
Replace the slide download card with an inline PDF viewer using PDF.js:
- Change grid layout from 4 cards (2x2) to 3 cards in a row
- Add embedded slide viewer with navigation, zoom, and fullscreen
- Load slides from local _static/slides/ for reliable CORS handling
- Add "· AI-generated" subtitle to match audio card pattern
- Use 🔥 icon consistently across all viewers

Affected: 20 module ABOUT.md files + big-picture.md
2026-02-03 12:06:52 -05:00
AndreaMattiaGaravagno
ad94870ed2 docs(slides): specify genai usage (#1149) 2026-02-01 10:01:47 -05:00
Vijay Janapa Reddi
eab5122691 feat: add slide deck cards to all module pages
- Add 4th card (Slide Deck) to 2x2 grid layout on 18 modules
- Host PDFs via GitHub release (tinytorch-slides-v0.1.0)
- Card order: Audio → Binder → Source → Slides
- Colors: Orange (#f97316), Teal (#14b8a6), Sky Blue (#0ea5e9)
2026-01-25 13:21:06 -05:00
Vijay Janapa Reddi
0b2c1bfb95 feat: upgrade error messages to 3-part educational pattern
Improve ~43 error messages across 12 modules to follow the
What/Why/Fix pattern (💡🔧) that teaches students at the
moment they hit an error:

-  What failed (with actual tensor shapes/values)
- 💡 Why it failed (conceptual insight)
- 🔧 How to fix (concrete code using their data)

Key improvements:
- Add anticipatory checks for common mistakes (e.g., 3D input
  to Conv2D when 4D expected suggests adding batch dimension)
- Dropout error now explains p is DROP probability, not KEEP
- Shape mismatch errors show both dimensions and suggest fixes
- Abstract method errors provide implementation templates

Modules updated: tensor, layers, dataloader, optimizers,
convolutions, tokenization, embeddings, attention, quantization,
acceleration, memoization, benchmarking

All 20 module tests pass.
2026-01-25 10:28:03 -05:00
Vijay Janapa Reddi
56c05085d0 style(modules): standardize unit test emoji to test tube
Update unit test markers across all 20 modules for consistency:
- Changed header emoji from microscope to test tube
- Maintains visual consistency across module test sections
2026-01-24 19:04:04 -05:00
Vijay Janapa Reddi
aafd7a8c67 refactor(modules): standardize formatting and fix NBGrader directives
- Standardize test emoji usage (🔬 for unit tests, 🧪 for module tests)
- Restore missing NBGrader solution blocks in Module 15 (quantization)
- Fix missing #| default_exp directives in modules 05, 12, 13, 15, 17
- Remove duplicate #| default_exp directives
- Ensure all exports are only for core functionality (no tests/demos)
- Apply consistent styling across all 20 modules via module-developer agent
2026-01-24 10:07:18 -05:00
Vijay Janapa Reddi
c420fe7858 chore(tinytorch): bump version to v0.1.4
TinyTorch v0.1.4: Educational improvements and module path fixes

Breaking Changes:
- fix: correct module path from core.transformer to core.transformers (14 files)

Educational Enhancements:
- refactor: remove premature backward() methods for cleaner progressive learning
- feat: add educational scaffolding with TODO/hints in Module 20 Capstone
- docs: remove forward references to Module 06 in early modules

Bug Fixes:
- fix: TransformerBlock now supports ff_dim parameter for flexibility
- fix: wrap module print statements in if __name__ guards

Code Quality:
- refactor: reorganize Quantizer class export location
- refactor: improve module integration in tinytorch.__init__.py
- chore: remove outdated TINYTORCH_FORMATTING_STANDARDS.md (415 lines)

Stats: 29 files changed, 357 insertions(+), 711 deletions(-)
2026-01-17 10:25:59 -05:00
Vijay Janapa Reddi
a363406902 fix(layers): remove requires_grad from Linear layer Tensor calls
Module 03 (Linear layer) was incorrectly passing requires_grad=True
to Tensor constructor, which violates progressive disclosure design.

The requires_grad parameter is introduced in Module 06 via monkey
patching of Tensor.__init__. Module 03 should work independently
without depending on autograd functionality.

Changes:
- Remove requires_grad=True from weight/bias Tensor initialization
- Update ABOUT.md to clarify gradient tracking is enabled in Module 06

This fixes the issue reported where students working sequentially
through modules would get errors in Module 03 before completing
Module 06.

Closes #1101
2026-01-13 10:02:32 -05:00
Vijay Janapa Reddi
c89fb020e4 fix: update remaining module references in documentation
Fixed module number references in:
- INSTRUCTOR.md: course schedule table
- Site: credits.md, tito/data.md module status display
- Source ABOUT.md: 02_activations, 03_layers forward references
- Milestones: 01_perceptron, 03_mlp prerequisite tables
- modules/EDUCATION_REVIEW_ACTION_PLAN.md: module checklist
2025-12-19 20:19:55 -05:00
Vijay Janapa Reddi
f781d6329e fix: add requires_grad=True to Linear layer weights and update module refs
Bug fixes:
- Linear layer weights/biases now have requires_grad=True for training
- Fixed import path in test_gradient_flow.py (tinytorch.models → tinytorch.core)

Module reference updates (05 Autograd → 06 Autograd):
- src/17_memoization/17_memoization.py
- src/18_acceleration/18_acceleration.py
- tinytorch/core/layers.py (auto-generated)
2025-12-19 18:06:35 -05:00
Vijay Janapa Reddi
d203fba8b8 fix: complete module renumbering across entire codebase
Updated all references to reflect new module order:
- Module 05: DataLoader (was 08)
- Module 06: Autograd (was 05)
- Module 07: Optimizers (was 06)
- Module 08: Training (was 07)

Changes include:
- paper/paper.tex: 20+ references, tier descriptions, milestones
- src/: Export commands, dependency diagrams, docstrings
- tests/: Dependency chains, integration tests, README
- tito/: export_utils.py path mappings
- tinytorch/: Auto-generated package file headers

Foundation Tier is now Modules 01-08
Architecture Tier is now Modules 09-13
2025-12-19 17:43:41 -05:00
Vijay Janapa Reddi
bcf81d9490 style: standardize emoji section headers across all TinyTorch modules
- Update all 20 modules with consistent emoji section headers
- Use unique emojis for each section type:
  - 🔗 Prerequisites & Progress
  - 🎯 Learning Objectives
  - 📦 Package Location
  - 📋 Module Dependencies
  - 💡 Introduction/Motivation
  - 📐 Foundations/Math
  - 🏗️ Implementation
  - 🔧 Integration/Utilities
  - 📊 Systems Analysis
  - ⚠️ Warnings/Danger
  - 🧪 Module Integration Test
  - 🤔 ML Systems Thinking
  -  Aha Moment
  - 🚀 Module Summary
- Ensures visual consistency for student navigation across modules
2025-12-18 12:23:10 -05:00
Vijay Janapa Reddi
864dead8cc fix: add missing scaffolding to Module 03 Layers
Added EXAMPLE and HINTS to Linear.parameters() and Dropout.__init__()
2025-12-18 08:55:37 -05:00
Vijay Janapa Reddi
5321117f09 style: add consistent pill-shaped buttons to module cards
Replace text-only card links with styled 54px pill buttons for
Binder (orange) and GitHub (gray) actions. Audio player height
now matches button height for visual consistency across all 20
module pages.
2025-12-17 20:29:08 -05:00
Vijay Janapa Reddi
7196eb6f9c feat: add embedded audio players to module ABOUT pages
- Add HTML5 audio players for NotebookLM-generated overviews
- Fix tab-set directive nesting (remove stray backticks)
- Fix grid card fence structure (5 backticks for outer {only})
- Audio hosted on GitHub Release tinytorch-audio-v0.1.1
2025-12-17 19:28:44 -05:00
Vijay Janapa Reddi
23c5eb2b51 refactor: implement strict progressive disclosure for autograd
- Module 01: Remove requires_grad, grad, backward() from Tensor class
  Students learn pure tensor math first without gradient concepts

- Module 02: Remove requires_grad propagation from Softmax
  Activations are now forward-only until autograd is enabled

- Module 03: Remove requires_grad=True from layer weights
  Layers store parameters without gradient flags

- Module 05: Update enable_autograd() to ADD gradient infrastructure
  Now adds requires_grad, grad, and backward() to Tensor class
  Uses helper functions for tensors created before autograd

- Module 09: Remove Conv2dBackward, MaxPool2dBackward classes
  Convolutions are now forward-only, no Module 05 import

- Module 11: Remove EmbeddingBackward import and usage
  Embeddings are now forward-only

- Modules 12, 13: Remove requires_grad from mask/param tensors

This implements true progressive disclosure: concepts are introduced
only when students are ready to learn them. Gradient tracking is now
completely absent from Modules 01-04 and added in Module 05.
2025-12-17 15:09:38 -05:00
Vijay Janapa Reddi
08ff168328 feat: add Binder/Source/Audio grid cards to module pages
Adds interactive launch cards to all 20 TinyTorch module ABOUT.md files:
- Launch Binder button for browser-based exploration
- View Source link to GitHub implementation
- Audio Overview placeholder for NotebookLM content

Cards wrapped in {only} html directive to exclude from PDF output.
Also removes duplicate README.md files from src modules.
2025-12-17 14:33:04 -05:00
Vijay Janapa Reddi
82984bbff2 refactor(tinytorch): remove section numbers from markdown headers
Standardize header format across all 20 module files by removing
numbered prefixes. Headers now use descriptive titles only, making
maintenance easier when reordering sections.

Changes:
- `## 1. Introduction` → `## Introduction`
- `## Part N: Title` → `## Title`
- `## N.N Subsection` → `## Subsection`

Header hierarchy preserved (H1 for module title, H2 for sections).
2025-12-16 07:18:29 -05:00
Vijay Janapa Reddi
a6f9bc3b0b feat(tinytorch): add module.yaml metadata files for CLI module descriptions
Add machine-readable module.yaml files to each of the 20 modules with
title, subtitle, and description fields. Update tito CLI to read from
these files instead of parsing Python files.

- Create module.yaml in src/NN_*/ directories
- Add YAML parser with validation in tito/core/modules.py
- Update list_modules() to display descriptions from YAML
2025-12-15 20:30:32 -05:00
Vijay Janapa Reddi
d6a96ca2d2 fix(tinytorch): correct Binder URLs and remove broken Colab links
- Update Binder URLs to use urlpath parameter pointing to generated
  notebooks in modules/ directory instead of raw .py files
- Remove Colab links since they cannot run postBuild to generate notebooks
- Fix View Source links to include tinytorch/ prefix
2025-12-15 13:45:31 -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
853eb03ee8 style: apply consistent whitespace and formatting across codebase 2025-12-13 14:05:34 -05:00
Vijay Janapa Reddi
efc577f53f fix: improve ABOUT.md accuracy and PDF-compatible Get Started sections
- Fix API signatures to match actual implementations across all modules
- Correct loop counts (Module 09: 6→7 nested loops)
- Fix import paths (Module 14, 18: perf.* not nn.*)
- Clarify vectorized vs explicit loop implementations (Modules 05, 12)
- Replace {grid} cards with admonition-based links for PDF rendering
- Add missing API documentation (Modules 06, 08, 10, 13, 16)
- Update about-generator agent with accuracy requirements
2025-12-13 14:03:15 -05:00
Vijay Janapa Reddi
d7ac86fa82 docs: generate standardized ABOUT.md files for all 19 modules (02-20)
Generated comprehensive ABOUT.md companion documents for all TinyTorch
modules following the canonical Module 01 template structure:

Foundation Tier (Modules 02-07):
- Activations: ReLU, Sigmoid, Tanh, GELU, Softmax with numerical stability
- Layers: Linear, Dropout, Sequential with Xavier/He initialization
- Losses: MSE, CrossEntropy with log-sum-exp stability
- Autograd: Computation graphs, chain rule, backward pass
- Optimizers: SGD, Adam, AdamW with momentum and weight decay
- Training: Training loops, schedulers, gradient clipping, checkpointing

Architecture Tier (Modules 08-13):
- DataLoader: Dataset abstraction, batching, shuffling, iterator protocol
- Spatial: Conv2d, MaxPool2d, AvgPool2d with explicit loops
- Tokenization: Character and BPE tokenizers with vocabulary building
- Embeddings: Embedding tables, positional encoding, lookup operations
- Attention: Scaled dot-product, multi-head attention, causal masking
- Transformers: LayerNorm, MLP, TransformerBlock, complete GPT model

Optimization Tier (Modules 14-20):
- Profiling: Timing, memory measurement, bottleneck identification
- Quantization: INT8 quantization, scale/zero-point, PTQ
- Compression: Magnitude pruning, structured pruning, knowledge distillation
- Memoization: KV cache, gradient checkpointing, cache invalidation
- Acceleration: Vectorization, BLAS, kernel fusion, tiled operations
- Benchmarking: Statistical validity, reproducibility, MLPerf methodology
- Capstone: Complete benchmarking system, submission generation

Each ABOUT.md includes:
- 13 standardized sections matching Module 01 structure
- Embedded code snippets from actual .py implementations
- Progressive terminology (only uses terms from prior modules)
- Mermaid architecture diagrams
- Quantitative questions with calculations
- Production context comparisons (TinyTorch vs PyTorch)
- Seminal paper references in Further Reading
- Tab-set code comparisons with "Your Tiny🔥Torch" branding
2025-12-13 11:24:45 -05:00
Vijay Janapa Reddi
7af42694fb refactor: consolidate ABOUT.md files using symlinks
- Replace site/modules/*_ABOUT.md files with symlinks to src/*/ABOUT.md
- src/ is now the single source of truth for module documentation
- Sync cleaned-up versions (emoji removal) from site/ back to src/
- Remove sync target from Makefile since symlinks handle everything
- Jupyter Book works with symlinks, no build changes needed
2025-12-12 16:43:16 -05:00
Vijay Janapa Reddi
a774c7e4bb refactor(tinytorch): standardize all module ABOUT.md structure
- Move 'Getting Started' section earlier (position 6, after Build → Use → Reflect)
- Add 'Common Pitfalls' section to all modules (3-5 pitfalls with code examples)
- Add 'Production Context' section to all modules (framework comparisons, real-world usage)
- Verify professional emoji usage (no emoji in section headers)
- Apply consistent structure across all 20 modules
2025-12-07 11:13:11 -08:00
Vijay Janapa Reddi
11a55101be refactor(module 03): remove redundant code and fix docstrings
Additional cleanup following module review:
- Removed redundant __call__ method from Linear (inherits from Layer)
- Fixed Dropout docstrings to correctly describe inference behavior
- Simplified Sequential.parameters() by removing unnecessary hasattr check

All 61 tests still passing after cleanup
2025-12-07 06:05:32 -08:00
Vijay Janapa Reddi
0cf91ee0c3 refactor(tinytorch): simplify module 03 API and remove confusing aliases
Simplifies the layers module API by removing alias proliferation that could confuse students in a pedagogical framework.

Changes:
- Rename SimpleModel → Sequential (matches PyTorch naming)
- Remove create_mlp() and MLP alias (taught in milestones, not core modules)
- Remove input_size/output_size aliases from Linear (keep only in_features/out_features)
- Update all tests to use explicit Sequential composition
- Fix dtype test to validate float32 normalization (TinyTorch's design)

Module focus: Individual building blocks (Linear, Dropout, Sequential container)
MLP construction: Taught in Milestone 03 (1986 MLP) using manual composition

Rationale:
- Progressive disclosure: students learn explicit composition first
- API clarity: one way to do things reduces cognitive load
- Separation of concerns: modules teach primitives, milestones teach patterns

All tests passing: 48/48 in module 03, 214/221 across all modules
2025-12-07 05:31:05 -08:00
Vijay Janapa Reddi
e839e9658f feat(tinytorch): add SimpleModel utility class to layers module
Add SimpleModel as a minimal container for explicit layer composition.
Used by quantization, compression, and capstone modules for:
- Collecting parameters from multiple layers
- Running integration tests
- Enabling optimization functions that need a model object

This consolidates SimpleModel definitions that were scattered across modules.
2025-12-06 21:19:19 -08:00