0. 本課題について
本課題では、LLM のアプリ開発を行なっていただきます。 実装においては、Chainlit というライブラリを使用します。
Chainlit とは？
- Python のオープンソースのライブラリ
- ChatGPT のような UI のアプリを、短いコードで作成し、デプロイできる
- 「chainlit」で検索すれば多くの日本語記事が出てくる
- 公式レポジトリ：https://github.com/Chainlit/chainlit
みなさんには、アプリで追加したい機能に関するイシューを 4 つ立ててもらい、そのイシューを 1 つずつ解決していくことで、 LLM アプリの機能追加を行なっていただきます。
作成するイシューの例
このフローに沿って開発することで、ツールの使い方や開発の流れの理解し、1 人のエンジニアとして活躍できるスキルの基礎を身につけて行きます。
最終制作物のイメージ（動画）
最終制作物のイメージ（画像）
本講義で使うツールは、以下の通りです。
- Docker（見出し 1 で説明）
- 仮想化プラットフォーム。自分のローカルの PC 環境を汚さずに環境を構築できる
- VSCode（見出し 2 で説明）
- 多くの開発者が使う、コードを書く環境（IDE；総合開発環境）
- Devcontainer（見出し 2 で説明）
- VSCode 上で Docker を簡単に使うためのツール
以下の手順に従って、開発環境を用意しましょう！
1. Docker Desktop のインストール
Docker は、アプリケーションをコンテナという単位でパッケージ化し、環境に依存せずに実行できるようにする技術です。コンテナは、アプリケーションの実行に必要なコード、ライブラリ、設定ファイルなどを含んでおり、どの環境でも同じように動作します。これにより、「開発環境では動いたのに、本番環境では動かない」といった問題を解決できます。
Docker Desktop は、Windows や Mac などのデスクトップ環境で Docker を簡単に使用できるようにするアプリケーションです。Docker Desktop によって、GUI を通した Docker のセットアップが可能になり、スムーズに Docker エコシステムへの参入が可能になります。
参考リンク
2. VSCode の準備
2.1. VSCode のインストール
Visual Studio Code（VSCode）は、Microsoft が開発した無料でオープンソースのコードエディタです。軽量でありながら強力な機能を備えており、Windows、Mac、Linux の各プラットフォームに対応しています。プログラミング言語やフレームワークに依存しない汎用性の高さ、開発を円滑にする拡張機能や git 連携により、世界中の開発者に広く利用されています。
参考記事
2.2. devcontainer のインストール・使い方
DevContainer は、VSCode の Remote - Containers 拡張機能を通じて、Docker コンテナ内で開発環境を構築し、利用するための機能です。
DevContainer の利用により、開発環境のセットアップ時間が大幅に短縮されます。また、プロジェクトに参加する全員が同じ開発環境を共有するため、環境差異によるトラブルを防ぐことができます。さらに、Docker コンテナを使用するため、開発環境を簡単に再現、共有、移行することが可能となります。これにより、環境構築の複雑さを意識することなく、コーディングに集中することができます。
DevContainer は、VSCode の拡張機能（2x2 のマスで右上だけ浮いているようなアイコン）からインストールできます
参考記事
3. 本課題でコードを書くまで
1. 今見ているページをローカルの適当な場所に git clone する
git clone https://github.com/matsuoinstitute/chatbot-demo2. VSCode にて、clone してできた chatbot-demo フォルダを選択
3. env ファイルの設定
env.sample をコピー＆ペーストして、作成できたファイルを「.env」という名前に変更
以下のような構造になっていれば OK です
.env ファイルには、「sk-」から始まる自分の OpenAI API キーを設定します。（step1 にて使用）
4. 右下に出てくる、「コンテナを再度開く」ボタンを押す
ボタンが出てこない場合は、コマンドパレット（⌘+shift+p）を開けば、コンテナを開くボタンが出現します
これで、コードを書ける環境ができたはずです。
Github のイシューの切り方や、PR（プルリクエスト）の作り方など、具体的な開発手順は wiki に記載しているので、そちらも併せてご覧ください。
まずは、src 直下に移動して、demo.py を動かしてみましょう！
# src直下に移動
cd src# demo.pyを実行
chainlit run demo.py -w