如何在VSCode中为Jupyter Notebook添加标签以适配papermill？

方案1：手动编辑元数据适配papermill #

.ipynb文件本质为JSON格式，无需依赖GUI的元数据编辑功能，可直接手动修改实现papermill识别：

• 在VSCode资源管理器中右键目标.ipynb文件，选择「打开方式」→「文本编辑器」，查看文件原始JSON结构
• 定位到你要设置为参数单元格的对应条目，在其metadata字段中添加"tags": ["parameters"]
• 保存后切回Notebook视图即可正常编辑，papermill运行时可自动识别该参数单元格

方案2：通过命令行直接传参跳过元数据要求 #

无需修改Notebook元数据，运行papermill时直接通过命令行参数注入参数即可：

papermill 输入Notebook路径.ipynb 输出Notebook路径.ipynb -p 参数名1 参数值1 -p 参数名2 参数值2

该方式完全不依赖Notebook内部的元数据配置，可正常完成参数化运行。

替代方案：使用nbparameterise实现参数化 #

如果不想使用papermill，可选择轻量库nbparameterise实现同等的Notebook参数化功能：

1. 首先安装依赖：

pip install nbparameterise

2. 编写简单的执行脚本即可完成参数替换运行：

import nbformat
from nbparameterise import extract_parameters, parameter_values, replace_definitions

# 加载目标Notebook
nb = nbformat.read("待运行Notebook路径.ipynb", as_version=4)
# 提取Notebook首个代码单元格的变量作为默认参数
default_params = extract_parameters(nb)
# 自定义替换参数值
run_params = parameter_values(default_params, batch_size=64, lr=0.001, epoch=20)
# 替换Notebook中的参数定义
updated_nb = replace_definitions(nb, run_params)
# 保存运行后的Notebook
nbformat.write(updated_nb, "运行结果输出路径.ipynb")

以上方案均兼容VSCode 1.60.2、VSCode Insiders 1.61.0版本以及Windows 10系统，无需额外安装不兼容的扩展。

内容的提问来源于stack exchange，提问作者Antonio Sesto