notebook-standards

Notebook Structure Standards

Patterns for Jupyter notebook creation.

Checklist task (MANDATORY when the notebook changes)

Writing or modifying a notebook - TaskCreate one task BEFORE the first cell, carrying the checklist inside it:

• subject - Verify <notebook path> against post-write checklist
• description - the Post-write checklist at the end of this file, verbatim, all 17 boxes
• activeForm - Verifying notebook against standards

Complete it only once every box is ticked or explicitly n/a.

• Description carries the boxes so this file need not stay in context - a long build fills the window and gets compacted, taking the checklist with it; TaskGet returns the description on demand
• Register up front, never at the end - the checklist sits at the end of this file, exactly where an agent deep in a build never returns. An open task survives the whole build; a rule below the fold does not
• Only when the notebook changes - a question about a rule (a colormap, an equation form, a colour name) writes no notebook and creates no task
• One task, not one per box - the 17 boxes are its definition of done

Mandatory Section Order

1. Header - mandatory title + author + date + purpose, then an optional problem-specific menu (see below)
2. GPU Selection - CUDA_VISIBLE_DEVICES before any torch/tf/jax import
3. Imports - one cell, grouped, inline comments, autoreload
4. Reproducibility - set_seed(42) for random, numpy, torch
5. Configuration - hyperparameters in one cell, inline comments, Rich render at the end
6. Data Loading
7. Model/Processing
8. Execution (training, inference)
9. Save/Export
10. Evaluation/Summary

Header (first markdown cell)

Orients the reader and doubles as the notebook's own overview, so the Header needs no separate one. Title, author, date and purpose are mandatory; the rest is a menu - pick what fits, drop what does not. Mirrorable template: examples/header-cell.md.