Files
cs249r_book/instructors/README.md

4.8 KiB

🗺️ The Blueprint — Instructor Site

Note

📌 Early release (2026)

This instructor site shipped with the 2026 MLSysBook refresh and is actively iterated: syllabi, rubrics, layouts, and diagrams (including SVGs) will keep improving as we teach from it.

FeedbackGitHub issues or pull requests.


📖 What This Is

"The Blueprint" is the instructor-facing companion site for the ML Systems textbook. It provides everything needed to teach AI Engineering as a university course.

Area What you get
📅 Syllabi Week-by-week syllabi for two semesters (Foundations + Scale).
⚖️ Assessment Assessment rubrics with sample student work.
🧠 Pedagogy Pedagogy guide with learning science and facilitation strategies.
👨‍🏫 TA Guide TA training guide with grading workflows and common student struggles.
⚙️ Config Customization guide for quarters, seminars, and different emphases.
FAQ FAQ for adopting instructors.

🛠️ Building Locally

cd instructors/ quarto preview

Requires Quarto 1.4+.


📂 File Structure

instructors/
├── _quarto.yml              # Site configuration
├── index.qmd                # Landing page (hero + overview)
├── getting-started.qmd      # 8-step adoption checklist
├── course-map.qmd           # Integration matrix + SVG diagrams
├── foundations-syllabus.qmd # Semester 1: 16-week schedule
├── scale-syllabus.qmd       # Semester 2: 16-week schedule
├── pedagogy.qmd             # Learning science + facilitation
├── assessment.qmd           # Rubrics + sample work
├── ta-guide.qmd             # TA training + grading workflows
├── customization.qmd        # Quarter/seminar/emphasis variants
├── faq.qmd                  # Common instructor questions
└── assets/                  # Styles and SVGs

🎨 Style Conventions

This site follows the MLSysBook ecosystem design system:

  • Accent color: Indigo (#6366f1 light, #818cf8 dark)
  • Callout geometry: 5px left border, 0.5rem radius, 8% opacity backgrounds
  • Typography: Inter (body), Outfit (headings), JetBrains Mono (code)
  • Navbar: Dark background (#0a0a0f), matching book sites

See assets/styles/style.scss for full details.


Contributors

Thanks to these wonderful people who have helped build the Instructor Site!

Legend: 🪲 Bug Hunter · Code Warrior · 📚 Documentation Hero · 🎨 Design Artist · 🧠 Idea Generator · 🔎 Code Reviewer · 🧪 Test Engineer · 🛠️ Tool Builder

Vijay Janapa Reddi
Vijay Janapa Reddi

🧑‍💻 🎨 ✍️
Farhan Asghar
Farhan Asghar

🪲 🧑‍💻 🎨
Rocky
Rocky

🧑‍💻 ✍️ 🔎

Recognize a contributor: Comment on any issue or PR:

@all-contributors please add @username for code, design, doc in instructors