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`
Refactors chapter discovery across CLI commands to use a single, canonical source of truth: the volume's Quarto PDF configuration file.
Introduces a new `get_chapters_from_config` function in `core/discovery.py` that parses the `_quarto-pdf-{volume}.yml` to derive the ordered list of testable chapter stems. This ensures consistent chapter order for `build` and `debug` operations, reducing duplication and improving maintainability.
Updates `build.py` and `debug.py` to delegate all chapter list retrieval to this new centralized method within `ChapterDiscovery`. Also enhances chapter QMD file location to support shared content paths.
Refactors the build process to leverage shared output file resolution logic, ensuring consistency across build and debug commands.
Improves validation by streamlining bibliography handling and adding stricter citation matching.
Updates diagram dependencies and adjusts content for clarity and accuracy.
Standardize Quarto config/style handling for HTML/EPUB volume builds, add explicit binder reset commands by format, and align QMD reference/label highlighting so structural tokens share consistent visual semantics.
- Widen gap between ML systems stack layers and data bar in both
margin and full-size variants so connector lines are clearly visible
- Add D·A·M Intersection Landscape Venn diagram (SVG + PNG) to the
D·A·M Taxonomy appendix with reference table and explanatory prose
- Add forward references to the Venn from Introduction and Part III
- Add learning objective for intersection mapping
- Chapter prose refinements across multiple chapters
After a successful build, the flag opens the output using the system
default application (PDF viewer, browser, EPUB reader). Works with
all build paths: full, chapter, volume, and HTML-only.
Edits across all Vol 1 chapters (benchmarking, serving, training,
frameworks, hw_acceleration, etc.) and Vol 2 chapters. Includes
data_efficiency rename to data_selection, build CLI improvements,
and copyedit PDF config addition.
Add --verbose / -v flag to see Quarto build output as it happens
instead of showing only a spinner. Useful for debugging build issues.
- Add verbose parameter to BuildCommand.__init__()
- Update _run_command() to stream output when verbose=True
- Use subprocess.Popen with line-by-line output streaming
Implements two key improvements to the binder CLI:
1. **Volume flag support for chapter builds**
- Volume flags (--vol1, --vol2) now work regardless of position in args
- New build_chapters_with_volume() method routes chapters to correct config
- Auto-prefixes chapter names with volume to disambiguate (intro -> vol2/intro)
- Outputs to volume-specific directories (_build/FORMAT-vol1/, _build/FORMAT-vol2/)
2. **Smart fuzzy chapter name matching**
- Prioritizes 'starts with' matches (ops -> ops_scale.qmd)
- Falls back to 'contains' matches if no prefix match found
- Enables shorter, more intuitive chapter references
Examples:
./binder pdf intro --vol2 # Uses vol2 config, auto-disambiguates
./binder html ops --vol2 # Fuzzy matches to ops_scale.qmd
./binder pdf serving --vol1 # Uses vol1 config, finds serving.qmd
Also fixes invalid aria-current property in Quarto YAML configs that
was causing validation errors during HTML builds.
Add --vol1 and --vol2 flags for building individual volumes:
- ./binder pdf --vol1 Build Volume I as PDF
- ./binder pdf --vol2 Build Volume II as PDF
- ./binder epub --vol1 Build Volume I as EPUB
- ./binder epub --vol2 Build Volume II as EPUB
- ./binder list --vol1 List Volume I chapters only
- ./binder list --vol2 List Volume II chapters only
Add ambiguous chapter detection for chapters that exist in both
volumes (e.g., introduction, conclusion). When ambiguous, the CLI
shows an error with guidance to use vol1/ or vol2/ prefix.
Changes:
- discovery.py: Add AmbiguousChapterError, volume-aware discovery
- build.py: Add build_volume() method
- main.py: Add volume flag handling and updated help text
- Renamed vol2/advanced_intro to vol2/introduction for consistency
- Updated all scripts and configs to use vol1/ instead of core/
- Updated pre-commit config to check all contents/ not just vol1/
- Updated path references in Lua filters, Python scripts, and configs
* Restructure: Move book content to book/ subdirectory
- Move quarto/ → book/quarto/
- Move cli/ → book/cli/
- Move docker/ → book/docker/
- Move socratiQ/ → book/socratiQ/
- Move tools/ → book/tools/
- Move scripts/ → book/scripts/
- Move config/ → book/config/
- Move docs/ → book/docs/
- Move binder → book/binder
Git history fully preserved for all moved files.
Part of repository restructuring to support MLSysBook + TinyTorch.
Pre-commit hooks bypassed for this commit as paths need updating.
* Update pre-commit hooks for book/ subdirectory
- Update all quarto/ paths to book/quarto/
- Update all tools/ paths to book/tools/
- Update config/linting to book/config/linting
- Update project structure checks
Pre-commit hooks will now work with new directory structure.
* Update .gitignore for book/ subdirectory structure
- Update quarto/ paths to book/quarto/
- Update assets/ paths to book/quarto/assets/
- Maintain all existing ignore patterns
* Update GitHub workflows for book/ subdirectory
- Update all quarto/ paths to book/quarto/
- Update cli/ paths to book/cli/
- Update tools/ paths to book/tools/
- Update docker/ paths to book/docker/
- Update config/ paths to book/config/
- Maintain all workflow functionality
* Update CLI config to support book/ subdirectory
- Check for book/quarto/ path first
- Fall back to quarto/ for backward compatibility
- Maintain full CLI functionality
* Create new root and book READMEs for dual structure
- Add comprehensive root README explaining both projects
- Create book-specific README with quick start guide
- Document repository structure and navigation
- Prepare for TinyTorch integration
