jupyter-notebook

Kỹ năng Jupyter Notebook

Tạo các sổ tay Jupyter sạch sẽ, có khả năng tái tạo cho hai chế độ chính:

• Thí nghiệm và phân tích khám phá
• Hướng dẫn và các bài hướng dẫn theo từng bước phục vụ giảng dạy

Ưu tiên sử dụng các mẫu đi kèm và script trợ giúp để có cấu trúc nhất quán và ít lỗi JSON hơn.

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. Xác định rõ ý định. 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 (được cài đặt mặc định: $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: cấu trúc thí nghiệm và các quy tắc kinh nghiệm.
• references/tutorial-patterns.md: cấu trúc hướng dẫn và luồng giảng dạy.
• references/notebook-structure.md: cấu trúc JSON sổ tay và các quy tắc chỉnh sửa an toàn.
• references/quality-checklist.md: danh sách kiểm tra xác thực cuối cùng.

---

Miễn trừ trách nhiệm: Văn bản này đã được dịch bằng dịch vụ dịch thuật AI Co-op Translator (https://github.com/Azure/co-op-translator). Mặc dù chúng tôi nỗ lực để đảm bảo độ chính xác, xin lưu ý rằng các bản dịch tự động có thể chứa lỗi hoặc sai sót. Tài liệu gốc bằng ngôn ngữ ban đầu nên được coi là nguồn chính thức. Đối với những thông tin quan trọng, nên nhờ dịch thuật viên chuyên nghiệp. Chúng tôi không chịu trách nhiệm về bất kỳ hiểu lầm hoặc diễn giải sai nào phát sinh từ việc sử dụng bản dịch này.