mcpField
J
jupyter-notebook

jupyter-notebook

github.com/kilo-org数据与数据库081 次安装19 周前更新
代码仓库

关于 jupyter-notebook

用于创建、编辑和验证可复现 Jupyter Notebook 的技能，适用于实验或教程。提供模板、脚手架脚本，以及安全编辑和执行的流程。

主要功能

  1. 01实验与教程工作流
  2. 02Notebook 模板与脚手架脚本
  3. 03检查单元格和元数据
  4. 04安全编辑现有 Notebook
  5. 05执行与验证指南

适用场景

  1. 01将分析笔记整理为 Notebook
  2. 02制作分步骤教程
  3. 03重构 Notebook 以提高可复现性

MCP 相关

该技能建议在 Notebook 操作中使用可用的 Jupyter MCP 工具。若工具不可用或操作失败，则改为手动编辑。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/kilo-org/skills --skill jupyter-notebook

安装后在 Claude Code 中输入/jupyter-notebook确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

assets/
experiment-template.ipynb
tutorial-template.ipynb
references/
experiment-patterns.md
manual-editing.md
notebook-structure.md
quality-checklist.md
tutorial-patterns.md
scripts/
new_notebook.py

详细介绍

Jupyter Notebook 技能

创建整洁、可复现的 Jupyter 笔记本，适用于两种主要模式：

  • 实验和探索性分析
  • 教程和教学型逐步讲解

优先使用随附的模板和辅助脚本，以保持结构一致并减少 JSON 错误。

适用场景

  • 从头创建新的 .ipynb 笔记本。
  • 检查笔记本单元格、输出、元数据、依赖项或执行状态。
  • 添加、删除、重新排序或编辑代码和 Markdown 单元格。
  • 执行笔记本、刷新已保存的输出或排查内核故障。
  • 创建或改进笔记本表格、图表和其他可视化内容。
  • 将粗略的笔记或脚本转换为结构化笔记本。
  • 重构现有笔记本，使其更具可复现性且更易浏览。
  • 构建供他人阅读或重新运行的实验或教程。

决策树

  • 如果请求偏探索性、分析性或以假设为导向，选择 experiment。
  • 如果请求偏教学性、循序渐进或面向特定受众，选择 tutorial。
  • 如果编辑现有笔记本，将其视为重构：保留原意并改进结构。

选择笔记本工具

在检查、编辑或执行笔记本之前，先检查是否有合适的 Jupyter MCP 工具可用。

  • 笔记本操作优先使用已连接的 Jupyter MCP 服务。
  • 如果 Jupyter MCP 不可用或 MCP 操作失败，请明确告知用户你将改用手动编辑笔记本。
  • 编辑原始笔记本 JSON 前，请遵循 references/manual-editing.md。
  • 对同一项更改，不要同时使用 MCP 和手动 JSON 编辑。

工作流程

  1. 明确意图。 确定笔记本类型：experiment 或 tutorial。 记录目标、受众，以及如何判断任务已完成。

  2. 根据模板搭建框架。 使用辅助脚本，避免手动编写原始笔记本 JSON。根据加载此技能时提供的基目录解析 scripts/new_notebook.py；不要假设此技能安装在项目的 .kilo 目录下。

python3 "<SKILL_BASE_DIR>/scripts/new_notebook.py" \
  --kind experiment \
  --title "Compare prompt variants" \
  --out "compare-prompt-variants.ipynb"

python3 "<SKILL_BASE_DIR>/scripts/new_notebook.py" \
  --kind tutorial \
  --title "Intro to embeddings" \
  --out "intro-to-embeddings.ipynb"

  1. 将笔记本内容拆分为简短、可运行的步骤。 每个代码单元格专注于一个步骤。 添加简短的 Markdown 单元格，说明目的和预期结果。 如果简短摘要即可满足需求，就避免生成冗长、嘈杂的输出。

  2. 应用合适的模式。 实验请遵循 references/experiment-patterns.md。 教程请遵循 references/tutorial-patterns.md。

  3. 安全地编辑现有笔记本。 保留笔记本结构；除非能让内容自上而下更连贯，否则不要调整单元格顺序。 优先进行有针对性的编辑，而非完全重写。 如果必须编辑原始 JSON，请遵循 references/manual-editing.md。

  4. 验证结果。 环境允许时，从头到尾运行笔记本。 如果无法执行，请明确说明，并指出如何在本地验证。 使用 references/quality-checklist.md 中的最终检查清单。

模板和辅助脚本

  • 模板位于 assets/experiment-template.ipynb 和 assets/tutorial-template.ipynb。
  • 辅助脚本会加载模板、更新标题单元格并写入笔记本。

临时文件和输出约定

  • 中间文件请使用系统临时目录，并在完成后删除。
  • 将最终笔记本保存在用户指定的位置；如果未指定位置，则保存在当前项目目录中。
  • 使用稳定且能清晰描述内容的文件名（例如，ablation-temperature.ipynb）。

依赖项（仅在需要时安装）

用于本地执行笔记本的可选 Python 包：

python3 -m pip install jupyterlab ipykernel

随附的框架搭建脚本仅使用 Python 标准库，无需额外依赖项。

环境

无需设置环境变量。

参考指南

  • references/experiment-patterns.md：实验结构与启发式方法。
  • references/tutorial-patterns.md：教程结构与教学流程。
  • references/notebook-structure.md：笔记本 JSON 结构。
  • references/manual-editing.md：Jupyter MCP 不可用时的手动编辑与执行备用方案。
  • references/quality-checklist.md：最终验证清单。

评论

支持 Markdown