notebook-ta

notebook-ta adds an LLM-powered teaching assistant to Jupyter notebooks for Python programming courses. Students work with the %%notebook_ta cell magic, while instructors define exercises, tests, and tutor prompts in TOML files.

User Guide

• Configuration Reference
  • File Overview
  • global_config.toml
  • exercises.toml
  • Example
• Authoring Exercises
  • Exercise Structure
  • Writing Unit Tests
  • Exercise-Level Prompt Overrides
  • Embedding Statements in the Notebook
  • Complete Example
  • Tips
• Prompt/Model Benchmarking Tool
  • Launching
  • Workflow
  • Project files
• Release Process

Reference

• API Reference
  • load()
  • get_registry()

Quick Start

Install the package:

pip install notebook-ta

Load the teaching assistant from a notebook setup cell:

import notebook_ta

notebook_ta.load("global_config.toml", "exercises.toml")

Use the magic in a student answer cell:

%%notebook_ta ex1
def add(a, b):
    return a + b

See the example configuration and notebook files in docs/examples.