mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2025-12-05 19:17:28 -06:00
7b92e11193
* 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
1.3 KiB
1.3 KiB
Machine Learning Systems - Book
Principles and Practices of Engineering Artificially Intelligent Systems
This directory contains the MLSysBook textbook content and build system.
For the full project overview including TinyTorch, see the root README.
Quick Start
# First time setup
./binder setup
./binder doctor
# Daily workflow
./binder clean
./binder build
./binder preview intro
# Build all formats
./binder pdf
./binder epub
Directory Structure
book/
├── quarto/ # Book source (Quarto markdown)
│ ├── contents/ # Chapter content
│ ├── assets/ # Images, downloads
│ └── config/ # Quarto configurations
├── cli/ # Binder CLI tool
├── docker/ # Development containers
├── docs/ # Documentation
├── tools/ # Build scripts
└── binder # CLI entry point
Development
For detailed contribution guidelines, build instructions, and development workflows, see:
- docs/contribute.md - How to contribute
- docs/BUILD.md - Build system details
- docs/DEVELOPMENT.md - Development guide
- docs/BINDER.md - CLI documentation
License
CC BY-NC-SA 4.0 - See LICENSE.md