mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-04-29 00:59:07 -05:00

Files

Vijay Janapa Reddi 96d487f211 docs: restructure READMEs for book and TinyTorch integration

- Root README: Add ML-Systems bridge table, book structure, and what makes this book different
- book/README: Simplify to build instructions for contributors
- tinytorch/README: Streamline with correct clone URL and Early Access status
- Rename contribute.md to CONTRIBUTING.md for consistency

2025-12-10 06:35:58 -08:00

2.7 KiB

Raw Blame History

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

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.

2.7 KiB Raw Blame History Unescape Escape