Files
cs249r_book/mlsysim/generate_appendix.py
Vijay Janapa Reddi 9c3dce60dc Delete the core/constants.py compat shim; migrate the whole corpus
No-backward-compat sweep, part 2. The module had been reduced to a
units-only re-export ('retired, do not add values'); per policy it is
now gone and every consumer reads the real home:

- 32 internal modules, the package __init__, and core/__init__ import
  core.units (physics modules keep their own physics/constants)
- 43 book chapters' LEGO cells migrated (star imports, named imports,
  and the appendix attribute style 'constants.VIDEO_*' -> units.*);
  lego_focal_verify confirms identical pass/flag state to pre-sweep
  (8 pre-existing structural flags, A/B-verified unchanged)
- tutorial/tools/test imports migrated (incl. binder test_units.py);
  book tests' legacy-symbol scanner treats a missing constants.py as
  'nothing defined'
- test_constants_allowlist.py rewritten as a deletion pin: the module
  (and any shim for it) must never return; core.units must keep the
  measurement surface (ureg, Q_, GB, BYTES_FP16, PRECISION_MAP, ...)
- test_mlsysim_registry_parity.py deleted: it compared registry values
  against legacy constants 'before deletion' — that migration is
  complete (registry gate list updated)
- Docs prose (DATA_MODEL, architecture, contributing) states the
  deletion instead of describing a retired shim

749 passed; binder registry gate green; star import intact.
2026-06-06 11:34:47 -04:00

53 lines
1.9 KiB
Python

# generate_appendix.py
"""
mlsysim Appendix Generator
==========================
Generates Quarto-compatible Markdown tables for the textbook's backmatter.
Extracts live data from the mlsysim Hardware and Model registries.
"""
from mlsysim.core.units import Q_
from mlsysim.hardware.registry import Hardware
from mlsysim.models.registry import Models
def fmt_q(q: Q_, precision: int = 1) -> str:
"""Format a quantity for the table."""
if q is None: return "---"
return f"{q.magnitude:,.{precision}f} {q.units:~P}"
def generate_hardware_appendix():
"""Generates the Hardware Specifications table for the appendix."""
header = "| Accelerator | Year | Peak FP16 | Memory BW | Memory Capacity | TDP |\n"
divider = "|:---|:---:|:---:|:---:|:---:|:---:|\n"
rows = []
# Cloud Tiers
for h in [Hardware.Cloud.A100, Hardware.Cloud.H100, Hardware.Cloud.H200, Hardware.Cloud.MI300X]:
row = f"| {h.name} | {h.release_year} | {fmt_q(h.compute.peak_flops)} | {fmt_q(h.memory.bandwidth)} | {fmt_q(h.memory.capacity)} | {fmt_q(h.tdp, 0)} |"
rows.append(row)
return header + divider + "\n".join(rows)
def generate_model_appendix():
"""Generates the Model Workload table for the appendix."""
header = "| Model | Architecture | Parameters | Inference FLOPS | Layers |\n"
divider = "|:---|:---:|:---:|:---:|:---:|\n"
rows = []
for m in [
Models.Language.GPT2,
Models.Language.GPT3,
Models.Vision.ResNet50,
Models.Vision.MobileNetV2,
]:
row = f"| {m.name} | {m.architecture} | {fmt_q(m.parameters)} | {fmt_q(m.inference_flops)} | {m.layers or '---'} |"
rows.append(row)
return header + divider + "\n".join(rows)
if __name__ == "__main__":
print("## Hardware Specifications Appendix\n")
print(generate_hardware_appendix())
print("\n\n## Model Workload Appendix\n")
print(generate_model_appendix())