mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-05-06 01:28:35 -05:00
3a42c025df
Every hook now passes on `pre-commit run --all-files` (exit 0 after one
auto-fix pass + one verification pass — the standard pre-commit contract).
Unblocks book-validate-dev, which has been red on various hooks since the
mlsysim.core import failure finally cleared.
Fixes applied (source-traced, not suppressed):
1. codespell: 'OT' in mlperf-edu/reference/cloud/micro_lstm.py is the
column name for Oil Temperature in the ETTh1 dataset (Zhou et al.,
AAAI 2021), not a typo for 'to/of/or/not/it'. Added 'ot' to
.codespell-ignore-words.txt (case-insensitive, covers OT).
2. bib-lint §5 bibliography hygiene: 12 entries in
mlperf-edu/paper/refs.bib missing required publisher/journal per the
canonical mapping in book-prose-merged.md §5. Added canonical
publishers (MLSys → mlsys.org, ICLR → OpenReview.net, CVPR → IEEE,
NAACL → ACL, etc.); promoted krizhevsky2009cifar from @article to
@techreport with institution = University of Toronto. banbury2021mlperf
uses Curran Associates Inc. (pre-2022 NeurIPS rule); flagged
banbury2024wakevision for author review since the booktitle says CVPR
but web verification suggests it is still an arXiv preprint.
3. Over-eager 'vs.' style sweep corrupted anchor IDs: 77 instances of
-vs.- inside {#sec-...}, {#tbl-...}, {#fig-...} definitions and their
@-references across 27 QMDs. Anchor IDs must be literal strings without
periods per the repo's own section-ID naming rule; stripped the period
from all anchor tokens while preserving 'vs.' in visible prose.
4. 4 broken SVG filename references from the same sweep (pam4-vs.-nrz,
traditional-vs.-ml-fleet, tco-build-vs.-buy, centralized-vs.-decentralized)
— filenames on disk use vs- (no period) so refs restored to match.
5. Malformed XML declaration in bathtub-curve.svg:
'<?xml version="utf-8"?>' → '<?xml version="1.0" encoding="utf-8"?>'.
6. 21 quad-asterisks (****term****) in training.qmd collapsed to **term**.
7. bibtex-tidy auto-reformatted mlperf-edu/paper/refs.bib (alphabetical
order + consistent indentation + wrapped author lists) and pipe-table
prettifier realigned columns across ~20 QMDs. These are all cosmetic
formatter output — no content changes.
Verified: pre-commit run --all-files run #1 modified files (exit 1),
run #2 exit 0 with 61 Passed / 0 Failed.