mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-05-08 18:01:20 -05:00
8fc8411ca3
Adopts the shared versioning pattern for the MLSYSIM docs site without
touching the paper LaTeX or PyPI publish flow — both deliberately stay
under their existing identities. The site release_id binds to the docs
corpus + python source via release_hash, and the paper PDF rides
alongside as a bundled artifact (with its own LaTeX-driven version).
mlsysim/docs/_quarto.yml:
- <meta name="release-manifest" content="/mlsysim/release-manifest.json">
in include-in-header.
- shared/release/release-pill.html added to include-after-body.
.github/workflows/mlsysim-publish-live.yml:
- workflow_dispatch inputs: release_type, description, site_only,
explicit_version, confirm — same shape as staffml-publish-live.
- New `prepare:` job calls _release-prepare.yml for release_id math.
- New "Emit release manifest" step writes release-manifest.json into
the build dir before deploy. Hashes mlsysim/docs + mlsysim/python +
mlsysim/pyproject.toml; excludes _build/, .quarto, etc.
- New `create-tag:` job tags mlsysim-v<release_id> and drafts a
GitHub Release with auto notes after deploy succeeds.
- The existing `mlsysim-pypi-publish.yml` (tag-triggered, OIDC PyPI
push) remains untouched. Pushing the new mlsysim-v* tag will fire
it as before. Pyproject.toml's version field is unchanged — it
remains PyPI's source of truth, separate from this site's.
309 lines
11 KiB
YAML
309 lines
11 KiB
YAML
# =============================================================================
|
|
# MLSys·im WEBSITE CONFIGURATION
|
|
# =============================================================================
|
|
# ML Systems Infrastructure Modeling — analytical, not simulation
|
|
# Part of the MLSysBook ecosystem: mlsysbook.ai/mlsysim/
|
|
# =============================================================================
|
|
|
|
project:
|
|
type: website
|
|
output-dir: _build
|
|
resources:
|
|
- mlsysim-paper.pdf
|
|
# Tutorial slide PDFs are injected by mlsysim-publish-live.yml /
|
|
# mlsysim-preview-dev.yml at the site root, alongside the paper.
|
|
- tutorial_part1.pdf
|
|
- tutorial_part2.pdf
|
|
|
|
website:
|
|
title: "MLSys·im — Machine Learning Systems"
|
|
description: "First-principles infrastructure modeling for ML systems — from edge to exascale."
|
|
site-url: https://mlsysbook.ai/mlsysim/
|
|
favicon: logo.svg
|
|
|
|
open-graph:
|
|
locale: en_US
|
|
site-name: "Machine Learning Systems"
|
|
title: "MLSys·im — ML Systems Infrastructure Modeling"
|
|
description: "Predict ML system performance, cost, and carbon from first principles. Companion to the ML Systems textbook."
|
|
twitter-card:
|
|
title: "MLSys·im — ML Systems Infrastructure Modeling"
|
|
description: "Predict ML performance, cost, and carbon from first principles. Open source."
|
|
card-style: summary
|
|
|
|
page-navigation: true
|
|
reader-mode: false
|
|
back-to-top-navigation: true
|
|
bread-crumbs: true
|
|
|
|
search:
|
|
keyboard-shortcut: ["/"]
|
|
|
|
# Shared navbar from navbar-common.yml; site-local dropdown merged by Quarto.
|
|
# Responsive props (background, pinned, collapse) inherited from
|
|
# shared/config/navbar-common.yml via metadata-files merge.
|
|
navbar:
|
|
logo: assets/images/logo.png
|
|
search: true
|
|
title: "Machine Learning Systems"
|
|
left:
|
|
- text: "MLSys·im"
|
|
menu:
|
|
- icon: calculator
|
|
text: "MLSys·im Home"
|
|
href: ./index.qmd
|
|
- text: "---"
|
|
- icon: rocket
|
|
text: "Getting Started"
|
|
href: getting-started.qmd
|
|
- icon: terminal
|
|
text: "CLI Reference"
|
|
href: cli-reference.qmd
|
|
- text: "---"
|
|
- icon: journal-code
|
|
text: "Tutorials"
|
|
href: tutorials/index.qmd
|
|
- icon: collection
|
|
text: "The Zoo"
|
|
href: zoo/index.qmd
|
|
- icon: code-square
|
|
text: "API Reference"
|
|
href: api/index.qmd
|
|
- text: "---"
|
|
# Paper lives next to the site it documents, matching the
|
|
# TinyTorch pattern. Path matches the mlsysim-publish-live
|
|
# workflow output (mlsysim-paper.pdf at site root).
|
|
- icon: file-pdf
|
|
text: "MLSys·im Paper (PDF)"
|
|
href: mlsysim-paper.pdf
|
|
target: _blank
|
|
# Tutorial slide PDFs are injected at the site root by the same
|
|
# publish workflow (tutorial_part1.pdf / tutorial_part2.pdf).
|
|
- icon: easel
|
|
text: "Tutorial Slides"
|
|
href: slides.qmd
|
|
|
|
sidebar:
|
|
style: "floating"
|
|
background: light
|
|
search: true
|
|
collapse-level: 2
|
|
contents:
|
|
# ── GET STARTED ──────────────────────────────────
|
|
- section: "Get Started"
|
|
contents:
|
|
- getting-started.qmd
|
|
- models-and-solvers.qmd
|
|
- cli-reference.qmd
|
|
|
|
# ── LEARN ────────────────────────────────────────
|
|
- section: "Tutorials"
|
|
href: tutorials/index.qmd
|
|
contents:
|
|
- section: "Foundations"
|
|
contents:
|
|
- tutorials/00_hello_roofline.qmd
|
|
- tutorials/01_memory_wall.qmd
|
|
- tutorials/02_two_phases.qmd
|
|
- tutorials/03_kv_cache.qmd
|
|
- section: "Optimization"
|
|
contents:
|
|
- tutorials/04_starving_the_gpu.qmd
|
|
- tutorials/05_quantization.qmd
|
|
- section: "Scale & Cost"
|
|
contents:
|
|
- tutorials/06_scaling_1000_gpus.qmd
|
|
- tutorials/07_geography.qmd
|
|
- tutorials/08_nine_million_dollar.qmd
|
|
- section: "Analysis"
|
|
contents:
|
|
- tutorials/09_sensitivity.qmd
|
|
- tutorials/10_gpu_vs_wafer.qmd
|
|
- tutorials/12_design_space_exploration.qmd
|
|
- tutorials/12_full_stack_audit.qmd
|
|
- section: "Extending MLSys·im"
|
|
contents:
|
|
- tutorials/01_pipeline_callbacks.qmd
|
|
- tutorials/02_differential_explainer.qmd
|
|
- section: "Self-Paced Tutorial"
|
|
contents:
|
|
- text: "Tutorial Exercises"
|
|
href: ../tutorial/exercises.md
|
|
- text: "Cheat Sheet"
|
|
href: ../tutorial/cheatsheet.md
|
|
- text: "Laws Explained"
|
|
href: laws-explained.md
|
|
|
|
# ── INTERACTIVE APPS (pending Marimo integration) ──
|
|
# - section: "Interactive Apps"
|
|
# contents:
|
|
# - text: "Roofline Explorer"
|
|
# href: interactive_roofline.html
|
|
# - text: "SLA Optimizer"
|
|
# href: sla_optimizer.html
|
|
# - text: "Carbon Placement"
|
|
# href: carbon_placement.html
|
|
|
|
# ── THE ZOO ──────────────────────────────────────
|
|
- section: "The MLSys Zoo"
|
|
href: zoo/index.qmd
|
|
contents:
|
|
- zoo/hardware.qmd
|
|
- zoo/models.qmd
|
|
- zoo/fleets.qmd
|
|
- zoo/infra.qmd
|
|
|
|
# ── FOR YOUR ROLE ────────────────────────────────
|
|
- section: "For Your Role"
|
|
contents:
|
|
- for-students.qmd
|
|
- for-instructors.qmd
|
|
- for-engineers.qmd
|
|
|
|
# ── UNDERSTAND ───────────────────────────────────
|
|
- section: "Concepts"
|
|
contents:
|
|
- architecture.qmd
|
|
- math.qmd
|
|
- accuracy.qmd
|
|
- understanding-efficiency.md
|
|
- api-stability.md
|
|
- empirical-calibration.md
|
|
- glossary.qmd
|
|
|
|
# ── BUILD & EXTEND ──────────────────────────────
|
|
- section: "Build & Extend"
|
|
contents:
|
|
- extending-the-engine.qmd
|
|
- agentic-mcp.qmd
|
|
- contributing.qmd
|
|
|
|
# ── API REFERENCE ────────────────────────────────
|
|
- section: "API Reference"
|
|
href: api/index.qmd
|
|
contents:
|
|
- text: "Hardware"
|
|
href: api/hardware.qmd
|
|
- text: "Models"
|
|
href: api/models.qmd
|
|
- text: "Systems"
|
|
href: api/systems.qmd
|
|
- text: "Infrastructure"
|
|
href: api/infra.qmd
|
|
- text: "Core"
|
|
href: api/core.qmd
|
|
- text: "Solvers"
|
|
href: api/core.solver.qmd
|
|
|
|
# ── BLOG ───────────────────────────────────────────
|
|
- section: "Blog"
|
|
contents:
|
|
- text: "How Much Memory Does Llama-3 70B Need?"
|
|
href: blog/how-much-memory-llama3.md
|
|
|
|
# ── PROJECT ──────────────────────────────────────
|
|
- section: "Project"
|
|
contents:
|
|
- text: "MLSys·im Paper (PDF)"
|
|
href: mlsysim-paper.pdf
|
|
target: _blank
|
|
- vision-0.1.0.qmd
|
|
|
|
# Footer — ecosystem pattern (matches Kits)
|
|
page-footer:
|
|
left: |
|
|
© 2024-2026 Harvard University. Code: <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache-2.0</a> · Docs: <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC-BY-NC-SA 4.0</a>
|
|
center: |
|
|
Part of the <a href="../">Machine Learning Systems</a> textbook
|
|
right:
|
|
- icon: github
|
|
href: https://github.com/harvard-edge/cs249r_book
|
|
aria-label: "View source on GitHub"
|
|
background: light
|
|
border: true
|
|
|
|
bibliography: references.bib
|
|
csl: https://raw.githubusercontent.com/citation-style-language/styles/master/ieee.csl
|
|
|
|
format:
|
|
html:
|
|
theme:
|
|
light:
|
|
- default
|
|
- styles/style.scss
|
|
dark:
|
|
- default
|
|
- styles/style.scss
|
|
- styles/dark-mode.scss
|
|
respect-user-color-scheme: true
|
|
css: styles/landing.css
|
|
toc: true
|
|
toc-depth: 4
|
|
toc-title: "On this page"
|
|
number-sections: false
|
|
code-copy: true
|
|
code-overflow: wrap
|
|
smooth-scroll: true
|
|
highlight-style: github
|
|
link-external-icon: false
|
|
link-external-newwindow: false
|
|
anchor-sections: true
|
|
include-in-header:
|
|
- file: ../../shared/config/site-head.html
|
|
- text: |
|
|
<meta name="theme-color" content="#0284C7">
|
|
<!-- Release identity (rendered into the footer pill below).
|
|
The publish workflow drops release-manifest.json at the
|
|
site root before deploy. -->
|
|
<meta name="release-manifest" content="/mlsysim/release-manifest.json">
|
|
include-after-body:
|
|
- text: |
|
|
<script src="scripts/subscribe-modal.js" defer></script>
|
|
- file: ../../shared/release/release-pill.html
|
|
|
|
# Announcement bar configuration
|
|
metadata-files:
|
|
- ../../shared/config/navbar-common.yml
|
|
- config/announcement.yml
|
|
|
|
quartodoc:
|
|
package: mlsysim
|
|
dir: api
|
|
title: API Reference
|
|
sections:
|
|
- title: Core API
|
|
desc: Primary objects and resolvers.
|
|
contents:
|
|
- hardware
|
|
- models
|
|
- infra
|
|
- systems
|
|
- core
|
|
- core.solver.SingleNodeModel
|
|
- core.solver.NetworkRooflineModel
|
|
- core.solver.EfficiencyModel
|
|
- core.solver.ForwardModel
|
|
- core.solver.ServingModel
|
|
- core.solver.ContinuousBatchingModel
|
|
- core.solver.WeightStreamingModel
|
|
- core.solver.TailLatencyModel
|
|
- core.solver.DataModel
|
|
- core.solver.TransformationModel
|
|
- core.solver.TopologyModel
|
|
- core.solver.ScalingModel
|
|
- core.solver.InferenceScalingModel
|
|
- core.solver.CompressionModel
|
|
- core.solver.DistributedModel
|
|
- core.solver.ReliabilityModel
|
|
- core.solver.OrchestrationModel
|
|
- core.solver.EconomicsModel
|
|
- core.solver.SustainabilityModel
|
|
- core.solver.CheckpointModel
|
|
- core.solver.ResponsibleEngineeringModel
|
|
- core.solver.SensitivitySolver
|
|
- core.solver.SynthesisSolver
|
|
- core.solver.ParallelismOptimizer
|
|
- core.solver.BatchingOptimizer
|
|
- core.solver.PlacementOptimizer
|
|
- core.dse.DSE
|