1. はじめに
こんにちは!DataRobot AI エンジニアのブルームです。普段はモデルのインテグレーションやMLOpsの実装を担当しています。
DataRobotでは、特定のユースケースを迅速にアプリを使い始められるように、様々なアプリテンプレートを提供しています。これらのテンプレートは非常に便利ですが、実際に動かすためにはいくつかの環境設定が必要になります。特に、PulumiのようなInfrastructure as Code (IaC) ツールを利用するテンプレートでは、Python仮想環境の準備、Pulumi CLIのセットアップ、そして多数の環境変数の設定といった手順が必要となり、少し手間がかかる場合があります。
本記事では、そうしたテンプレートの初期セットアップを劇的に簡略化し、高速化(爆速化!)する quickstart.py という便利なスクリプトについて、その仕組みとメリットを徹底解説します。このスクリプトがあることで、複雑なセットアップ手順を意識することなく、すぐにテンプレートを試すことができます。
2. アプリテンプレートセットアップ時の悩み
DataRobotのアプリテンプレートを利用する場合は、以下のようなセットアップ手順が必要になります。初めての方やコマンドラインに慣れていない方は、ハードルが高く感じるかもしれません。
(1) Python仮想環境の準備:
- ローカル環境 (Windows/Mac) や DataRobot CodeSpace など、実行環境に応じて venv や conda を使って仮想環境を作成・有効化する必要があります。
- requirements.txt に記載された依存ライブラリをインストールします (pip install -r requirements.txt)。
(2) Pulumi CLI のセットアップ:
- Pulumi CLIがインストールされているか確認し、なければインストールします。
- Pulumiへのログイン (pulumi login) が必要です。
(3) 環境変数の設定:
- APIキー、エンドポイントURL、プロジェクトIDなど、テンプレートが必要とする多くの設定値を環境変数として設定する必要があります。
- 特に、クラウドサービスの設定やLLMの認証情報など、複雑なJSON形式の値を設定する必要がある場合もあります。
(4) Pulumiコマンドの実行:
- 設定が完了したら、pulumi up コマンドを実行してインフラストラクチャをデプロイします。
これらの手順は、特に環境構築に慣れていない場合や、異なる環境(ローカル開発環境、CI/CD環境、DataRobot CodeSpaceなど)で一貫性を保ちたい場合に、エラーの原因となったり、時間を要したりする可能性があります。
3. quickstart.py の主な機能解説
quickstart.py は、主に以下の機能を提供することで、セットアッププロセスを自動化・簡略化しています。
多様な実行環境への対応:
- あなたのローカルマシン(WindowsやMac)でも、DataRobot CodeSpaceのようなクラウドベースの開発環境でも動作するように考慮されています。環境差を吸収し、一貫したセットアップ体験を提供します。
Pulumi CLI の存在確認:
- スクリプト実行前に、Pulumi CLIがインストールされ、利用可能な状態か(check_pulumi_installed())、そしてPulumiにログイン済みか(check_pulumi_login())を確認します。これにより、後続の pulumi コマンド実行時のエラーを未然に防ぎます。
Python仮想環境の自動管理:
- create_virtual_environment() 関数は、プロジェクト配下に仮想環境(デフォルトでは .venv)が存在しない場合に自動で作成します。
- 特筆すべきは、conda環境で実行されているかを認識 (is_conda_environment()) し、その場合は conda create を、そうでなければ標準の venv モジュールを使って仮想環境を作成する点です。 これにより、ユーザーがどちらの環境を使っているかを意識する必要がありません。
# quickstart.py 内の仮想環境作成ロジック(抜粋)
def create_virtual_environment() -> None:
if not venv_dir.exists():
if is_conda_environment():
print("Creating conda environment...")
subprocess.run(
[
"conda",
"create",
"--prefix",
str(venv_dir),
"python=3.11", # 例: Pythonバージョン指定
"pip",
"-y",
],
check=True,
cwd=work_dir,
)
else:
# Regular venv creation
python_executable = get_python_executable()
subprocess.run(
[python_executable, "-m", "venv", ".venv"],
check=True,
cwd=work_dir,
)
環境変数の適用:
- load_dotenv() 関数は、プロジェクトルートにある .env ファイルを読み込み、そこに定義されたキーと値を環境変数として設定します。
- この関数の便利な点は、python-dotenv ライブラリの機能を活用し、環境変数に埋め込まれたJSON文字列(例えば、Google LLM設定用のサービスアカウントキーなど)を適切に解釈して読み込めることです。これにより、複雑な設定値も .env ファイルで管理しやすくなります。
- .env ファイルが存在しない場合は、エラーを出してユーザーに作成を促します (check_dotenv_exists())。
Pulumiコマンドの実行制御:
- run_pulumi_command() 関数は、pulumi up (デプロイ) や pulumi destroy (削除) といったPulumiコマンドを実行します。
- 重要なのは、この関数が load_dotenv() で読み込んだ環境変数を引き継いでPulumiコマンドを実行する点です。これにより、.env ファイルで設定した値がPulumiのデプロイプロセスに正しく反映されます。
4. quickstart.py の使い方
使い方は非常にシンプルです。
- テンプレートのリポジトリをクローンする。
- .env.templateを.env に書き換えて、必要な設定値を記述する。
- ターミナルで python quickstart.py {project名} を実行する。
これだけで、以下の処理が自動的に行われます。
# quickstart.py のおおまかな実行フロー
check_dotenv_exists() # .env ファイルの存在確認
env_vars = load_dotenv() # 環境変数の読み込み・設定
check_pulumi_installed() # Pulumi CLI のインストール確認
check_pulumi_login() # Pulumi ログイン状態の確認
create_virtual_environment() # 仮想環境の作成(必要なら)
setup_virtual_environment() # 仮想環境の有効化と依存関係インストール
run_pulumi_command() # pulumi up (または destroy) の実行
スクリプトが正常に完了すれば、アプリが起動し、ご利用いただけます!
5. まとめ
本記事では、DataRobotアプリケーションテンプレートの起動(セットアップ)を爆速化する quickstart.py スクリプトについて徹底解説しました。このスクリプトは、Python仮想環境の管理、Pulumi CLIのチェック、環境変数の読み込み、そしてPulumiコマンドの実行といった一連のプロセスを自動化することで、ユーザーがテンプレートを迅速かつ容易に利用開始できるように支援します。
DataRobotのアプリケーションテンプレートを利用する際には、ぜひ quickstart.py が提供されているか確認してみてください。もし含まれていれば、複雑な手順に悩まされることなく、python quickstart.py を実行するだけで、AIソリューションの試用や開発にすぐに取り掛かることができるでしょう。