Colab Enterprise でランタイムを作成する

このページでは、Colab Enterprise でランタイムを作成、開始、削除する方法について説明します。

ランタイムを作成して、デフォルトとは異なる構成のランタイムでコードを実行できます。ランタイムは、マシンタイプやディスクサイズなどの仕様を含むランタイムテンプレートに基づいて作成されます。

始める前に

Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Dataform, and Compute Engine APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Dataform, and Compute Engine APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

必要なロール

Colab Enterprise でランタイムを作成するために必要な権限を取得するには、プロジェクトに対する Colab Enterprise 管理者（roles/aiplatform.colabEnterpriseAdmin）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

1 つ以上の必須ロールに dataform.repositories.list 権限が含まれています。プロジェクトで dataform.repositories.list 権限またはコード作成者（roles/dataform.codeCreator）ロールが付与されているユーザーは、Dataform API または Dataform コマンドラインインターフェース（CLI）を使用して、そのプロジェクトのコードアセットの名前を一覧取得できます。BigQuery Studio を使用する管理者以外のユーザーは、自身が作成したコードアセットまたは自分と共有されているコードアセットのみを表示できます。

ランタイムを作成する

ランタイムを作成するには、 Google Cloud コンソールまたは Google Cloud CLI を使用します。

コンソール

ランタイムを作成するには:

Google Cloud コンソールで、Colab Enterprise の [ランタイム] ページに移動します。

[ランタイム] に移動
[リージョン] メニューで、ランタイムを配置するリージョンを選択します。ランタイムを使用するノートブックと同じリージョンにする必要があります。
[作成] をクリックします。

[Vertex AI ランタイムの作成] ダイアログが表示されます。
[ランタイムテンプレート] メニューで、ランタイムテンプレートを選択します。ランタイムテンプレートがリストにない場合は、ランタイムテンプレートを作成します。
[ランタイム名] フィールドにランタイムの名前を入力します。
[作成] をクリックします。

デフォルトでは、ランタイムを作成すると、そのランタイムの開始と削除に必要な権限が自動的に付与されます。

gcloud

後述のコマンドデータを使用する前に、次のように置き換えます。

DISPLAY_NAME: ランタイムの表示名。
RUNTIME_TEMPLATE_ID: ランタイムテンプレートの ID。ランタイムテンプレートには、ランタイムのコンピューティング構成を指定します。
PROJECT_ID: プロジェクト ID。
REGION: ランタイムを配置するリージョン。

次のコマンドを実行します。

Linux、macOS、Cloud Shell

gcloud colab runtimes create --display-name="DISPLAY_NAME" \
    --runtime-template=RUNTIME_TEMPLATE_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows（PowerShell）

gcloud colab runtimes create --display-name="DISPLAY_NAME" `
    --runtime-template=RUNTIME_TEMPLATE_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows（cmd.exe）

gcloud colab runtimes create --display-name="DISPLAY_NAME" ^
    --runtime-template=RUNTIME_TEMPLATE_ID ^
    --project=PROJECT_ID ^
    --region=REGION

デフォルトでは、ランタイムを作成すると、そのランタイムの開始と削除に必要な権限が自動的に付与されます。

コマンドラインからランタイムテンプレートを作成するコマンドの詳細については、gcloud CLI のドキュメントをご覧ください。

ランタイムを開始する

ランタイムを開始するには、 Google Cloud コンソールまたは gcloud CLI を使用します。

コンソール

ランタイムを開始するには:

Google Cloud コンソールで、Colab Enterprise の [ランタイム] ページに移動します。

[ランタイム] に移動
[リージョン] メニューで、ランタイムを含むリージョンを選択します。
起動するランタイムを選択します。
[起動] をクリックします。

gcloud

後述のコマンドデータを使用する前に、次のように置き換えます。

RUNTIME_ID: ランタイムの ID。
PROJECT_ID: プロジェクト ID。
REGION: ランタイムが配置されているリージョン。

次のコマンドを実行します。

Linux、macOS、Cloud Shell

gcloud colab runtimes start RUNTIME_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows（PowerShell）

gcloud colab runtimes start RUNTIME_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows（cmd.exe）

gcloud colab runtimes start RUNTIME_ID ^
    --project=PROJECT_ID ^
    --region=REGION

コマンドラインからランタイムテンプレートを作成するコマンドの詳細については、gcloud CLI のドキュメントをご覧ください。

ランタイムを削除する

ランタイムを削除するには、 Google Cloud コンソールまたは gcloud CLI を使用します。

コンソール

ランタイムを削除するには:

Google Cloud コンソールで、Colab Enterprise の [ランタイム] ページに移動します。

[ランタイム] に移動
[リージョン] メニューで、ランタイムを含むリージョンを選択します。
削除するランタイムを選択します。
[削除] をクリックします。
[確認] をクリックします。

gcloud

後述のコマンドデータを使用する前に、次のように置き換えます。

RUNTIME_ID: ランタイムの ID。
PROJECT_ID: プロジェクト ID。
REGION: ランタイムが配置されているリージョン。

次のコマンドを実行します。

Linux、macOS、Cloud Shell

gcloud colab runtimes delete RUNTIME_ID \
    --project=PROJECT_ID \
    --region=REGION

Windows（PowerShell）

gcloud colab runtimes delete RUNTIME_ID `
    --project=PROJECT_ID `
    --region=REGION

Windows（cmd.exe）

gcloud colab runtimes delete RUNTIME_ID ^
    --project=PROJECT_ID ^
    --region=REGION

コマンドラインからランタイムテンプレートを作成するコマンドの詳細については、gcloud CLI のドキュメントをご覧ください。

トラブルシューティング

このセクションでは、Colab Enterprise でのランタイム作成に関する問題を解決する方法について説明します。

ランタイムを作成できない

この問題は、ランタイムを作成できない場合に発生します。デフォルトのランタイムを作成できないもご覧ください。最も一般的な原因は次のとおりです。

割り当て不足

ランタイムを作成できない場合、Compute Engine ランタイムの割り当てを超過している可能性があります。

Colab Enterprise では、ランタイムに Compute Engine の割り当てを使用します。詳細については、Compute Engine の割り当てと上限の概要をご覧ください。

この問題を解決するには、割り当ての調整をリクエストしてください。

リソースを利用できない

ランタイムを作成しようとすると、次のエラーが発生します。

No available zone found for runtime RUNTIME_ID
for machine type MACHINE_TYPE
with accelerator type: ACCELERATOR. Please try again later.

このエラーは、ノートブックのリージョン内にマシンタイプ構成で使用できるリソースがない場合に発生します。

この問題を解決するには、以下のいずれかを試します。

別のリージョンにランタイムを作成します。
別のマシンタイプ構成でランタイムテンプレートを作成し、新しいランタイムテンプレートに基づいてランタイムを作成します。

デフォルトのランタイムがすでに存在する

デフォルトのランタイムがすでに存在する場合に、デフォルトのランタイムテンプレートからランタイムを作成しようとすると、次のエラーが発生します。

Failed to create runtime

One click runtime already exists.

デフォルトのランタイムテンプレートからランタイムを作成しようとすると、Colab Enterprise はデフォルトのランタイムの作成を試みます。デフォルトのランタイムは、ユーザー、プロジェクト、リージョンごとに 1 つだけ作成できます。デフォルトのランタイムがすでに存在するときに、Colab Enterprise が別のデフォルトのランタイムを作成することはできません。

この問題を解決するには、既存のデフォルトのランタイムに接続するか、デフォルト以外のランタイムテンプレートからランタイムを作成します。

デフォルトのランタイムを作成できない

Colab Enterprise がデフォルトのランタイムを作成するときは、まずデフォルトのランタイムテンプレートを作成し、デフォルトのランタイムの生成に使用します。ランタイムテンプレートの作成に必要な権限がない状態でデフォルトのランタイムを作成しようとすると、Colab Enterprise はデフォルトのランタイムを作成できません。

この問題を解決するには、aiplatform.notebookRuntimeTemplates.create 権限を含むロールを付与するよう管理者に依頼してください。

Colab Enterprise でランタイムを作成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

必要なロール

ランタイムを作成する

コンソール

gcloud

Linux、macOS、Cloud Shell

Windows（PowerShell）

Windows（cmd.exe）

ランタイムを開始する

コンソール

gcloud

Linux、macOS、Cloud Shell

Windows（PowerShell）

Windows（cmd.exe）

ランタイムを削除する

コンソール

gcloud

Linux、macOS、Cloud Shell

Windows（PowerShell）

Windows（cmd.exe）

トラブルシューティング

ランタイムを作成できない

割り当て不足

リソースを利用できない

デフォルトのランタイムがすでに存在する

デフォルトのランタイムを作成できない

次のステップ

Colab Enterprise でランタイムを作成する