SuperAPI AI 工具集

openai-jupyter-notebook

编程与开发

查看项目

更新于 10-16 01:14

技能介绍

用途:创建干净、可复现的 Jupyter Notebook,主要覆盖实验与探索性分析,以及教学向的教程讲解两类模式。可新建 .ipynb、把粗略笔记或脚本转为结构化笔记本、重构已有笔记本使其更可复现易读,以及构建供他人阅读或复跑的实验与教程。

选择方式:若需求偏探索、分析或假设驱动,选实验模式;若偏教学、分步或面向特定读者,选教程模式;若编辑已有笔记本,按重构处理,保留原意并改进结构。脚本与参考资料位于 {baseDir}/。

流程:先锁定意图(笔记本类型、目标、读者与完成标准);用辅助脚本从模板搭建,避免手写原始 JSON,例如: uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" --kind experiment --title "Compare prompt variants" --out output/jupyter-notebook/compare-prompt-variants.ipynb 教程模式将 --kind 换为 tutorial。随后用小而可运行的步骤填充,每个代码单元聚焦一步,配简短 markdown 说明用途与预期结果,避免大而嘈杂的输出。实验遵循 references/experiment-patterns.md,教程遵循 references/tutorial-patterns.md。编辑已有笔记本时保留结构、优先局部修改,必要时先看 references/notebook-structure.md。最后做校验,环境允许时自顶向下运行,无法运行需明确说明并指出本地验证方式,并对照 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/,文件名保持稳定描述性。依赖按需安装,优先用 uv,可选 uv pip install jupyterlab ipykernel;脚手架脚本仅用标准库。无必需环境变量。资料未提供“何时不使用”的完整内容。