Back to Cs249r Book

README

instructors/README.md

latest2.9 KB
Original Source
<div align="center"> <h1>πŸ—ΊοΈ The Blueprint β€” Instructor Site</h1> <blockquote> <b>Status: Under Active Development</b>
This site is being actively built and refined. Content, structure, and styling may change frequently. SVG diagrams are placeholder quality and will be professionally refined before launch.
</blockquote> </div>

πŸ“– 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.

<table> <tbody> <tr> <td width="15%" align="center"><b>πŸ“… Syllabi</b></td> <td><b>Week-by-week syllabi</b> for two semesters (Foundations + Scale).</td> </tr> <tr> <td width="15%" align="center"><b>βš–οΈ Assessment</b></td> <td><b>Assessment rubrics</b> with sample student work.</td> </tr> <tr> <td width="15%" align="center"><b>🧠 Pedagogy</b></td> <td><b>Pedagogy guide</b> with learning science and facilitation strategies.</td> </tr> <tr> <td width="15%" align="center"><b>πŸ‘¨β€πŸ« TA Guide</b></td> <td><b>TA training guide</b> with grading workflows and common student struggles.</td> </tr> <tr> <td width="15%" align="center"><b>βš™οΈ Config</b></td> <td><b>Customization guide</b> for quarters, seminars, and different emphases.</td> </tr> <tr> <td width="15%" align="center"><b>❓ FAQ</b></td> <td><b>FAQ</b> for adopting instructors.</td> </tr> </tbody> </table>

πŸ› οΈ Building Locally

<kbd>cd instructors/</kbd> <kbd>quarto preview</kbd>

Requires Quarto 1.4+.


πŸ“‚ File Structure

text
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.