mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-05-01 18:19:18 -05:00
c30f2a3bfd
Moves the mlsysim package from book/quarto/mlsysim/ to the repo root so it is importable as a proper top-level package across the codebase. Key changes: - mlsysim/fmt.py: new top-level module for all formatting helpers (fmt, sci, check, md_math, fmt_full, fmt_split, etc.), moved out of viz/ - mlsysim/viz/__init__.py: now exports only plot utilities; dashboard.py (marimo-only) is no longer wildcard-exported and must be imported explicitly by marimo labs - mlsysim/__init__.py: added `from . import fmt` and `from .core import constants`; removed broken `from .viz import plots as viz` alias - execute-env.yml: fixed PYTHONPATH from "../../.." to "../.." so chapters resolve to repo root, not parent of repo - 51 QMD files: updated `from mlsysim.viz import <fmt-fns>` to `from mlsysim.fmt import <fmt-fns>` - book/quarto/mlsys/: legacy shadow package contents cleaned up; stub __init__.py remains for backward compat - All Vol1 and Vol2 chapters verified to build with `binder build pdf`
92 lines
3.3 KiB
Python
92 lines
3.3 KiB
Python
# viz.py
|
|
# Centralized Visualization Style for MLSys Book
|
|
# Ensures all generated figures across Vol 1 & 2 share a consistent,
|
|
# MIT Press-ready aesthetic.
|
|
|
|
import matplotlib.pyplot as plt
|
|
|
|
# --- Brand & Book Palette ---
|
|
COLORS = {
|
|
"crimson": "#A51C30", # Harvard Crimson
|
|
"primary": "#333333", # Dark Gray (Text)
|
|
"grid": "#CCCCCC", # Light Gray
|
|
|
|
# TikZ / Technical Palette (The "Golden" set)
|
|
"BlueLine": "#006395", "BlueL": "#D1E6F3", "BlueFill": "#D6EAF8",
|
|
"RedLine": "#CB202D", "RedL": "#F5D2D5", "RedFill": "#F2D7D5",
|
|
"GreenLine": "#008F45", "GreenL": "#D4EFDF", "GreenFill": "#D5F5E3",
|
|
"OrangeLine": "#E67817", "OrangeL": "#FCE4CC",
|
|
"VioletLine": "#7E317B", "VioletL": "#E6D4E5",
|
|
"BrownLine": "#78492A", "BrownL": "#E3D3C8",
|
|
"YellowFill": "#FEF9E0"
|
|
}
|
|
|
|
def set_book_style():
|
|
"""Applies the global matplotlib style configuration.
|
|
|
|
Font priority mirrors TikZ's \\usefont{T1}{phv}{m}{n} (Helvetica).
|
|
The fallback chain covers macOS (Helvetica), Linux TeX installs
|
|
(Nimbus Sans L, TeX Gyre Heros), and generic Linux (DejaVu Sans).
|
|
"""
|
|
plt.rcParams.update({
|
|
'font.family': 'sans-serif',
|
|
'font.sans-serif': [
|
|
'Helvetica', # macOS native
|
|
'Helvetica Neue', # macOS modern variant
|
|
'Nimbus Sans L', # Free Helvetica clone (TeX/Linux)
|
|
'TeX Gyre Heros', # Free Helvetica clone (TeX)
|
|
'Arial', # Windows fallback
|
|
'DejaVu Sans', # Universal last resort
|
|
],
|
|
'font.size': 10,
|
|
'text.color': COLORS['primary'],
|
|
'axes.labelsize': 11,
|
|
'axes.labelcolor': COLORS['primary'],
|
|
'axes.titlesize': 12,
|
|
'axes.titleweight': 'bold',
|
|
'axes.edgecolor': COLORS['primary'],
|
|
'axes.linewidth': 0.8,
|
|
'axes.spines.top': False,
|
|
'axes.spines.right': False,
|
|
'xtick.labelsize': 9,
|
|
'ytick.labelsize': 9,
|
|
'xtick.color': COLORS['primary'],
|
|
'ytick.color': COLORS['primary'],
|
|
'axes.grid': True,
|
|
'grid.color': COLORS['grid'],
|
|
'grid.alpha': 0.4,
|
|
'grid.linestyle': '--',
|
|
'grid.linewidth': 0.6,
|
|
'legend.fontsize': 9,
|
|
'legend.frameon': False,
|
|
'legend.title_fontsize': 10,
|
|
'lines.linewidth': 2.0,
|
|
'lines.markersize': 7,
|
|
'figure.dpi': 300,
|
|
'savefig.bbox': 'tight',
|
|
'savefig.pad_inches': 0.1,
|
|
'figure.figsize': (8, 5),
|
|
'figure.autolayout': True
|
|
})
|
|
|
|
# --- Font Size Convention for Diagram Figures ---
|
|
# All diagram figures (flowcharts, pipelines, etc.) should use:
|
|
# - Node/box labels: fontsize=9, fontweight='bold'
|
|
# - Edge/arrow labels: fontsize=8
|
|
# - Step/annotation: fontsize=8
|
|
# - Supplementary text: fontsize=7 (italic gray for minor labels)
|
|
# - In-plot headings: fontsize=10-12, fontweight='bold'
|
|
# Data plot text inherits from rcParams (axes: 11, ticks: 9, legend: 9).
|
|
|
|
# --- Lightweight helpers ---
|
|
|
|
def setup_plot(figsize=None):
|
|
"""
|
|
One-line plot setup for QMD blocks.
|
|
Returns (fig, ax, COLORS, plt) after applying book style.
|
|
The plt is returned so code blocks don't need separate matplotlib import.
|
|
"""
|
|
set_book_style()
|
|
fig, ax = plt.subplots(figsize=figsize)
|
|
return fig, ax, COLORS, plt
|