Pretzel 🥨

现代化的开源 Jupyter 替代方案。
立即体验 »

Discord · 官网 · 问题追踪 · 联系我们

https://github.com/pretzelai/pretzelai/assets/121360087/ff4643b1-c931-410e-aa0b-9233e0766223

Pretzel 是 Jupyter 的一个分支项目，旨在增强 Jupyter 的功能。目前，我们已经为 Jupyter 添加了 AI 代码生成与编辑、内联 Tab 补全、侧边栏聊天以及错误修复等功能，并且未来还将推出更多新特性。

从 Jupyter 切换到 Pretzel 非常简单，因为它只是 Jupyter 的一个改进版本。您现有的 Jupyter 配置、设置、快捷键绑定和扩展都将开箱即用。

快速开始

• 安装：运行 pip install pretzelai，然后执行 pretzel lab 即可打开 Web 界面。或者，您也可以使用我们的免费托管版本：pretzelai.app
  • 如果在安装过程中遇到错误，请参阅此处。
• 在单元格中直接输入内容即可获得内联 Tab 补全提示。
• 在任意 Jupyter 单元格中，点击“Ask AI”或按下 Cmd+K（Mac）/ Ctrl+K（Linux/Windows）来调用 AI 助手。
• 使用 AI 侧边栏，通过 Ctrl+Cmd+B（Mac）或 Ctrl+Alt+B（Linux/Windows）打开，与 AI 聊天、生成代码并提问。
• 输入 @ 可触发函数和变量名的自动补全。
• 若要使用您自己的模型（OpenAI、Anthropic/Claude、Ollama 或 Groq），请参阅配置部分。

---

我们的路线图包括构建以下功能：

• 原生 AI 代码生成与理解功能，类似于 Cursor；
• 无缝实时协作：结对编程、评论、版本历史等；
• SQL 支持（既可在代码单元格中使用，也可作为独立的 SQL IDE）；
• 可视化分析构建器（详情请参见这里)；
• 类似 VSCode 的代码编写体验，基于 Monaco 编辑器；
• 从 Jupyter 笔记本一键创建和分享仪表板。

安装

使用 pip

通过 pip 安装 Pretzel：

pip install pretzelai

对于 conda 用户，请先运行 conda install pip 安装 pip，然后再执行 pip install pretzelai。

安装完成后，启动 Pretzel：

pretzel lab

您将可以通过提供的 URL 访问 Pretzel 界面。

如需使用自定义 AI 模型，请参阅配置部分。

在 Docker 容器中运行

如果您在安装 Pretzel 时遇到困难（例如在 Windows 上），可以将其部署到 Docker 容器中运行。

1. 创建 Dockerfile：

FROM python:3.9-slim
RUN apt-get update && apt-get install -y \
    build-essential \
    gcc \
    && rm -rf /var/lib/apt/lists/*
WORKDIR /root/pretzel
RUN pip install pretzelai
EXPOSE 8888
CMD ["pretzel", "lab", "--ip=0.0.0.0", "--allow-root", "--notebook-dir=/root/pretzel", "--ServerApp.allow_remote_access=True", "--ServerApp.token=''", "--no-browser"]

2. 在包含 Dockerfile 的同一目录下，运行 docker build -t pretzel .。

3. 启动 Pretzel 容器：docker run --name pretzel -p 8888:8888 pretzel。容器启动后，您可以通过 http://localhost:8888/lab 访问界面。要停止容器，按 Ctrl + C，然后执行 docker stop pretzel。

若希望在 Pretzel 中访问本地文件夹，可以运行：docker run --rm -p 8888:8888 -v $(pwd):/root/pretzel pretzel。这会将您当前目录映射到容器内的 /root/pretzel 文件夹。请确保 Docker 具有访问您当前目录的权限。

要将 Pretzel 更新至最新版本，只需使用 --no-cache 标志重新构建镜像：docker build --no-cache -t pretzel .，然后按照步骤 3 启动容器即可。

极限测试版

您可以使用此 Dockerfile 来构建并运行极限测试版。请按照在 Docker 容器中运行一节中的步骤（从第 2 步开始）操作。

安装问题

如果在安装过程中出现类似以下的错误：

Failed to build installable wheels for some pyproject.toml based projects (pystemmer)

这意味着安装未能成功安装依赖项 PyStemmer。通常这是因为您尚未安装正确的编译工具。解决方法如下：

• Windows：从此处下载并安装 Microsoft Build Tools。点击“Download Build Tools”按钮进行安装。
• Ubuntu（及 Debian 系列系统）：在终端中运行以下命令以安装必要的编译工具：

  sudo apt-get update && sudo apt-get install build-essential python3-dev
  

• macOS：运行 brew install gcc。如果仍无法解决问题，可能还需要运行 xcode-select --install。

完成上述操作后，您应该能够顺利执行 pip install pretzelai 来安装 Pretzel。

使用方法

内联补全

• 在单元格中开始输入即可获得内联补全建议
• 等待1秒以触发补全。您会在单元格中蓝色的“Ask AI”按钮前看到一个小加载动画

默认的Pretzel AI服务器使用Mistral的Codestral，但您可以在Pretzel AI设置中切换内联补全模型。请参阅配置部分。

在笔记本单元格中生成和编辑代码

• 在单元格中，按下**Cmd+K（Mac）/ Ctrl+K（Windows/Linux）或点击“Ask AI”**以打开AI提示文本框，并写下您的代码生成/编辑指令
  • 输入@可弹出当前会话中可用变量的下拉菜单。将@变量添加到提示中会将其值发送给AI
  • 我们会自动将当前笔记本中的相关代码作为上下文发送给AI
• 如果单元格中已有代码，提示将编辑现有代码
  • 如果您在单元格中选择或高亮显示部分代码，则仅该部分代码会被编辑
• 您可以接受或拒绝AI的回答，也可以修改提示后重新提交
• 使用↑/↓键可在提示历史中循环浏览

使用AI侧边栏

• 使用**Ctrl+Cmd+B（Mac）/ Ctrl+Alt+B（Linux/Windows）**或右侧边栏上的Pretzel图标来激活AI侧边栏
• 您可以提问、生成代码或搜索现有代码
• AI始终以活动单元格中的代码作为上下文。如果您在活动单元格中高亮显示部分代码，则仅该部分代码会被用作上下文
• 我们会自动将当前笔记本中的相关代码作为上下文发送给AI
• 您还可以使用@语法引用内存中的变量和数据框，与笔记本单元格中的用法类似

AI侧边栏的使用示例：

• “将函数my_function修改得更高效” ← 这将在整个笔记本中找到my_function并对其进行修改
• “哪里有去除异常值的代码？” ← 这将在笔记本中搜索去除异常值的代码并显示给您
• (光标位于包含代码的单元格时) “你能解释一下这段代码的作用吗？” ← 这将解释当前单元格中的代码
• “为@df绘制年龄的直方图” ← 这将生成代码，绘制名为‘df’的数据框中‘年龄’列的直方图
• “计算@salesdata中每种产品的平均收入” ← _这将生成代码，使用sales_data数据框按产品类型计算平均收入

在现有代码中间插入代码

• 将光标置于空行或现有代码行上。通过Cmd+K调出AI提示文本框
• 提示开头使用单词inject或ij（不区分大小写）——这会告诉AI只添加新代码，而不编辑单元格中的现有代码
• 代码将被添加到光标所在位置的下一行

使用AI修复错误

• 当出现错误时，您会在右上角看到一个“使用AI修复错误”的按钮。点击它即可尝试修复错误。

配置

Pretzel开箱即用，无需任何配置。我们不会存储您发送到Pretzel AI服务器的任何代码或数据。

尽管如此，如果您想使用不同的AI模型，可以配置Pretzel以**使用来自多个不同供应商的AI模型，包括本地模型。**在这种情况下，AI请求将直接从您的计算机发送到AI服务提供商（如OpenAI、Anthropic等）。

• 打开顶部菜单栏中的“设置”菜单，然后点击“Pretzel AI设置”
• 在AI设置中，您可以选择用于聊天和内联补全的AI模型（见下方截图）
  • 我们建议使用GPT-4级别的模型（例如GPT-4 Turbo、GPT-4o、Claude-3.5 Sonnet、Claude-3 Opus以及Llama-3.1 405B），以获得最佳性能

在配置AI服务部分，您可以

• 启用或禁用某些AI服务（例如，Azure和Ollama默认是禁用的，但可以启用）
• 根据需要为每个服务输入API密钥或URL

请务必在更改设置后保存。Pretzel会验证您的配置，以确保一切设置正确。

请注意：我们尚未测试过_Azure Enterprise OpenAI_模型。如果您发现任何问题，请在Github问题页面上报，我们会尽快修复。

反馈、Bug报告及文档

• 请在此处报告Bug：https://github.com/pretzelai/pretzelai/issues
• 您有任何反馈或意见吗？我们非常期待您的反馈：founders@withpretzel.com

Jupyter特定信息

Jupyter的原始文档可在这里找到， 而Jupyterlab的README可在这里查看。

隐私政策、数据收集与保留

我们不会收集任何个人信息。我们仅对我们开发的AI功能使用基本遥测数据——例如，当您点击“Ask AI”时，我们会收到一条事件，表明“有人”点击了“Ask AI”。我们只会为您的用户关联一个匿名ID。如果您允许使用Cookie，这有助于我们在多个浏览器会话中识别出同一用户（这一点非常有用！）。如果您不允许使用Cookie，每次打开浏览器时，您对我们来说都是一个新的匿名用户。

我们还会收集AI功能的提示内容（但不包括响应）。您可以在设置中关闭此功能（设置 > Pretzel AI > 取消勾选“提示遥测”），但我们非常希望您不要关闭它——这对改进我们的提示非常有帮助。

我们绝不会收集任何代码。即使您使用Pretzel的云端AI服务器进行代码补全，我们也绝不会存储这些代码。

如果您使用Pretzel的托管版本（https://pretzelai.app），我们将根据您的电子邮件地址为您创建一个用户账户。您随时可以登录并删除您可能存储在我们托管服务器上的任何数据。我们不会对您的数据进行备份或复制。

我们的托管服务器可免费使用。不过，我们会在您上次登录后的30天后删除您的数据和账户。如果您希望提前删除账户，请发送邮件至founders@withpretzel.com，主题注明“账户删除”，我们将立即为您删除账户。

常见问题解答

问： Pretzel AI 的旧版本——那个基于浏览器的可视化数据处理工具——现在怎么样了？

答： 它仍然可以在 这里的 pretzelai_visual 文件夹 中找到。更多信息请参阅 这篇 PR。

问： Pretzel 使用哪种 AI 模型？

答： Pretzel 根据不同任务使用不同的 AI 模型：

1. 默认模型：GPT-4o

   • 在速度和质量之间提供了良好的平衡
   • 如果您使用自己的 API 密钥，可以在 Pretzel 设置中更改此模型

2. 内联补全：Mistral 的 Codestral 模型

   • 非常适合代码补全
   • 性能极快（220 亿参数模型）

3. 备用选项：

   • 如果您使用自己的 API 密钥但未提供 Mistral API 密钥，Pretzel 也会使用 GPT-4o 进行内联补全

我们仍在不断尝试不同的模型，并计划支持本地模型，Anthropic 的 Claude 也在我们的优先考虑之列。

问： 功能 X 呢？

答： 我们想实现的功能还有很多。请 提交一个问题，告诉我们您希望我们开发哪些功能吧！

问： 路线图在哪里？

答： 我们在本 README 的顶部有一个大致的路线图。我们有很多想要实现的功能，但目前只有我们两个人在做。因此，我们正在收集关于哪些功能最实用的反馈。请提交一个问题，或者直接给我们发邮件提出您的建议！我们会根据收到的反馈来确定路线图的优先级。

问： 为什么你们使用 AGPL 许可证？为什么不使用 MIT 或 BSD-3 许可证呢？

答： 我们开发 Pretzel 的目标是打造一款出色的数据工具，供个人和公司免费使用。然而，我们是一家只有两个人的小型初创公司，不希望第三方仅仅拿走我们的代码，然后将其托管并出售，而不回馈社区。Jupyter 的代码采用 BSD-3 许可证，如果我们也将新代码保持为 BSD-3 许可证，就无法阻止第三方这样做。因此，我们决定对所有新代码采用 AGPLv3 许可证。这确保了如果有人确实想拿走我们的代码并进行销售（无论是 SaaS 还是其他形式），他们也必须将所有修改后的代码以 AGPLv3 开源。

问： 为什么选择分叉 Jupyter？为什么不直接为 Jupyter 做贡献呢？

答： 这个问题需要更详细的回答，但简而言之：我们立志打造 新的、事实上的现代开源数据工具。最初，我们曾打算从头开始开发。然而，在与多位数据专业人士交流后，我们意识到，无论新工具多么优秀，让人们切换到它都非常困难。最好的方式就是让人们根本不需要切换。这就是我们决定分叉 Jupyter 的原因——这样切换成本几乎为零。此外，Jupyter 已经是一个成熟的产品，而我们开发功能的速度非常快，坦率地说，按照我们目前的开发节奏，我们编写的代码很可能不会被接受进入 Jupyter 的代码库 😅。当然，这个决定也有许多缺点——我们不得不花费大量时间去理解整个 Jupyter 生态系统及其多个代码库、复杂的发布流程以及各种 API 等等。不过，我们认为这对我们的项目来说是正确的选择。

问： 我的公司担心使用 AGPLv3 许可证的工具。我该怎么办？

答： AGPL 许可证只会在以下情况下构成限制：您对 Pretzel 进行了修改，并且将修改后的版本重新发布给公众。如果您只是在公司内部将它作为工具使用（即使进行了修改），AGPL 并不要求您公开自己的代码。尽管如此，如果您仍然对 AGPL 存在顾虑，请联系我们，我们可以一起探讨一个可行的解决方案。

问： 你们打算如何盈利？或者说，为什么它是免费的？我担心将来会变成收费工具。

答： 我们计划向企业销售该工具的托管版本以获取收入。这个托管版本可能会包含一些个人用户不需要或不感兴趣的特定于企业的功能，例如数据访问控制、数据源连接器、与 GitHub 的集成、托管且可共享的仪表板、用于大型数据作业的可扩展按需计算等。我们绝不会追溯性地将 Pretzel 的个人版变为付费版本。

PretzelAI 快速上手指南

PretzelAI 是一个现代化的开源 Jupyter 替代方案，它在保留 Jupyter 所有配置、快捷键和扩展兼容性的基础上，原生集成了 AI 代码生成、行内补全、侧边栏对话及错误修复功能。

环境准备

• 操作系统：Windows, macOS, Linux (Ubuntu/Debian)
• Python 版本：推荐 Python 3.8 及以上
• 前置依赖：
  • 需安装 pip 包管理工具。
  • 构建工具（若安装报错缺少编译环境）：
    • Windows: 安装 Microsoft C++ Build Tools
    • Ubuntu/Debian: 运行 sudo apt-get update && sudo apt-get install build-essential python3-dev
    • macOS: 运行 brew install gcc (若无效则运行 xcode-select --install)
• 可选：Docker（适用于无法直接安装依赖的环境）

安装步骤

方法一：使用 pip 安装（推荐）

1. 打开终端或命令行工具，执行以下命令安装：

   pip install pretzelai
   

   (注：国内用户若下载缓慢，可添加国内镜像源，例如：pip install pretzelai -i https://pypi.tuna.tsinghua.edu.cn/simple)

2. 安装完成后，启动 Pretzel 实验室界面：

   pretzel lab
   

3. 浏览器将自动打开，或手动访问终端中提供的 URL（通常为 http://localhost:8888/lab）。

方法二：使用 Docker 运行

若本地环境配置困难，可使用 Docker 容器运行：

1. 创建 Dockerfile：

   FROM python:3.9-slim
   RUN apt-get update && apt-get install -y \
       build-essential \
       gcc \
       && rm -rf /var/lib/apt/lists/*
   WORKDIR /root/pretzel
   RUN pip install pretzelai
   EXPOSE 8888
   CMD ["pretzel", "lab", "--ip=0.0.0.0", "--allow-root", "--notebook-dir=/root/pretzel", "--ServerApp.allow_remote_access=True", "--ServerApp.token=''", "--no-browser"]
   

2. 构建镜像：

   docker build -t pretzel .
   

3. 运行容器（映射当前目录以便访问本地文件）：

   docker run --rm -p 8888:8888 -v $(pwd):/root/pretzel pretzel
   

   启动后访问 http://localhost:8888/lab。

基本使用

Pretzel 完全兼容 Jupyter 操作习惯，无需额外配置即可使用默认 AI 功能（基于 Mistral Codestral）。

1. 行内代码补全 (Inline Tab Completion)

• 操作：在单元格中开始输入代码。
• 效果：等待约 1 秒，系统将自动显示灰色的行内补全建议。按 Tab 键接受建议。
• 变量提示：输入 @ 符号可触发当前会话中变量和数据框的名称自动补全。

2. AI 代码生成与编辑

• 唤起方式：在任意单元格中按下 Cmd+K (Mac) 或 Ctrl+K (Linux/Windows)，或点击单元格上方的 "Ask AI" 按钮。
• 生成代码：在空白单元格中输入自然语言指令（如“绘制 df 的年龄列直方图”），AI 将生成对应代码。
• 编辑代码：
  • 若单元格已有代码，AI 会根据指令修改现有代码。
  • 若选中部分代码，AI 仅修改选中部分。
  • 插入代码：将光标置于某行，使用 Cmd+K/Ctrl+K，并以 inject 或 ij 开头输入指令，AI 将在光标下方新增代码而不修改原有内容。
• 上下文引用：在提示词中使用 @变量名（如 @df），可将该变量的值作为上下文发送给 AI。

3. AI 侧边栏对话 (AI Sidebar)

• 唤起方式：按下 Ctrl+Cmd+B (Mac) 或 Ctrl+Alt+B (Linux/Windows)，或点击右侧边栏的 Pretzel 图标。
• 功能：
  • 全局搜索与修改：例如输入 "Modify the function my_function to be more efficient"，AI 会查找并优化整个 Notebook 中的该函数。
  • 代码解释：选中某段代码后询问 "Can you explain what this code does?"。
  • 基于数据的分析：输入 "Plot a histogram of @df for age"，AI 会利用内存中的 df 数据生成绘图代码。
• 上下文机制：AI 默认将当前激活单元格中的代码（或选中代码）作为对话上下文。

4. 一键修复错误

• 当代码运行报错时，错误信息右上角会出现 "Fix Error with AI" 按钮，点击即可让 AI 自动分析并尝试修复代码。

提示：如需使用 OpenAI、Claude、Ollama 等自定义模型，可在顶部菜单栏 Settings > Pretzel AI Settings 中配置 API Key 和模型选择。