LangChainの公式ドキュメントでは、以下のチュートリアルがJupyter Notebookでの実行を前提としており、それが推奨されています。
今までJupyter Notebookを使ったことがなかったのですが、これを機に使ってみたところ、チュートリアルを読みながらサンプルコードを動かすにはとても便利でした。
本格的なシステム開発には向かない印象ですが、学習や検証用途では非常に有効だと感じたので、今後も活用していこうと思っています。
良いと感じた点
- 新規のソースコードを簡単に作成可能
新規にソースコードを実行したい場合、ファイルを作成する必要がなく、Jupyterにおけるセルを追加すればOKです。
ほんの一手間ですが、なかなか便利です。 - 実行の手間がかからない
これも上記と同様一手間の話ではあるのですが、実行ボタンを押下するだけで、ファイルも指定する必要がなく、便利です。
VSCode環境ではデバッグ実行も非常に使いやすいです。 - ソースと合わせてドキュメントを管理可能
任意の場所にマークダウン形式でメモが残せるのですがこれも便利です。
新しいコードをすぐに試せる
Jupyterではファイルを作成せずに、セルを追加するだけですぐにコードを実行できます。
ちょっとした一手間が省けるだけですが、コードを試行錯誤する際にはとても助かります。
実行がシンプル
実行ボタンを押すだけでOK。ファイルの保存や実行対象の選択なども不要です。
特にVSCode環境では、直感的にデバッグ機能を使えるので効率的です。
コードとドキュメントを一体管理できる
マークダウン形式でメモを任意の場所に残せるので、**「コード+説明」**の形で資料を作るのにも適しています。
実行環境の比較
Jupyter Notebookを利用する代表的な方法として、以下の2つを試してみました。
| 環境 | 特徴 |
|---|---|
| Google Colaboratory | 環境構築が不要で手軽に使える |
| VSCode + Jupyter拡張 | デバッグなどの開発機能が充実 |
結論としては、VSCode + Jupyter の方がデバッグがしやすく、開発体験が良かったため、個人的にはこちらをおすすめします。
Google Colab
環境構築
驚くほど簡単です。以下にアクセスするだけで、すぐにPythonが実行できる環境が利用できます。
入力補完
特に設定せずとも入力補完が効きます。初学者にとっても使いやすいです。
ライブラリのインストール
セル上で以下のように記述すれば、その場でライブラリをインストール可能です。
!pip install <ライブラリ名>
環境変数の管理
シークレットという機能があり、OpenAIのAPIキーなどを安全に管理できます。
デバッグ
コマンドベースでのデバッグは可能ですが、GUIでのブレークポイント設定やステップ実行はサポートされていません。
VS Code + Jupyter
環境構築
以下の手順で簡単にセットアップできます。
-
pip install jupyterを実行 - VSCode拡張機能「Jupyter」をインストール
-
.ipynbファイルを新規作成して実行
補助機能
VSCode上で開発できるので、Pylanceなどの拡張機能によって、強力な入力補完や型チェックが利用できます。
ライブラリのインストール
通常通り、ターミナルから pip install でOKです。
セル内で !pip install と記述しても動作します。
環境変数の設定
私は普段から .env ファイルと python-dotenv を併用しており、Notebook内でも同様の方法で問題なく使えています。
from dotenv import load_dotenv
load_dotenv()
デバッグ機能が強力！
これがVSCodeを選ぶ最大の理由です。
- GUIでブレークポイントを設定可能
-
F10キーでのステップ実行 - 変数の中身をサイドバーで確認
- 変数にカーソルを合わせるとポップアップ表示
デバッグ体験が非常に優れています。
まとめ
Jupyter Notebookは、LangChainなどのライブラリを学ぶ際に非常に有用なツールです。
- サンプルコードを試しながら学べる
- ドキュメントとコードを一体で管理できる
- 特にVSCodeとの組み合わせが強力
学習や検証用に限らず、資料化やナレッジ共有にも活用できるので、導入がまだの方はぜひ試してみてください。