5 Commits
Author SHA1 Message Date
Vijay Janapa Reddi cb7c8c3f15 Enforce bidirectional notation coverage and standardize on mlsysim symbols across all volumes 2026-10-04 12:29:52 +02:00
Vijay Janapa Reddi ce4018e168 notation: make Volume I consistent with its notation table; split the series core
Volume I is in print, so the goal was consistency with the fewest changes.
A 17-auditor read of vol1 against the notation table found 284 distinct
findings; one fixer per chapter applied the regressions (23, from the
earlier pattern-based passes), mechanical fixes (208), and the approved
conventions, matching the surrounding prose.

Notation table (prints in vol1):
- Errata: the subscript sentence (the subscript is upright, not the
  root); the decimal-units rule now states the nameplate-capacity
  exception the assumptions appendix already used; notes no longer
  point at symbols the table never defines.
- Rows only where chapters improvised for want of one: d_in/d_out,
  y-hat, T_distill, T_memory/T_compute, N_GPU, L_lat,total, s_sample,
  s_loss; sentences for GEMM M,N,K, \mathcal{O}, l_p norms, mu, power
  subscripts, and upright p99.

Structure for four volumes:
- The shared body is split into a series core (head + tail, printed in
  every volume) and a vol1-only degradation extension, so vol2-4 no
  longer print tau/lambda meanings their extensions use differently.
  Vol1's assembled text differs only by the intended edits.
- New `binder check notation --scope vol1-print-pin`: fails when vol1's
  printed notation text changes; re-pin only for an approved erratum
  (binder/tools/audit/repin_vol1_notation.py).
- Tooling updated for the new file names (notation, currency-style,
  layout, math-render audits).

Also restores footnote markers and index tags dropped by the figure
reference rewrites (5 footnotes, 6 index entries), fixes the MIT Press
spellings and abbreviation expansions those rewrites introduced, a
residual-block Jacobian evaluated at the wrong layer, and the Kaplan
exponent arithmetic in Appendix B. Margin SVGs regenerated from the
generator for p99, r_pipe, and nameplate GB labels; TikZ labels updated
to the same symbols. Vol1 PDF builds cleanly with all validations.

Pre-commit: skipped book-check-footnotes, -code, -prose, -punctuation,
-numbers, -notation. Every remaining failure in them is pre-existing on
dev (vol2-4, plus unchanged vol1 percent and literal-number items); the
vol1 notation and pin scopes pass.
2026-10-01 11:30:53 -04:00
Vijay Janapa Reddi a654d81271 refactor(vol2): rename _notation_distributed to _notation_scaling
Align Volume 2 frontmatter notation partial filename with the volume title and update references across binder and audit tooling.
2026-09-14 11:43:16 +02:00
Vijay Janapa Reddi e8e7d356db Document every binder module, class, and function
Adds docstrings to the 900 definitions and 8 modules that had none across the binder CLI, its checks, and the audit and maintenance tools, and corrects a few docstrings that no longer matched the code. Only documentation changed.
2026-09-12 12:55:34 +02:00
Vijay Janapa Reddi 98075a9c3b Retire the root tools/ folder
- Math-rendering audits move to binder/tools/audit/math_render/, beside
  the other book audits. Their repo anchor, usage lines, the CodeQL
  ignore path, and binder's render-audit scope follow. The scope now
  resolves the script from the repo root; it previously looked under
  the book directory, where the script never lived.
- The Playwright release smoke checks move to scripts/release-smoke/.
- The StaffML lint-calibration consensus record moves to
  staffml/vault/docs/lint_calibration/, where enums.py cites it.
- The one-off phase_b..phase_g cleanup manifests, the unused playbook
  validator, and the tools README are removed; git history keeps them.
2026-09-10 16:50:29 +02:00