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 等)。文件可在 ReadTheDocs 上找到。
您需要安裝以下軟體才能使用 Jupyter AI:
此外,您還需要存取至少一個模型提供者。
重要的
JupyterLab 3 於2024 年5 月15 日達到維護結束日期。 。有關更多信息,請參閱 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。您可以通讀每個部分來選擇最適合您的安裝方法。
pip
快速安裝(建議)pip
進行最小安裝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 的 Jupyter AI 擴充功能提供了一個本機 UI,使多個使用者能夠與 Jupyter AI 對話助理聊天。如果您安裝了 JupyterLab,則應在安裝jupyter_ai
軟體包時安裝並啟動它。
如需安裝和使用 Jupyter AI 的協助,請參閱 ReadTheDocs 上的使用者文件。
如果您想為 Jupyter AI 做出貢獻,請參閱 ReadTheDocs 上的貢獻者文件。