jupyter ai

Jupyter人工智能

Jupyter AI 正在作为 JupyterLab 组织的一部分进行孵化。

Jupyter AI 将生成式 AI 与 Jupyter 笔记本连接起来。 Jupyter AI 提供了一种用户友好且强大的方式来探索笔记本中的生成式 AI 模型，并提高 JupyterLab 和 Jupyter Notebook 中的工作效率。更具体地说，Jupyter AI 提供：

• %%ai魔法将 Jupyter 笔记本变成可复制的生成式 AI 游乐场。这适用于 IPython 内核运行的任何地方（JupyterLab、Jupyter Notebook、Google Colab、Kaggle、VSCode 等）。
• JupyterLab 中的本机聊天 UI 使您能够将生成式 AI 作为对话助手使用。
• 支持广泛的生成模型提供商，包括 AI21、Anthropic、AWS、Cohere、Gemini、Hugging Face、MistralAI、NVIDIA 和 OpenAI。
• 通过 GPT4All 和 Ollama 提供本地模型支持，从而能够在消费级机器上轻松且私密地使用生成式 AI 模型。

文档可在 ReadTheDocs 上找到。

要求

您需要安装以下软件才能使用 Jupyter AI：

• Python 3.8 - 3.12
• JupyterLab 4 或笔记本 7

此外，您还需要访问至少一个模型提供商。

重要的

JupyterLab 3 于 2024 年 5 月 15 日达到维护结束日期。因此，我们不会将新功能向后移植到支持 JupyterLab 3 的 v1 分支。关键问题的修复仍将向后移植，直到 2024 年 12 月 31 日。如果您仍然使用 JupyterLab 3，我们强烈建议您尽快升级到 JupyterLab 4 。有关更多信息，请参阅 Jupyter 博客上的 JupyterLab 3 维护结束。

在笔记本中设置模型提供者

要在此笔记本中使用任何 AI 模型提供程序，您需要适当的凭据，例如 API 密钥。

从模型提供商的平台获取必要的凭据，例如 API 密钥。

您可以使用环境变量或在笔记本中的代码单元中设置密钥。在代码单元中，您可以使用 %env magic 命令来设置凭据，如下所示：

 # NOTE: Replace 'PROVIDER_API_KEY' with the credential key's name,
# and replace 'YOUR_API_KEY_HERE' with the key.
% env PROVIDER_API_KEY = YOUR_API_KEY_HERE

有关每个模型提供程序的更具体说明，请参阅模型提供程序文档。

安装

以下是安装和使用过程的简化概述。有关安装和使用 Jupyter AI 的详细信息，请参阅我们的官方文档。

我们提供 3 种不同的方式来安装 Jupyter AI。您可以通读每个部分来选择最适合您的安装方法。

1. 通过pip快速安装（推荐）
2. 通过pip进行最小安装
3. 通过conda进行最小安装

通过pip快速安装（推荐）

如果您想同时安装%%ai magic 和 JupyterLab 扩展，您可以运行：

 $ pip install jupyter-ai[all]

然后，重新启动 JupyterLab。这将安装每个可选依赖项，它提供对jupyter-ai当前支持的所有模型的访问。

如果您不使用 JupyterLab 并且只想安装 Jupyter AI %%ai magic，则可以运行：

 $ pip install jupyter-ai-magics[all]

jupyter-ai依赖于jupyter-ai-magics ，因此安装jupyter-ai会自动安装jupyter-ai-magics 。

通过pip进行最小安装

Jupyter AI 中的大多数模型提供程序都需要安装特定的依赖项才能使用。这些称为提供者依赖性。提供程序依赖项对于 Jupyter AI 来说是可选的，这意味着 Jupyter AI 可以在安装或不安装任何提供程序依赖项的情况下安装。如果提供程序需要未安装的依赖项，则其模型不会在允许您选择语言模型的用户界面中列出。

要通过pip执行没有任何提供程序依赖项的最小安装，请从包名称中省略[all]可选依赖项组：

 pip install jupyter-ai

通过有选择地安装提供程序依赖项，您可以控制 Jupyter AI 环境中可用的模型。

例如，要安装仅添加对 Anthropic 模型的支持的 Jupyter AI，请运行：

 pip install jupyter-ai langchain-anthropic

有关模型提供程序及其所需依赖项的更多信息，请参阅模型提供程序表。

通过conda进行最小安装

作为使用pip的替代方法，您可以使用 Conda 从conda-forge通道安装jupyter-ai ：

 $ conda install conda-forge::jupyter-ai

Jupyter AI 中的大多数模型提供程序都需要安装特定的提供程序依赖项才能使用。从 Conda Forge 安装jupyter-ai时不会安装提供程序依赖项，应根据需要单独安装。

例如，要安装仅添加对 OpenAI 模型的支持的 Jupyter AI，请运行：

 conda install conda-forge::jupyter-ai conda-forge::langchain-openai

有关模型提供程序及其所需依赖项的更多信息，请参阅模型提供程序表。

%%ai魔法命令

%%ai魔法可以在 IPython 内核运行的任何地方发挥作用，包括 JupyterLab、Jupyter Notebook、Google Colab 和 Visual Studio Code。

安装%%ai magic 后，您可以通过运行以下命令在任何笔记本或 IPython shell 中启用它：

 %load_ext jupyter_ai_magics

或者：

 %load_ext jupyter_ai

下面的屏幕截图来自此包的examples/目录中的笔记本。

然后，您可以使用%%ai magic 命令来指定模型和自然语言提示：

Jupyter AI 还可以生成 HTML 和数学以呈现为单元格输出。

Jupyter AI 可以插入 IPython 表达式，允许您运行包含变量值的提示。

JupyterLab 扩展

JupyterLab 的 Jupyter AI 扩展提供了一个本机 UI，使多个用户能够与 Jupyter AI 对话助理聊天。如果您安装了 JupyterLab，则应在安装jupyter_ai软件包时安装并激活它。

使用

如需安装和使用 Jupyter AI 的帮助，请参阅 ReadTheDocs 上的用户文档。

贡献

如果您想为 Jupyter AI 做出贡献，请参阅 ReadTheDocs 上的贡献者文档。