Commit Graph

21 Commits

Author SHA1 Message Date
Vijay Janapa Reddi
ff3797a1d8 Refactor: Finalize Volume 1 and update CLI/VSCode tooling
- Completed full Volume 1 refactor to Safe Class Namespace pattern.

- Fixed render errors and verified all 16 chapters.

- Updated 'binder' CLI with native validation and maintenance namespaces.

- Enhanced VS Code extension with Chapter Navigator and Run History.

- Integrated 'binder validate' into pre-commit workflows.
2026-02-11 09:25:50 -05:00
Vijay Janapa Reddi
9d840fc1a0 Merge branch 'dev' into feature/book-volumes 2026-02-10 13:12:34 -05:00
github-actions[bot]
ee0c1a75f3 Update contributors list [skip ci] 2026-02-04 15:35:29 +00:00
github-actions[bot]
1a80e57fa0 docs: add @AndreaMattiaGaravagno as book contributor for code 2026-02-04 03:25:37 +00:00
Vijay Janapa Reddi
a6cacd2771 fix: correct @ngbolin contributor placement (book -> tinytorch)
- Remove @ngbolin from book/.all-contributorsrc (incorrectly added)
- Keep @ngbolin in tinytorch/.all-contributorsrc with 'doc' type
- Regenerate README tables
2026-01-27 08:27:00 -05:00
github-actions[bot]
2efde6df2b docs: add @ngbolin as book contributor for doc 2026-01-27 12:52:04 +00:00
github-actions[bot]
6a697cbbef docs: add @minhdang26403 as book contributor for code 2026-01-26 13:37:02 +00:00
Vijay Janapa Reddi
103545ee23 Merge remote-tracking branch 'origin/dev' into feature/volume-restructure
# Conflicts:
#	.codespell-ignore-words.txt
#	README.md
2026-01-24 18:41:46 -05:00
github-actions[bot]
e7ebe37960 docs: add @BunningsWarehouseOfficial as book contributor for doc 2026-01-23 19:26:55 +00:00
Vijay Janapa Reddi
b6d8a8eb64 feat(contributors): add fun emojis, legend, and sorting
- Custom emoji set: 🪲 Bug Hunter, 🧑‍💻 Code Contributor, ✍️ Documentation Hero, etc.
- Add legend to all README contributor sections
- Sort contributors by contribution count (most active first)
- Remove old emoji key links, use inline legend instead
- Sync emoji mappings across both generator scripts
2026-01-22 10:23:30 -05:00
Vijay Janapa Reddi
26e9b65db1 Merge latest dev updates into feat/volume-restructure 2026-01-21 19:30:00 -05:00
Vijay Janapa Reddi
a59a169a7f Add sectioned contributor system with per-project tracking
- Rename workflow to update-contributors.yml (more generic name)
- Add generate_main_readme.py to create sectioned contributor table
- Update main README with sections: Book, TinyTorch, Kits, Labs
- Add contribution type badges (emojis) to contributor entries
- Add Marcelo Rovai to kits contributors
- Update workflow to handle all project contributor files
2026-01-21 19:21:47 -05:00
Vijay Janapa Reddi
8f740b8222 Add all book contributors from main config
Migrated 99 contributors from the main .all-contributorsrc to the
book-specific config. These are all the people who contributed to
the ML Systems Book project.

Total book contributors: 103
2026-01-20 13:53:54 -05:00
Vijay Janapa Reddi
0430c85639 Populate contributors from git history
- Scanned git history for each project folder
- Added historical contributors to .all-contributorsrc files
- Generated README contributor tables with emoji badges
- Added generate_readme_tables.py script for future updates

Contributors added:
- Book: profvjreddi, Mjrovai, GabrielAmazonas, hzeljko
- Kits: profvjreddi
- Labs: profvjreddi
- TinyTorch: AmirAlasady, profvjreddi, kai4avaya, minhdang26403,
             didier-durand, karthikdani, jettythek
2026-01-20 13:48:55 -05:00
Vijay Janapa Reddi
149d945a51 Add per-project All Contributors setup
Set up separate contributor tracking for each sub-project:
- book/.all-contributorsrc - Book content contributors
- kits/.all-contributorsrc - Hardware kit contributors
- labs/.all-contributorsrc - Lab exercise contributors
- tinytorch/.all-contributorsrc - Framework contributors

Each project now has:
- Its own .all-contributorsrc config file
- Contributors section in README with All Contributors format
- Project-specific contribution types in the recognition guide
- Cheatsheet in CONTRIBUTING.md (where applicable)

Added @AmirAlasady as first TinyTorch contributor for bug report #1122.

Usage: Comment on any issue/PR with:
@all-contributors please add @username for bug, code, doc, or ideas
2026-01-20 13:35:00 -05:00
Vijay Janapa Reddi
f31355c889 feat(volumes): implement volume separation for textbook
Add infrastructure for publishing Volume I and Volume II as standalone sites:

Volume Configs:
- Add _quarto-html-vol1.yml, _quarto-pdf-vol1.yml, _quarto-epub-vol1.yml
- Add _quarto-html-vol2.yml, _quarto-pdf-vol2.yml, _quarto-epub-vol2.yml
- Update navbar cross-links in all configs (book, kits, labs)

Volume Content:
- Add vol1/index.qmd, vol1/frontmatter/, vol1/backmatter/
- Add vol2/index.qmd, vol2/frontmatter/, vol2/backmatter/

Landing Page:
- Create landing/index.html with AI Engineering branding
- Add navigation to all resources (Vol I, Vol II, Full, TinyTorch, Kits)

Workflows:
- Add build_target input to book-build-container.yml (combined/vol1/vol2/all)
- Add deploy_target input to book-publish-live.yml
- Add matrix entries for volume-specific builds (Linux)
- Update deployment to handle /book/, /vol1/, /vol2/, and root

CLI:
- Update binder CLI to support --vol1 and --vol2 flags

Documentation:
- Update README.md with volume links and new URL structure
- Update book/README.md with correct paths

URL Structure:
- mlsysbook.ai/ -> Landing page
- mlsysbook.ai/book/ -> Full textbook
- mlsysbook.ai/vol1/ -> Volume I standalone
- mlsysbook.ai/vol2/ -> Volume II standalone
2026-01-10 09:28:25 -05:00
Vijay Janapa Reddi
95e0eafcdc refactor: rename Vol I tagline from Operate to Deploy
Update Volume I tagline from "Build, Optimize, Operate" to
"Build, Optimize, Deploy" across all documentation.

- "Deploy" better matches Part IV content (Serving, MLOps, Responsible Engineering)
- "Operate" implies ongoing management which is more Volume II territory
- Also fixes hw_acceleration table to use proper grid table format
2026-01-03 10:09:19 -05:00
Vijay Janapa Reddi
ba889bcc26 docs: update book README to reflect two-volume structure
Update the book/README.md to match the new two-volume organization:
- Add Volume I (Build, Optimize, Operate) and Volume II (Scale, Distribute, Govern) sections
- Update directory structure to show vol1/ and vol2/ instead of core/ and labs/
- Fix reference to config/ directory for Quarto configuration files
2026-01-02 17:40:43 -05:00
Vijay Janapa Reddi
22ae3d92a9 docs: reframe README as AI engineering discipline flagship
- Add punch line and mission statement establishing AI engineering
- Rename "About This Project" to "About the Ecosystem"
- Update Learning Stack diagram with systems-focused descriptions
- Move "Start Here" earlier for immediate action orientation
- Add Research to Teaching Loop section under What Makes This Different
- Expand Support section with mission tracking and impact explanation
- Update book/README.md with detailed learning content
- Update kits/README.md with consistent template structure
- Fix all kits links to use mlsysbook.ai/kits
- Change voice from "I" to "we" throughout
2025-12-29 23:53:05 -05:00
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
Vijay Janapa Reddi
7b92e11193 Repository Restructuring: Prepare for TinyTorch Integration (#1068)
* 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
2025-12-05 14:04:21 -08:00