Jupyter Notebook

Jupyter Notebook திறன்

Create clean, reproducible Jupyter notebooks for two primary modes:

• பரிசோதனைகள் மற்றும் ஆராய்ச்சிசார் பகுப்பாய்வு
• பயிற்சி மற்றும் கற்பித்தலுக்கு மையமாகிய நடைமுறை விளக்கங்கள்

Prefer the bundled templates and the helper script for consistent structure and fewer JSON mistakes.

When to use

• Create a new .ipynb notebook from scratch.
• Convert rough notes or scripts into a structured notebook.
• Refactor an existing notebook to be more reproducible and skimmable.
• Build experiments or tutorials that will be read or re-run by other people.

Decision tree

• If the request is exploratory, analytical, or hypothesis-driven, choose experiment.
• If the request is instructional, step-by-step, or audience-specific, choose tutorial.
• If editing an existing notebook, treat it as a refactor: preserve intent and improve structure.

Skill path (set once)

export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
export JUPYTER_NOTEBOOK_CLI="$CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py"

User-scoped skills install under $CODEX_HOME/skills (default: ~/.codex/skills).

Workflow

1. Lock the intent. Identify the notebook kind: experiment or tutorial. Capture the objective, audience, and what "done" looks like.

2. Scaffold from the template. Use the helper script to avoid hand-authoring raw notebook JSON.

uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
  --kind experiment \
  --title "Compare prompt variants" \
  --out output/jupyter-notebook/compare-prompt-variants.ipynb

uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" \
  --kind tutorial \
  --title "Intro to embeddings" \
  --out output/jupyter-notebook/intro-to-embeddings.ipynb

3. Fill the notebook with small, runnable steps. Keep each code cell focused on one step. Add short markdown cells that explain the purpose and expected result. Avoid large, noisy outputs when a short summary works.

4. Apply the right pattern. For experiments, follow references/experiment-patterns.md. For tutorials, follow references/tutorial-patterns.md.

5. Edit safely when working with existing notebooks. Preserve the notebook structure; avoid reordering cells unless it improves the top-to-bottom story. Prefer targeted edits over full rewrites. If you must edit raw JSON, review references/notebook-structure.md first.

6. Validate the result. Run the notebook top-to-bottom when the environment allows. If execution is not possible, say so explicitly and call out how to validate locally. Use the final pass checklist in references/quality-checklist.md.

Templates and helper script

• Templates live in assets/experiment-template.ipynb and assets/tutorial-template.ipynb.
• The helper script loads a template, updates the title cell, and writes a notebook.

Script path:

• $JUPYTER_NOTEBOOK_CLI (installed default: $CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py)

Temp and output conventions

• Use tmp/jupyter-notebook/ for intermediate files; delete when done.
• Write final artifacts under output/jupyter-notebook/ when working in this repo.
• Use stable, descriptive filenames (for example, ablation-temperature.ipynb).

Dependencies (install only when needed)

Prefer uv for dependency management.

Optional Python packages for local notebook execution:

uv pip install jupyterlab ipykernel

The bundled scaffold script uses only the Python standard library and does not require extra dependencies.

Environment

No required environment variables.

Reference map

• references/experiment-patterns.md: பரிசோதனை கட்டமைப்பு மற்றும் அனுபவவியல்.
• references/tutorial-patterns.md: பயிற்சி கட்டமைப்பு மற்றும் கற்பித்தல் ஓட்டம்.
• references/notebook-structure.md: நோட்புக் JSON வடிவம் மற்றும் பாதுகாப்பான திருத்த விதிகள்.
• references/quality-checklist.md: இறுதி சரிபார்ப்பு பட்டியல்.

மறுப்புரை: இந்த ஆவணம் AI மொழிபெயர்ப்பு சேவை Co‑op Translator (https://github.com/Azure/co-op-translator) பயன்படுத்தி மொழிபெயர்க்கப்பட்டது. நாங்கள் துல்லியத்திற்காக முன்னெச்சரிக்கை காட்டினாலும்கூட, தானாக செய்யப்படும் மொழிபெயர்ப்புகளில் பிழைகள் அல்லது துல்லியக்குறைவுகள் இருக்கலாம் என்பதைக் கவனத்தில் கொள்ளவும். அதன் மூல மொழியில் உள்ள அசல் ஆவணத்தை அதிகாரப்பூர்வ ஆதாரமாக கருதவேண்டும். முக்கியமான தகவல்களுக்கு, தொழில்முறை மனித மொழிபெயர்ப்பை பயன்படுத்த பரிந்துரைக்கப்படுகிறது. இந்த மொழிபெயர்ப்பைப் பயன்படுத்துவதால் ஏற்படும் எந்தவொரு தவறான புரிதலிற்கும் அல்லது தவறாக விளக்கப்படுவதற்குமான பொறுப்பும் நாங்கள் ஏற்கமாட்டோம்.