Files
cs249r_book/mlsysim/examples/06_multi_objective_pareto.py
Vijay Janapa Reddi 3ba3858b74 MLSys·im 0.1.0 release-prep audit (#1397)
* docs(mlsysim): release-prep audit fixes for 0.1.0

Fixes the broken links, stale numerical claims, and naming inconsistencies
surfaced by the 0.1.0 release-prep review. Output of the docs site now matches
what the engine actually computes, internal navigation has no unresolved targets,
and the Hatch announcement banner uses an absolute URL so sub-pages render the
"Get started" link correctly.

Notable changes:
- Hero example on docs/index.qmd and getting-started.qmd now reflect the actual
  Engine.solve(ResNet50, A100, bs=1, fp16) output (Memory / 0.54 ms / 1843).
- Update Python version requirement (3.10+) and document the editable-install
  limitation (Hatch sources rewrite is not supported by editables).
- Standardize the typographic brand to "MLSys·im" in the navbar, OG/Twitter
  metadata, and the shared cross-site dropdown.
- Add the four solvers missing from the quartodoc list
  (BatchingOptimizer, ForwardModel, NetworkRooflineModel, PlacementOptimizer)
  and surface the orphan tutorials (01_pipeline_callbacks,
  02_differential_explainer, 12_design_space_exploration) in the sidebar.
- Rename every reference to the now-deleted hello_world / llm_serving /
  sustainability / 11_full_stack_audit tutorials to their current filenames.
- Add the missing @mlsysbook2024 entry to references.bib so whitepaper.qmd
  no longer logs a citeproc warning.
- Fix the CLI sample on the parent site/index.qmd card to use real model
  identifiers (Llama3_70B H100 --batch-size 1).
- Soften the Colab/Binder copy until launch buttons are wired in.
- Remove the duplicate "Differential Explainer" card on tutorials/index.qmd.

* release(mlsysim): add 0.1.0 release notes and runbook

- RELEASE_NOTES_0.1.0.md: GitHub-release-ready notes promoted from CHANGELOG
  with install/quickstart copy and a "known limitations & gotchas" section
  covering the editable-install issue, broken example scripts, and unpublished
  slide tag.
- RELEASE.md: copy-pasteable runbook for cutting a release (pre-flight check,
  tag, build, twine upload, docs deploy via workflow_dispatch, GitHub release,
  and post-release verification).
- CHANGELOG.md: corrected the test count from 334 to the actual 367 currently
  passing on dev.

* mlsysim: nest package layout, enable editable installs, clean lint

Restructure mlsysim into the standard nested layout (`mlsysim/mlsysim/...`)
so `pip install -e .` works out of the box. The previous flat layout used
a Hatch `sources = {"." = "mlsysim"}` prefix-add rewrite that the
`editables` backend cannot handle, breaking editable installs entirely.

Packaging
- pyproject.toml: drop `sources` rewrite, set `packages = ["mlsysim"]`,
  add explicit `[tool.hatch.build.targets.sdist]` include list.
- Wheel and sdist now contain only the package and project metadata
  (no `tests/`, `docs/`, `examples/`, `paper/`, `vscode-ext/` leakage).
- Update `pyright.exclude` for nested layout.
- Update GitHub source links in `docs/math.qmd` and
  `docs/models-and-solvers.qmd` to point to `mlsysim/mlsysim/...`.

Lint configuration
- Add `[tool.ruff]` to pyproject.toml with sensible per-file ignores:
  `__init__.py` re-export pattern (F401/F403/F405/F811),
  `core/constants.py` star import from unit registry,
  tests/examples idioms.
- `ruff check .` reports zero issues (down from 621).

Real bug fixes uncovered by lint cleanup
- `core/solver.py`: remove unused `from pydantic import BaseModel` that
  was being shadowed by the local `BaseModel = ForwardModel` alias.
- `sim/simulations.py`: remove redundant local `Fleet` import that was
  shadowing the module-level import and triggering F823 (referenced
  before assignment) on the earlier `isinstance(..., Fleet)` check.
- `cli/commands/audit.py`, `cli/commands/eval.py`: narrow three bare
  `except:` clauses to specific exception types.
- `tests/test_sota.py`: add the missing speculative-decoding ITL
  assertion (`res_opt.itl < res_base.itl`) — `res_base` was previously
  computed but never compared.
- `cli/commands/eval.py`: drop unused `is_json` local.
- `labs/components.py`: drop unused `energy` placeholder local.

Examples
- `examples/06_multi_objective_pareto.py`: rewrite around the actual
  `BatchingOptimizerResult` API (which has no `pareto_front` attribute);
  build the front explicitly by sweeping batch sizes through
  `ServingModel` + `TailLatencyModel`, then highlight the optimum
  returned by `BatchingOptimizer`.
- `examples/gemini_design_loop.py`: fix multi-line f-string syntax errors
  (`f"\n[…]"` instead of an embedded literal newline) so the file imports
  on every supported Python version.

Dev scripts
- `generate_appendix.py` and `paper/scripts/validate_anchors.py`: switch
  from package-relative imports to absolute `from mlsysim... import` so
  they run cleanly under the nested layout.

Docs / release notes
- `docs/getting-started.qmd`: replace the editable-install caveat with
  `pip install -e ".[dev]"` (now supported).
- `RELEASE_NOTES_0.1.0.md`: drop the three "known limitations" entries
  that this commit resolves (editable install, pareto example, gemini
  example).
- `CHANGELOG.md`: add a "Packaging & Tooling" section describing the
  layout change and the resolver bug fixes.

Verification
- `python -m pytest tests/` → 367 passed (was 367, no regressions).
- `ruff check .` → All checks passed.
- `pip install -e .` → succeeds; live source picked up.
- Fresh-venv wheel install + CLI smoke test → succeeds.
- `examples/06_multi_objective_pareto.py` and
  `examples/gemini_design_loop.py` → both exit 0.

* fix(mlsysim): repair docs build + lab test after nested-package restructure

The 0.1.0 release prep moved the package from `mlsysim/` to `mlsysim/mlsysim/`
to support `pip install -e .`. Two CI jobs still depended on the old layout:

1. **Docs build (`mlsysim-preview-dev`)** — every tutorial and zoo page used
   a hand-rolled `importlib.util.spec_from_file_location` block to load
   `<repo>/mlsysim/__init__.py` directly from source. After the restructure,
   that path no longer exists. Replaced the hack in 17 docs/.qmd files with
   a plain `import mlsysim` — the package is already pip-installed in the
   docs build environment via `pip install ".[docs]"`. Updated the matching
   guidance in `contributing.qmd`.

2. **Lab static tests** — `test_no_localstorage_import` hard-coded
   `mlsysim/labs/state.py`; updated to the new nested path
   `mlsysim/mlsysim/labs/state.py`.

Verified locally: `pytest labs/tests/test_static.py::TestStateImplementation`
passes, and `quarto render docs/zoo/models.qmd` succeeds end-to-end.
2026-04-18 13:11:13 -04:00

93 lines
3.2 KiB
Python

"""
Example 06: Multi-Objective Optimization (Pareto Fronts)
--------------------------------------------------------
This script demonstrates how to construct a Pareto front of trade-offs
between Throughput (maximize) and P99 Latency (minimize) by sweeping
batch sizes through ``ServingModel`` and ``TailLatencyModel``.
It then uses ``BatchingOptimizer`` to confirm the largest batch size
that still satisfies a P99 SLA, marked on the front below.
This is a core pattern in ML systems engineering: you rarely have a
single "best" design — you have a frontier of feasible operating points,
and the SLA chooses one of them.
"""
import mlsysim
from mlsysim.core.solver import ServingModel, TailLatencyModel
def main():
print("Building Pareto Front: Llama-3 8B Inference on A100\n")
model = mlsysim.Models.Language.Llama3_8B
hardware = mlsysim.Hardware.Cloud.A100
seq_len = 128
arrival_rate_qps = 10.0
sla_latency_ms = 20_000.0 # 20 second budget
precision = "fp16"
serving = ServingModel()
tail = TailLatencyModel()
# 1. Sweep batch sizes to construct the Pareto front
points = []
for b in (1, 2, 4, 8, 16, 32, 64, 128, 256):
srv = serving.solve(
model, hardware,
seq_len=seq_len, batch_size=b,
precision=precision,
)
if not srv.feasible:
continue
service_latency = srv.ttft + (srv.itl * seq_len)
tl = tail.solve(
arrival_rate_qps=arrival_rate_qps / b,
service_latency_ms=service_latency.m_as("ms"),
num_replicas=1,
)
if not tl.is_stable:
continue
# Saturation throughput at this batch size: how many sequences/sec
# one replica could serve back-to-back (1 / per-batch service time).
sat_throughput = b * 1000.0 / service_latency.m_as("ms")
points.append({
"batch_size": b,
"p99_latency_ms": tl.p99_latency.m_as("ms"),
"throughput_seq_per_s": sat_throughput,
"feasible_under_sla": tl.p99_latency.m_as("ms") <= sla_latency_ms,
})
# 2. Confirm the optimum via BatchingOptimizer
optimizer = mlsysim.BatchingOptimizer()
result = optimizer.solve(
model=model,
hardware=hardware,
seq_len=seq_len,
arrival_rate_qps=arrival_rate_qps,
sla_latency_ms=sla_latency_ms,
precision=precision,
)
print(f"Optimal Batch Size (≤ {sla_latency_ms/1000:.0f}s SLA): {result.best_batch_size}")
print(f"Throughput at optimum: {result.max_throughput:.1f} seq/s")
print(f"P99 latency at optimum: {result.p99_latency:~.1f}\n")
print("--- Pareto Front (sweep) ---")
print(f"{'Batch':<6} | {'P99 latency (ms)':<18} | {'Throughput (seq/s)':<20} | SLA")
print("-" * 70)
for p in points:
marker = " <-- OPTIMAL" if p["batch_size"] == result.best_batch_size else ""
sla_flag = "OK" if p["feasible_under_sla"] else "violates"
print(
f"{p['batch_size']:<6} | {p['p99_latency_ms']:<18.1f} | "
f"{p['throughput_seq_per_s']:<20.1f} | {sla_flag}{marker}"
)
if __name__ == "__main__":
main()