jupyter ai

ジュピターAI

Jupyter AI は、JupyterLab 組織の一部として開発中です。

Jupyter AI は、生成 AI を Jupyter ノートブックに接続します。 Jupyter AI は、ノートブックで生成 AI モデルを探索し、JupyterLab と Jupyter Notebook での生産性を向上させる、ユーザーフレンドリーで強力な方法を提供します。より具体的には、Jupyter AI は以下を提供します。

• Jupyter ノートブックを再現可能な生成 AI プレイグラウンドに変える%%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 または Notebook 7

さらに、少なくとも 1 つのモデル プロバイダーにアクセスする必要があります。

重要

JupyterLab 3 は、2024 年 5 月 15 日にメンテナンス終了日を迎えました。その結果、JupyterLab 3 をサポートする v1 ブランチに新機能はバックポートされません。重大な問題の修正は、2024 年 12 月 31 日までバックポートされます。 JupyterLab 3 を使用している場合は、できるだけ早く JupyterLab 4 にアップグレードすることを強くお勧めします。詳細については、Jupyter ブログの「JupyterLab 3 メンテナンス終了」を参照してください。

ノートブックでのモデルプロバイダーのセットアップ

このノートブック内で AI モデル プロバイダーを使用するには、API キーなどの適切な認証情報が必要です。

API キーなどの必要な認証情報をモデル プロバイダーのプラットフォームから取得します。

環境変数を使用するか、ノートブックのコード セルでキーを設定できます。コード セルでは、%env マジック コマンドを使用して、次のように資格情報を設定できます。

 # 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 のインストールと使用の詳細については、公式ドキュメントを参照してください。

Jupyter AI をインストールする 3 つの異なる方法を提供します。各セクションを読んで、自分にとって最適なインストール方法を選択してください。

1. pipによるクイックインストール (推奨)
2. pipによる最小限のインストール
3. condaによる最小限のインストール

pipによるクイックインストール (推奨)

%%aiマジックと JupyterLab 拡張機能の両方をインストールする場合は、次を実行できます。

 $ pip install jupyter-ai[all]

次に、JupyterLab を再起動します。これにより、オプションの依存関係がすべてインストールされ、現在jupyter-aiでサポートされているすべてのモデルへのアクセスが提供されます。

JupyterLab を使用しておらず、Jupyter AI %%aiマジックのみをインストールしたい場合は、次を実行できます。

 $ 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-forgeチャネルから Conda を使用して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マジックは、JupyterLab、Jupyter Notebook、Google Colab、Visual Studio Code など、IPython カーネルが実行されるあらゆる場所で機能します。

%%aiマジックをインストールしたら、次のコマンドを実行して、任意のノートブックまたは IPython シェルでそれを有効にできます。

 %load_ext jupyter_ai_magics

または：

 %load_ext jupyter_ai

以下のスクリーンショットは、このパッケージのexamples/ディレクトリにあるノートブックからのものです。

次に、 %%aiマジック コマンドを使用して、モデルと自然言語プロンプトを指定できます。

Jupyter AI は、セル出力としてレンダリングされる HTML と数学を生成することもできます。

Jupyter AI は IPython 式を補間できるため、変数値を含むプロンプトを実行できます。

JupyterLab 拡張機能

JupyterLab の Jupyter AI 拡張機能は、複数のユーザーが Jupyter AI 会話アシスタントとチャットできるネイティブ UI を提供します。 JupyterLab がインストールされている場合は、 jupyter_aiパッケージをインストールするときに、これもインストールしてアクティブ化する必要があります。

使用する

Jupyter AI のインストールと使用に関するヘルプについては、ReadTheDocs のユーザー ドキュメントを参照してください。

貢献する

Jupyter AI に貢献したい場合は、ReadTheDocs の貢献者ドキュメントを参照してください。