mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-04-29 00:59:07 -05:00
b44bfb143d
The script was using 4 parent directories to calculate workspace_root, but since the script is at book/tools/scripts/content/format_tables.py, it needs 5 parents to reach the actual repo root. This was causing "Directory not found: book/book/quarto/contents" errors in CI when the pre-commit hook passed paths like "book/quarto/contents/". 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Machine Learning Systems - Book
Build instructions for contributors
This directory contains the MLSysBook textbook source and build system.
📖 Read Online • 📄 PDF • 📓 EPUB
Quick Start
# First time setup
./binder setup
./binder doctor
# Daily workflow
./binder clean # Clean build artifacts
./binder build # Build HTML book
./binder preview intro # Preview chapter with live reload
# Build all formats
./binder pdf # Build PDF
./binder epub # Build EPUB
# Utilities
./binder help # Show all commands
./binder list # List chapters
Directory Structure
book/
├── quarto/ # Book source (Quarto markdown)
│ ├── contents/ # Chapter content
│ │ ├── core/ # Core chapters
│ │ ├── labs/ # Hands-on labs
│ │ ├── frontmatter/ # Preface, about, changelog
│ │ └── backmatter/ # References, glossary
│ ├── assets/ # Images, downloads
│ └── _quarto.yml # Quarto configuration
├── cli/ # Binder CLI tool
├── docker/ # Development containers
├── docs/ # Documentation
├── tools/ # Build scripts
└── binder # CLI entry point
Contributing
- Fork and clone the repository
- Set up your environment:
./binder setup - Find an issue or propose a change
- Make your changes in the
quarto/contents/directory - Preview your changes:
./binder preview <chapter> - Submit a PR with a clear description
Documentation
- docs/CONTRIBUTING.md - Contribution guide
- docs/BUILD.md - Build system details
- docs/DEVELOPMENT.md - Development guide
- docs/BINDER.md - CLI documentation
Related
- Root README - Project overview and what you will learn
- TinyTorch - Hands-on ML framework companion
- Website - Read the book online
License
Book content is licensed under Creative Commons Attribution–NonCommercial–ShareAlike 4.0 International (CC BY-NC-SA 4.0).
See LICENSE.md for details.