请查看我们关于 Chapyter 发布的最新博客文章。

什么是 Chapyter？

Chapyter 是一个 JupyterLab 扩展，能够无缝地将 GPT-4 连接到您的编程环境。它配备了一个代码解释器，可以将您的自然语言描述转换为 Python 代码并自动执行。通过在您最熟悉的 IDE 中实现“自然语言编程”，Chapyter 可以显著提升您的工作效率，并帮助您探索许多原本不会尝试的新想法。

功能	示例
从自然语言生成代码并自动执行 只需在包含任务自然语言描述的单元格开头添加魔法命令 %%chat，几秒钟内即可生成代码并显示结果。
利用编码历史和执行输出生成代码 通过在生成时添加 --history 或 -h 标志，Chapyter 可以使用之前的执行历史和输出，为加载的 IRIS 数据集生成合适的可视化图表。
就地调试和代码编辑 生成的代码可能并不完美，可能会包含一些错误或缺陷。由于 Chapyter 完全集成在 Jupyter Notebook 中，您可以轻松检查代码并修复任何问题或错误（例如，在这种情况下安装缺失的依赖项），而无需离开 IDE。
提示词和 AI 配置透明化，并支持自定义	我们公开了库中使用的所有提示词，并且正在开发一种简便的方式来自定义这些提示词和设置。详情请参见 chapyter/programs.py。
在使用最新强大 AI 时优先考虑隐私	由于我们使用的是 OpenAI API，所有发送到 OpenAI 的数据都不会被保存用于训练（详见 OpenAI API 数据使用政策）。相比之下，当您使用 Copilot 或 ChatGPT 时，您的数据可能会被缓存，并用于它们的训练和分析。

快速入门

1. 安装

   pip install chapyter   # 自动将扩展安装到 JupyterLab
   pip uninstall chapyter # 从 JupyterLab 卸载扩展
   

   注意：此操作会将 JupyterLab 升级到 ≥ 4.0 版本，这可能会破坏您的现有环境。

2. 使用：请参阅 examples/01-quick-start.ipynb 作为入门笔记本。

   1. 在环境变量中设置正确的 OPENAI_API_KEY 和 OPENAI_ORGANIZATION
   2. 在代码单元格中使用魔法命令 %%chat：

      %%chat -m gpt-4-0613 
      列出文件夹中的所有文件
      

      此命令将调用 gpt-4-0613 生成列出文件夹中所有文件的 Python 代码，并自动执行该代码。在这种情况下，该插件充当将自然语言翻译成 Python 代码并执行的解释器。

3. 示例：

   • examples/01-quick-start.ipynb 展示了 chapyter 的基本功能，包括如何使用魔法命令 %%chat
   • examples/02-configure-chapyter.ipynb 说明了如何自定义 chapyter：
     • 使用不同的默认模型（例如，gpt-3.5-turbo 而不是 gpt-4）
     • 使用不同类型的 API（目前支持使用默认的 OpenAI API 或 Azure OpenAI API）

开发说明

Chapyter 包含两个主要组件：一个是实现处理提示并调用 GPT-X 模型的 IPython 魔法命令；另一个是前端，负责监听 Chapyter 单元格的执行情况，自动执行新生成的单元格并更新单元格样式。下图展示了 Chapyter 单元格执行后前端与 IPython 内核之间的协同工作流程。

详细信息

1. 构建扩展包需要 NodeJS。

2. jlpm 命令是 JupyterLab 自带的 yarn 固定版本，随 JupyterLab 一起安装。您也可以使用 yarn 或 npm 替代下面的 jlpm。

   # 克隆仓库到本地环境
   # 切换到 chapyter 目录
   # 以开发模式安装包
   pip install -e "."
   # 将您开发的扩展版本链接到 JupyterLab
   jupyter labextension develop . --overwrite
   # 修改源代码后重新构建扩展的 Typescript 源码
   jlpm build
   

3. 您可以在不同的终端中同时监视源代码目录并运行 JupyterLab，以便实时查看扩展源代码的变化并自动重新构建。

   # 在一个终端中监视源代码目录，必要时自动重新构建
   jlpm watch
   # 在另一个终端中运行 JupyterLab
   jupyter lab
   

   当 watch 命令运行时，每次保存的更改都会立即在本地构建，并在您正在运行的 JupyterLab 中生效。刷新 JupyterLab 即可使浏览器加载最新的更改（可能需要等待几秒钟，直到扩展完成重新构建）。

4. 默认情况下，jlpm build 命令会生成此扩展的源映射文件，以便更方便地使用浏览器开发者工具进行调试。如果您还想为 JupyterLab 核心扩展生成源映射文件，可以运行以下命令：

   jupyter lab build --minimize=False
   

5. 打包与发布：请参考 RELEASE。

Chapyter 快速上手指南

Chapyter 是一款 JupyterLab 扩展插件，能够将 GPT-4 无缝集成到您的编码环境中。它支持将自然语言描述自动转换为 Python 代码并执行，让您在熟悉的 IDE 中实现“自然语言编程”，从而大幅提升开发效率。

环境准备

• 系统要求：
  • Python 环境
  • JupyterLab ≥ 4.0（安装 Chapyter 时会自动升级 JupyterLab，请注意这可能影响现有环境）
  • NodeJS（仅在进行二次开发或构建扩展时需要）
• 前置依赖：
  • 有效的 OpenAI API Key (OPENAI_API_KEY)
  • OpenAI 组织 ID (OPENAI_ORGANIZATION，可选但推荐)

安装步骤

使用 pip 一键安装，该命令会自动将扩展注册到 JupyterLab：

pip install chapyter

注意：如果您需要卸载该扩展，请运行 pip uninstall chapyter。

基本使用

1. 配置环境变量

在启动 JupyterLab 之前，请在终端中设置您的 OpenAI 凭证：

export OPENAI_API_KEY="your-api-key-here"
export OPENAI_ORGANIZATION="your-org-id-here"

(Windows 用户请使用 set 命令或在系统环境变量中配置)

2. 启动 JupyterLab

jupyter lab

3. 使用魔法命令

新建一个 Notebook，在代码单元格中输入 %%chat 作为第一行，随后填写您的自然语言指令。

示例：列出当前文件夹下的所有文件

%%chat -m gpt-4-0613 
List all the files in the folder 

执行效果：

1. Chapyter 会调用指定的模型（如 gpt-4-0613）。
2. 自动生成对应的 Python 代码。
3. 自动执行生成的代码并显示结果。

进阶提示

• 利用上下文：添加 --history 或 -h 标志，可以让 AI 参考之前的代码执行历史和输出结果来生成新代码（例如基于已加载的数据集进行可视化）。
• 就地调试：生成的代码若有错误或缺少依赖，您可以直接在单元格中修改代码或安装依赖，无需离开 IDE。