mirror of https://github.com/MLSysBook/TinyTorch.git synced 2026-03-10 00:41:58 -05:00

Files

Vijay Janapa Reddi d03435c5c3 Update documentation for site/ migration and restructuring

Documentation updates across the codebase:

Root documentation:
- README.md: Updated references from book/ to site/
- CONTRIBUTING.md: Updated build and workflow instructions
- .shared-ai-rules.md: Updated AI assistant rules for new structure

GitHub configuration:
- Issue templates updated for new module locations
- Workflow references updated from book/ to site/

docs/ updates:
- STUDENT_QUICKSTART.md: New paths and structure
- module-rules.md: Updated module development guidelines
- NBGrader documentation: Updated for module restructuring
- Archive documentation: Updated references

Module documentation:
- modules/17_memoization/README.md: Updated after reordering

All documentation now correctly references:
- site/ instead of book/
- modules/XX_name/ instead of modules/source/

2025-11-10 19:42:48 -05:00

2.8 KiB

Raw Permalink Blame History

📋 NBGrader Quick Reference Card

TinyTorch + NBGrader Essential Commands for Instructors

🚀 One-Time Setup

# 1. Setup environment
python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

# 2. Initialize NBGrader
./bin/tito nbgrader init

# 3. Verify setup
./bin/tito system doctor

📝 Weekly Assignment Workflow

Monday: Release New Assignment

# Generate assignment from TinyTorch module
./bin/tito nbgrader generate 03_activations

# Create student version
./bin/tito nbgrader release 03_activations

# Upload assignments/release/03_activations/03_activations.ipynb to LMS

Friday: Grade Submissions

# After downloading student submissions to assignments/submitted/
./bin/tito nbgrader autograde 03_activations
./bin/tito nbgrader feedback 03_activations

# Return assignments/feedback/ files to students

🔧 Essential Commands

Status & Monitoring

./bin/tito module status --comprehensive    # System health
./bin/tito nbgrader status                  # Assignment status
./bin/tito nbgrader analytics MODULE_NAME   # Student progress

Batch Operations

./bin/tito nbgrader generate --all          # All assignments
./bin/tito nbgrader generate --range 01-04  # Module range
./bin/tito nbgrader autograde --all         # Grade everything
./bin/tito nbgrader feedback --all          # Generate all feedback

Export & Cleanup

./bin/tito nbgrader report --format csv     # Export gradebook
./bin/tito clean                            # Clean temp files

📁 Directory Structure

assignments/
├── source/        # Generated assignments (git tracked)
├── release/       # Student versions (git tracked)
├── submitted/     # Student submissions (git ignored)
├── autograded/    # Graded submissions (git ignored)
└── feedback/      # Student feedback (git ignored)

🆘 Quick Troubleshooting

# Environment issues
source .venv/bin/activate
./bin/tito system doctor

# Module not found
ls modules/                          # Check available modules
./bin/tito nbgrader generate 02_tensor      # Use exact name

# Validation failures (normal for student notebooks)
# Students have unimplemented functions = expected behavior

📚 Course Planning

17 TinyTorch Modules:

00-02: Foundation (intro, setup, tensors)
03-07: Building Blocks (activations, layers, dense, spatial, attention)
08-11: Training (dataloader, autograd, optimizers, training)
12-16: Production (compression, kernels, benchmarking, mlops, capstone)

Recommended Pacing: 1 module per week = 16-week semester

📖 For complete details: See Instructor Guide

2.8 KiB Raw Permalink Blame History