Deepnote 是面向 AI 时代的数据笔记本

Deepnote 已被雅诗兰黛、SoundCloud、Statsig、Gusto 等公司的 50 多万名数据专业人士使用。

只需几秒钟即可开始使用 Deepnote：

npx @deepnote/convert notebook.ipynb # 这将转换笔记本并创建 notebook.deepnote

然后在 VS Code、Cursor 或 Windsurf 中打开你的 .deepnote 文件！

什么是 Deepnote？

Deepnote 是 Jupyter 的直接替代品。它使用功能更强大但仍然向后兼容的 Deepnote 内核，因此你可以在两者之间无缝切换，同时还增加了 AI 助手、简洁的用户界面、新的代码块类型以及原生数据集成。Deepnote 开源版为你提供了在本地工作所需的一切，随后你可以通过 Deepnote Cloud 将工作流程扩展到团队协作中。

为什么选择 Deepnote 开源版？

• 人类可读的格式： .deepnote YAML 格式用清晰、便于版本控制和人类阅读的结构替换了 .ipynb 混乱的 JSON 格式，适用于项目和笔记本。你可以将多个笔记本、集成和设置组织到一个 .deepnote 项目中，以获得更好的结构和协作。
• 基于块的架构： 使用 SQL、输入框、图表等块扩展笔记本的功能，而不仅仅是代码单元——所有这些都通过开源的 @deepnote/blocks 包进行定义和验证。
• 随时随地工作： 在 VS Code 或其他任何地方使用开源的 Deepnote Toolkit 在本地运行笔记本。当你希望与团队在同一笔记本上进行更强大的计算时，只需将你的项目拖放到 Deepnote Cloud 即可。
• 响应式笔记本执行： 当输入或数据发生变化时，依赖性块会自动重新运行，确保笔记本保持一致性和可重复性，无需手动执行。
• 开放且可扩展： 基于 Jupyter 内核构建，与你现有的笔记本完全兼容。
• 轻松转换： 使用开源的 @deepnote/convert CLI 和 API 将 .ipynb 笔记本转换为 .deepnote 项目，反之亦然。

你现在可以做什么？

这个开源仓库允许你在自己喜欢的 AI 原生代码编辑器中直接编辑和运行 Deepnote 笔记本：

• VS Code 扩展 - 在 Visual Studio Code 中提供完整的 Deepnote 支持
• Cursor 扩展 - 在 Cursor 中进行 AI 驱动的笔记本编辑
• Windsurf 扩展 - 在 Windsurf 中进行协作开发

路线图

你很快就可以：

• 将你熟悉的 Deepnote Cloud 用户界面带到本地运行
• 使用本地 AI 助手编辑笔记本
• 自行提供 AI 服务的密钥
• 运行自己的计算资源

Deepnote 与 Jupyter 的对比

Deepnote 在许多方面扩展了 Jupyter。以下是主要区别：

特性	Deepnote	Jupyter
设置	通过云端或本地安装零配置	需要本地安装
AI 功能	原生 AI 助手和 AI 代码补全	第三方扩展
版本控制	内置 Git 集成	手动 Git 流程
共享	通过链接分享	手动导出文件
计算	受管云计算	仅限本地资源
集成	原生数据库和 API 连接	需要手动配置

此仓库包含的内容

用于支持 Deepnote 笔记本、运行时和协作功能的可重用包和库。

@deepnote/blocks 用于处理 Deepnote 笔记本块的 TypeScript 类型和实用工具。

• 块类型定义：代码、SQL、文本、Markdown、输入、可视化、按钮、大数字、图片、分隔符
• Python 代码生成：将块转换为可执行的 Python 代码
• Markdown 转换：将文本块转换为 Markdown 格式或反之
• 输入块支持：文本、多行文本、复选框、下拉菜单、滑块、文件、日期和日期范围输入

@deepnote/convert 是一个 CLI 工具和库，用于在 Deepnote（.deepnote）与其他多种笔记本格式之间进行双向转换。

• 支持的格式：Jupyter（.ipynb）、Quarto（.qmd）、Percent（带有 # %% 的 .py）和 Marimo（带有 @app.cell 的 .py）
• 跨平台兼容：可以从 Google Colab、Amazon SageMaker、Kaggle 或 Azure ML 导入 Jupyter 笔记本（.ipynb），在本地编辑后再导出——往返过程中会保留所有特定于平台的元数据。
• CLI 工具：deepnote-convert 命令可用于批量转换
• 程序化 API：可在 Node.js/TypeScript 应用程序中使用
• 双向转换：任何格式 → Deepnote，以及 Deepnote → 任何格式（通过 --outputFormat 参数）

文件格式 提供了 .deepnote 和 .snapshot.deepnote 文件格式的完整规范，包括模式细节、块类型和快照管理。快照将输出与源代码分离，使 Git 历史更加整洁；而 contentHash 则提供了代码出处信息，验证每个输出是由哪段代码生成的。

Deepnote 用于学术研究

Deepnote Cloud 对 学生和教育工作者免费！您可以无限制地使用所有核心功能、云端计算资源以及实时协作工具，助力您的研究与教学工作。 如果您在研究中使用了 Deepnote，请按照以下格式引用：

@misc{deepnote,
    title = {Deepnote：人工智能时代的数据笔记本},
    author = {Deepnote 团队},
    year = {2025},
    url = {https://github.com/deepnote/deepnote},
    note = {开源的协作式数据科学笔记本平台}
}

了解更多： deepnote.com/education

需要帮助吗？

• 加入我们的 社区讨论区！
• 如需报告 bug 或提出功能需求，请 新建议题。
• 您也可以查看相关仓库的源代码：Deepnote VS Code 扩展 和 Deepnote 工具包。
• 访问我们的 文档 获取更多信息。
• 想体验低代码开发？请访问 Deepnote Cloud，并配合 Deepnote AI 助手使用。

贡献

我们非常欢迎外部贡献者！无论您是修复 bug、添加新功能，还是改进文档，您的贡献都将受到热烈欢迎。请参阅 CONTRIBUTING.md，或加入 我们的团队。

致谢

我们衷心感谢 Jupyter 社区以及过去十年来为开源笔记本做出贡献的所有人。Jupyter 在 2013 年推出时，为全球通过代码探索数据和分享想法设定了标准。Deepnote 正是在这一宝贵遗产的基础上发展起来的，并将其延伸至以 AI 为核心、强调协作的未来。这一切都离不开 Jupyter 打下的坚实基础，我们也为此感到自豪，并将继续为同一开放生态系统贡献力量。

---

Deepnote 快速上手指南

Deepnote 是专为 AI 时代打造的数据笔记本，作为 Jupyter 的现代化替代品，它提供了更强大的内核、原生 AI 代理支持、响应式执行以及人类可读的项目格式。本指南将帮助你快速在本地开始使用 Deepnote 开源工具。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Windows, macOS 或 Linux。
• Node.js：已安装 Node.js (推荐 LTS 版本)，用于运行转换工具。
• 代码编辑器：已安装以下任一支持 Deepnote 扩展的 AI 原生编辑器：
  • Visual Studio Code (VS Code)
  • Cursor
  • Windsurf
• Python 环境（可选但推荐）：用于执行笔记本中的代码单元格。

安装步骤

1. 安装编辑器扩展

根据你的首选编辑器，安装对应的 Deepnote 扩展以支持 .deepnote 文件格式：

• VS Code: 在扩展市场搜索 Deepnote 或访问 marketplace 链接 安装。
• Cursor / Windsurf: 在扩展面板中搜索 Deepnote 进行安装（基于 Open VSX Registry）。

2. 安装转换工具 (CLI)

Deepnote 提供命令行工具用于在传统的 Jupyter Notebook (.ipynb) 和 Deepnote 格式 (.deepnote) 之间进行双向转换。无需全局安装，可直接通过 npx 运行：

npx @deepnote/convert notebook.ipynb

注：该命令会将 notebook.ipynb 转换为 notebook.deepnote 文件。如果你需要批量处理或在脚本中使用，也可以全局安装：npm install -g @deepnote/convert。

基本使用

以下是从零开始运行一个 Deepnote 笔记本的最简流程：

第一步：转换现有笔记本（或创建新项目）

如果你已经有一个 Jupyter 笔记本，将其转换为 Deepnote 格式：

npx @deepnote/convert my_analysis.ipynb

执行后，当前目录下将生成 my_analysis.deepnote 文件（这是一个包含 YAML 配置和代码的人类可读格式）。

第二步：在编辑器中打开

启动你的代码编辑器（VS Code, Cursor 或 Windsurf），打开生成的 .deepnote 文件或整个项目文件夹。

• 编辑器会自动识别 Deepnote 格式。
• 你可以直接看到代码块、SQL 块、输入控件等结构化内容。

第三步：运行与编辑

• 运行代码：像在传统笔记本中一样，点击代码块旁边的运行按钮，或使用快捷键执行。Deepnote 内核支持响应式执行，当依赖数据变化时会自动更新相关块。
• AI 辅助：利用编辑器内置的 AI 功能（如 Cursor 的 Chat 或 Copilot）直接对 .deepnote 文件进行代码生成、解释或重构。
• 添加新块：除了代码块，你还可以轻松添加 SQL、图表、文本或输入控件块，所有块类型均由 @deepnote/blocks 定义。

第四步：同步回 Jupyter (可选)

如果你需要将修改后的笔记本分享回只使用 Jupyter 的同事，可以随时转换回去：

npx @deepnote/convert my_analysis.deepnote --outputFormat ipynb

这将生成更新后的 my_analysis.ipynb 文件，保留所有代码和输出元数据。