mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-03-11 21:43:34 -05:00

Files

Vijay Janapa Reddi 97e0563614 Add community and benchmark features with baseline validation

- Implement tito benchmark baseline and capstone commands
- Add SPEC-style normalization for baseline benchmarks
- Implement tito community join, update, leave, stats, profile commands
- Use project-local storage (.tinytorch/) for user data
- Add privacy-by-design with explicit consent prompts
- Update site documentation for community and benchmark features
- Add Marimo integration for online notebooks
- Clean up redundant milestone setup exploration docs
- Finalize baseline design: fast setup validation (~1 second) with normalized results

2025-11-20 00:17:21 -05:00

4.3 KiB

Raw Blame History

Launch Readiness Checklist

✅ Assignment Process - COMPLETE

Dynamic Assignment Generation ✅

Source: modules/*/.*_dev.py (Python files)
Command: tito nbgrader generate MODULE
Output: assignments/source/MODULE/MODULE.ipynb
Status: Fully functional, dynamically generated

Assignment Release ✅

Command: tito nbgrader release MODULE
Output: assignments/release/MODULE/MODULE.ipynb (solutions removed)
Status: Ready for student distribution

Auto-Grading ✅

Command: tito nbgrader autograde MODULE
Status: NBGrader integration complete

✅ Site Build Integration - COMPLETE

Automatic Notebook Preparation ✅

Script: site/prepare_notebooks.sh
Integration: Runs automatically during make html
Process: Copies assignment notebooks to site/chapters/modules/
Result: Launch buttons appear on notebook pages

Build Commands ✅

make html - Includes notebook preparation
make pdf - Includes notebook preparation
make pdf-simple - Includes notebook preparation

✅ Paper Documentation Sync - COMPLETE

Files Created ✅

INSTRUCTOR.md - ✅ Created (matches paper reference)
MAINTENANCE.md - ✅ Created (support commitment through 2027)
TA_GUIDE.md - ✅ Created (common errors, debugging strategies)
docs/TEAM_ONBOARDING.md - ✅ Created (Model 3 documentation)
site/usage-paths/team-onboarding.md - ✅ Created (site version)

Files Verified ✅

CONTRIBUTING.md - ✅ Exists and matches paper description
docs/INSTRUCTOR_GUIDE.md - ✅ Exists (source for INSTRUCTOR.md)

Content Updates ✅

Module numbers: All updated to 01_tensor (not 01_setup)
Schedule: Updated to match current 20-module structure
Three integration models: All documented
Deployment environments: All documented

Getting Started Section ✅

Quick Start Guide
Student Workflow
For Instructors
Team Onboarding (newly added)

All Three Integration Models Accessible ✅

Self-Paced Learning - Quick Start Guide
Institutional Integration - For Instructors
Team Onboarding - Team Onboarding page

✅ Binder/Colab Setup - COMPLETE

Binder Configuration ✅

binder/requirements.txt - Dependencies
binder/postBuild - Installs TinyTorch
Launch buttons configured in site/_config.yml

Colab Configuration ✅

Launch buttons configured
Repository URL correct
Documentation complete

🎯 Pre-Launch Checklist

Required Actions

Generate Assignment Notebooks:
```
tito nbgrader generate --all
```
This creates notebooks for all modules in assignments/source/
Test Site Build:
```
cd site
make html
```
Verify:
- Notebooks are prepared automatically
- Launch buttons appear on notebook pages
- Site builds without errors
Test Binder:
- Visit: https://mybinder.org/v2/gh/mlsysbook/TinyTorch/main
- Verify build completes (2-5 minutes)
- Verify TinyTorch imports correctly
- Verify modules are accessible
Test Colab:
- Test with sample notebook
- Verify dependencies install
- Verify notebooks run correctly
Verify Documentation Links:
- Check all site navigation links work
- Verify INSTRUCTOR.md accessible
- Verify TA_GUIDE.md accessible
- Verify Team Onboarding page works

Optional Enhancements

Add sample solutions to INSTRUCTOR.md (if not already included)
Create common errors FAQ page
Add deployment guide consolidating JupyterHub/Colab/Local
Test with actual assignment notebooks

📊 Final Status

Component	Status	Ready for Launch
Assignment Generation	✅ Complete	✅ Yes
Site Build Integration	✅ Complete	✅ Yes
Paper Documentation	✅ Complete	✅ Yes
Site Navigation	✅ Complete	✅ Yes
Binder Setup	✅ Complete	⏳ Test needed
Colab Setup	✅ Complete	⏳ Test needed

🚀 Launch Steps

Generate assignment notebooks: tito nbgrader generate --all
Build site: cd site && make html
Test Binder: Visit Binder URL
Test Colab: Test with sample notebook
Verify all links work
LAUNCH! 🎉

Everything is synced and ready! Just need to generate notebooks and test launch buttons.

4.3 KiB Raw Blame History