mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-04-30 01:29:07 -05:00
533cfa6e99
- book/quarto/mlsys/__init__.py: add repo-root sys.path injection so
mlsysim is importable when scripts run from book/quarto/ context
- book/quarto/mlsys/{constants,formulas,formatting,hardware}.py: new
compatibility shims that re-export from mlsysim.core.* and mlsysim.fmt
- mlsysim/viz/__init__.py: remove try/except for dashboard import; use
explicit "import from mlsysim.viz.dashboard" pattern instead
- .codespell-ignore-words.txt: add "covert" (legitimate security term)
- book/tools/scripts/reference_check_log.txt: delete generated artifact
- Various QMD, bib, md files: auto-formatted by pre-commit hooks
(trailing whitespace, bibtex-tidy, pipe table alignment)
Book contents layout
Do not assume content lives only under vol1/ and vol2/. This directory has shared and front matter that both volumes depend on. Deleting or moving them will break builds.
Directory structure
| Path | Purpose |
|---|---|
shared/ |
Content used by both Volume I and Volume II (e.g. notation, conventions). |
frontmatter/ |
Site-level front matter (about, acknowledgements, Socratiq, etc.). |
index.qmd |
Root book index (under frontmatter/ in some configs). |
vol1/ |
Volume I: Introduction to Machine Learning Systems. |
vol2/ |
Volume II: Machine Learning Systems at Scale. |
Required non-volume paths
shared/— Must exist. Containsnotation.qmdand any other shared reference material.frontmatter/— Must exist. Contains about, acknowledgements, and other front matter.
Scripts and tooling that iterate over “all content” should include shared/ and frontmatter/ (and the root index.qmd where applicable), not only vol1/ and vol2/.