Add binder gates that ban legacy constant aliases, hardcoded grid literals,
and prose operands next to {python} refs; migrate appendices and chapter
callouts to export intermediate values from mlsysim registries so worked
math stays machine-verified instead of hand-typed.
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.
Unifies Quarto metadata into shared base/format/volume fragments while carrying through chapter path, asset, and tooling updates to keep the repository consistent and easier to maintain.
- 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
CLI changes:
- Fix default PDF/EPUB config paths to use vol1 configs instead of
non-existent combined configs (_quarto-pdf.yml -> _quarto-pdf-vol1.yml)
ml_systems.qmd fixes:
- Fix bottleneck_str formatting (value is already a string, not a number)
- Fix malformed imports where 'from physx.formatting import fmt' was
incorrectly placed inside parentheses of another import block
- Fix Quarto cell directives placement (must come before any code)
- Fix precision=0 rounding 0.1 to 0 for energy values
- Update notation to use proper LaTeX subscripts ($D_{vol}$, $E_{tx}$, etc.)
- Update chapter flow and narrative across conclusion, data_selection,
dnn_architectures, model_compression, training, and 10+ other chapters
- Expand references.bib with additional ML systems and foundations entries
- Add new appendix content: assumptions, DAM framework, notation guide
- Update Quarto configs for PDF, HTML, and EPUB builds
- Add audit scripts for figures, tables, listings, and narrative analysis
- Add chapter flow analysis reports for systematic content review
- Include calc modules for hw_acceleration and appendix_algorithm
- Remove deprecated foreword.qmd and vol2 appendix_a.qmd
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.
- Update ConfigManager to correctly find quarto/ directory when running
from book/ folder (expected working directory for the CLI)
- Fix data_engineering.qmd table: remove '#' prefix from 'schema version
branches' that was being parsed as a Markdown heading in PDF builds
Quarto book projects require index.qmd at the root level. This adds
automatic symlink management so that when building a specific volume,
the index.qmd symlink is updated to point to that volume's index file.
- Add _setup_index_symlink() method to ConfigManager
- Show index.qmd status in show_symlink_status()
- Automatically switch index symlink during volume builds
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
* 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
