mcpField
O
openai-jupyter-notebook

openai-jupyter-notebook

github.com/trailofbitsデータ・データベース52276 回インストール15 週間前に更新
リポジトリ

openai-jupyter-notebook について

openai-jupyter-notebookは、実験やチュートリアル向けの再現可能なJupyterノートブックを作成・リファクタリングするエージェントスキルです。テンプレートと補助スクリプトで基本構成を整え、編集と検証の手順も示します。

主な機能

  1. 01実験ノートブックのひな型作成
  2. 02チュートリアルノートブックのひな型作成
  3. 03既存ノートブックのリファクタリング
  4. 04テンプレートと補助スクリプトの利用
  5. 05実行と品質チェックの手順

活用シーン

  1. 01分析メモを構造化ノートブックに整理
  2. 02段階的な教材用ノートブックの作成
  3. 03既存ノートブックの再現性向上

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/trailofbits/skills-curated --skill openai-jupyter-notebook

インストール後、Claude Code で/openai-jupyter-notebookを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
experiment-patterns.md
notebook-structure.md
quality-checklist.md
tutorial-patterns.md
scripts/
new_notebook.py

詳細

Jupyter Notebook スキル

次の2つの主な用途に向けて、読みやすく再現性のある Jupyter ノートブックを作成します。

  • 実験と探索的分析
  • チュートリアルと学習者向けの手順解説

構成を統一し、JSON のミスを減らすため、同梱のテンプレートとヘルパースクリプトを優先して使用してください。

使用する場面

  • 新しい .ipynb ノートブックを一から作成する。
  • ラフなメモやスクリプトを、構成の整ったノートブックに変換する。
  • 既存のノートブックをリファクタリングし、再現性と読みやすさを高める。
  • 他の人が読んだり、再実行したりする実験やチュートリアルを作成する。

判断基準

  • 依頼が探索的、分析的、または仮説主導の場合は、experiment を選択します。
  • 依頼が指導的、段階的、または特定の対象者向けの場合は、tutorial を選択します。
  • 既存のノートブックを編集する場合は、リファクタリングとして扱い、意図を保ちながら構成を改善します。

スクリプトとリファレンスは {baseDir}/ 以下にあります。

ワークフロー

  1. 意図を明確にします。 ノートブックの種類（experiment または tutorial）を特定します。 目的、対象者、完了の基準を確認します。

  2. テンプレートからひな形を作成します。 ヘルパースクリプトを使って、ノートブックの生の 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

  1. 小さく実行可能な手順でノートブックを埋めます。 各コードセルの内容は1つの手順に絞ります。 目的と期待される結果を説明する短い Markdown セルを追加します。 短い要約で十分な場合は、大量で冗長な出力を避けます。

  2. 適切なパターンを適用します。 実験では、references/experiment-patterns.md に従います。 チュートリアルでは、references/tutorial-patterns.md に従います。

  3. 既存のノートブックを編集する場合は、安全に作業します。 ノートブックの構成を保ち、上から下への流れが改善される場合を除き、セルの並べ替えは避けます。 全面的な書き換えより、対象を絞った編集を優先します。 生の JSON を編集する必要がある場合は、最初に references/notebook-structure.md を確認します。

  4. 結果を検証します。 環境が許す場合は、ノートブックを上から下まで実行します。 実行できない場合は、その旨を明記し、ローカルでの検証方法を説明します。 最終確認には references/quality-checklist.md のチェックリストを使用します。

テンプレートとヘルパースクリプト

  • テンプレートは assets/experiment-template.ipynb と assets/tutorial-template.ipynb にあります。
  • ヘルパースクリプトはテンプレートを読み込み、タイトルセルを更新して、ノートブックを書き出します。

スクリプトのパス：

  • $JUPYTER_NOTEBOOK_CLI（インストール時の既定値：{baseDir}/scripts/new_notebook.py）

一時ファイルと出力の規則

  • 中間ファイルには tmp/jupyter-notebook/ を使用し、作業後に削除します。
  • このリポジトリで作業する場合、最終成果物は output/jupyter-notebook/ 以下に保存します。
  • 安定した、内容が分かるファイル名を使用します（例：ablation-temperature.ipynb）。

依存関係（必要な場合にのみインストール）

依存関係の管理には uv を優先して使用します。

ノートブックをローカルで実行する場合に任意で使える Python パッケージ：

uv pip install jupyterlab ipykernel

同梱のひな形作成スクリプトは Python 標準ライブラリのみを使用し、追加の依存関係は必要ありません。

環境

必須の環境変数はありません。

リファレンス一覧

  • references/experiment-patterns.md：実験の構成と経験則。
  • references/tutorial-patterns.md：チュートリアルの構成と指導の流れ。
  • references/notebook-structure.md：ノートブックの JSON 形式と安全な編集規則。
  • references/quality-checklist.md：最終検証用チェックリスト。

使用しない場面

コメント

Markdown 対応