TPU を管理する

このページでは、以下を使用して Cloud TPU リソースを管理する方法について説明します。

Google Cloud CLI。Google Cloud にメインの CLI を提供します。
Google Cloud コンソール。Google Cloud リソースの統合管理コンソールです。

Cloud TPU には、TPU ノードと TPU VM の 2 つの VM アーキテクチャがあります。この 2 つの VM アーキテクチャについては、システムアーキテクチャをご覧ください。このドキュメントで説明する gcloud コマンドは、両方の TPU 構成で使用できます。使用する gcloud コマンドは、使用する TPU 構成によって異なります。各 gcloud コマンドは、タブ付きのセクションに表示されます。使用する TPU 構成のタブを選択すると、対応する gcloud コマンドがウェブページに表示されます。TPU ノードを使用する必要がある場合を除き、TPU VM を使用することをおすすめします。Cloud TPU v4 では、TPU VM アーキテクチャのみがサポートされます。

前提条件

以下の手順を実行する前に、Google Cloud CLI をインストールし、Google Cloud プロジェクトを作成して、Cloud TPU API を有効にする必要があります。手順については、プロジェクトを設定して Cloud TPU API を有効にするをご覧ください。

Google Cloud CLI を使用する場合は、Google Cloud Shell、Compute Engine VM を使用するか、Google Cloud CLI をローカルにインストールします。Google Cloud Shell を使用すると、ソフトウェアをインストールせずに Cloud TPU を操作できます。非アクティブな状態が一定期間続くと Google Cloud Shell の接続が解除される可能性があります。長時間実行コマンドを実行する場合は、ローカルマシンに Google Cloud CLI をインストールすることをおすすめします。Google Cloud CLI の詳細については、gcloud リファレンスをご覧ください。

TPU は、すべてのリージョンで利用できるわけではありません。詳細については、Cloud TPU のリージョンとゾーンをご覧ください。

Cloud TPU の作成

Cloud TPU は、gcloud または Google Cloud コンソールを使用して作成できます。curl を使用して Cloud TPU API にリクエストを行うこともできます。

`gcloud` を使用した Cloud TPU の作成

使用するコマンドは、TPU VM と TPU ノードアーキテクチャのどちらを使用するかによって異なります。詳細については、システムアーキテクチャをご覧ください。

TPU VM

TensorCore または TPU チップの観点から TPU の構成を指定できます。詳細については、システムアーキテクチャで使用している TPU バージョンのセクションをご覧ください。

次のコマンドは、TensorCore ベースの構成を使用します。

$ gcloud compute tpus tpu-vm create tpu-name \
  --zone=us-central2-b \
  --accelerator-type=v4-8 \
  --version=tpu-software-version

コマンドフラグの説明

zone: Cloud TPU を作成するゾーン。
accelerator-type: 作成する Cloud TPU のタイプ。
version: TPU ソフトウェアのバージョン。
shielded-secure-boot（オプション）: セキュアブートを有効にして TPU インスタンスを作成することを指定します。これにより、暗黙的に Shielded VM インスタンスにされます。詳細については、Shielded VM とはをご覧ください。

次のコマンドは、チップベースの構成を使用して TPU を作成します。

  $ gcloud compute tpus tpu-vm create tpu-name \
    --zone=us-central2-b \
    --type=v4 \
    --topology=2x2x1 \
    --version=tpu-software-version

必須フラグ

tpu-name: 作成する TPU VM の名前。
zone: Cloud TPU を作成するゾーン。
type: サポートされている TPU タイプの詳細については、TPU タイプをご覧ください。
topology: サポートされているトポロジについては、トポロジのセクションをご覧ください。
version: 使用する TPU ソフトウェアバージョン。詳細については、TPU ソフトウェアのバージョンをご覧ください。

サポートされている TPU タイプとトポロジの詳細については、タイプとトポロジをご覧ください。

TPU ノード

$ gcloud compute tpus execution-groups create --name=tpu-name \
  --zone=us-central1-a \
  --tf-version=2.12.0 \
  --machine-type=n1-standard-1 \
  --accelerator-type=v3-8

コマンドフラグの説明

zone: Cloud TPU を作成するゾーン。
tf-version: gcloud コマンドが VM にインストールする TensorFlow のバージョン。
machine-type: 作成する Compute Engine VM のマシンタイプ。
accelerator-type: 作成する Cloud TPU のタイプ。

`gcloud` を使用した Cloud TPU のキューに入れられたリソースの作成

gcloud を使用すると、キューに入れられたリソースとして Cloud TPU を作成することもできます。キューに入れられたリソースをリクエストすると、リクエストは Cloud TPU で管理されるキューに追加されます。リソースが利用可能になると、そのリソースが割り当てられ、排他的に利用できるようになります。詳しくは、Cloud TPU のキューに入れられたリソースをご覧ください。

起動スクリプトを実行する

TPU VM の作成時に --metadata startup-script パラメータを指定すると、各 TPU VM で起動スクリプトを実行できます。次のコマンドは、起動スクリプトを使用して TPU VM を作成します。

$ gcloud compute tpus tpu-vm create tpu-name \
    --zone=us-central2-b \
    --accelerator-type=tpu-type \
    --version=tpu-vm-tf-2.15.0-pjrt \
    --metadata startup-script='#! /bin/bash
      pip3 install numpy
      EOF'

TPU VM を作成したら、SSH を使用して TPU VM に接続し、次のコマンドを実行します。これにより、起動スクリプトからログを表示できます。

$ cat /var/log/syslog | grep startup-script

Google Cloud コンソールでの Cloud TPU の作成

Google Cloud Console に移動します。
左側のナビゲーションメニューから、[Compute Engine] > [TPU] を選択します。
[Create TPU Node] をクリックします。
[名前] ボックスに TPU インスタンス名を入力します。
[ゾーン] ボックスで、TPU を作成するゾーンを選択します。
[TPU 設定] で、[TPU VM アーキテクチャ] または [TPU ノードアーキテクチャ] を選択します。TPU の構成に応じて、TPU を TPU VM として作成するか、TPU ノードとして作成するかが決まります。詳細については、システムアーキテクチャをご覧ください。
[TPU タイプ] で、作成する TPU タイプを選択します。
[TPU ソフトウェアバージョン] で、ソフトウェアバージョンを選択します。Cloud TPU VM の作成時には、インストールされる TPU ランタイムバージョンが TPU ソフトウェアバージョンによって指定されます。Cloud TPU ノードを作成するときに、TPU ソフトウェアバージョンを使用すると、ノードの VM にインストールされている ML フレームワークを選択できます。その他の設定は必要ありません。詳細については、サポートされているモデルをご覧ください。
[作成] をクリックしてリソースを作成します。

`curl` を使用した Cloud TPU VM の作成

次のコマンドは、curl を使用して TPU を作成します。

$ curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d "{accelerator_type: 'v4-8', \
  runtime_version:'tpu-vm-tf-2.15.0-pjrt', \
  network_config: {enable_external_ips: true}, \
  shielded_instance_config: { enable_secure_boot: true }}" \
  https://tpu.googleapis.com/v2/projects/project-id/locations/us-central2-b/nodes?node_id=node_name

必須項目

runtime_version: 使用する Cloud TPU ランタイムのバージョン。
project: : Google Cloud プロジェクトの名前。
zone: Cloud TPU を作成するゾーン。
node_name: 作成する TPU VM の名前。

Cloud TPU への接続

SSH を使用して TPU に接続できます。

TPU VM

TPU VM を使用する場合は、SSH-in-browser（プレビュー）または Google Cloud CLI を使用して、TPU に明示的に SSH 接続する必要があります。

次の手順で SSH-in-browser を使用します。

プレビュー — SSH-in-browser TPU support

この機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 pre-GA の機能は「現状有姿」で利用できますが、サポートが制限される場合があります。詳しくは、リリースステージの説明をご覧ください。
1. Google Cloud コンソールで、[TPU] ページに移動します。
  
  TPU に移動
2. TPU VM のリストで、接続する TPU VM の行にある [SSH] をクリックします。
注: Google Cloud コンソールを使って TPU VM に接続すると、Compute Engine によって一時的な SSH 認証鍵が作成されます。
gcloud compute tpus tpu-vm ssh コマンドを実行して、gcloud CLI を使用します。
```
$ gcloud compute tpus tpu-vm ssh tpu-name --zone=zone
```
TPU Pod に関連付けられた他の TPU VM に接続するには、コマンドに --worker worker-number を追加します。ここで、worker-number は、0 から始まるインデックスです。
注: Google Cloud CLI を使用して VM に接続すると、Compute Engine によって永続的な SSH 認証鍵が作成されます。

TPU ノード

デフォルトでは、TPU ノードの作成に使用する gcloud コマンドは、TPU ノードに自動的に SSH 接続を試みます。TPU ノードを使用していて、gcloud コマンドで Compute Engine インスタンスに接続していない場合は、次のコマンドを実行して接続できます。

$ gcloud compute ssh tpu-name \
  --zone=zone

Cloud TPU リソースの一覧表示

Cloud TPU は、指定したゾーン内にあるすべてを一覧表示できます。

`gcloud` を使用した Cloud TPU リソースの一覧表示

使用するコマンドは、TPU VM を使用しているか、TPU ノードを使用しているかによって異なります。詳細については、システムアーキテクチャをご覧ください。

TPU VM

$ gcloud compute tpus tpu-vm list --zone=zone

TPU ノード

$ gcloud compute tpus execution-groups list --zone=zone

このコマンドは、指定されたゾーン内の Cloud TPU リソースを一覧表示します。設定されたリソースがない場合、出力では VM と TPU にダッシュだけが表示されます。一方のリソースがアクティブで、もう一方がアクティブでなければ、正常なステータスではないことを伝えるメッセージが表示されます。この場合、実行されていないリソースの起動または再起動が必要になります。

Google Cloud コンソールでの Cloud TPU リソースの一覧表示

Google Cloud コンソールに移動します。
左側のナビゲーションメニューから、[Compute Engine] > [TPU] を選択します。コンソールに TPU ページが表示されます。

Cloud TPU に関する情報の取得

指定した Cloud TPU に関する情報を取得できます。

`gcloud` を使用して Cloud TPU に関する情報を取得する

TPU VM

$ gcloud compute tpus tpu-vm describe tpu-name \
  --zone=zone

TPU ノード

$ gcloud compute tpus execution-groups describe tpu-name \
  --zone=zone

Google Cloud コンソールで Cloud TPU に関する情報を取得する

Google Cloud コンソールに移動します。
左側のナビゲーションメニューから、[Compute Engine] > [TPU] を選択します。コンソールに TPU ページが表示されます。
Cloud TPU の名前をクリックします。Cloud TPU の詳細ページが表示されます。

Cloud TPU リソースの停止

単一の Cloud TPU を停止することで、VM の構成とソフトウェアを失わずに課金を停止できます。TPU Pod またはキューに格納されたリソース API を介して割り当てられた TPU の停止はサポートされていません。キューに格納されたリソース API を介して割り当てられた TPU に対する課金を停止するには、TPU を削除する必要があります。

`gcloud` を使用した Cloud TPU の停止

Cloud TPU の停止に使用するコマンドは、TPU VM と TPU ノードのどちらを使用しているかによって異なります。詳細については、システムアーキテクチャをご覧ください。

TPU VM

$ gcloud compute tpus tpu-vm stop tpu-name \
--zone=zone

TPU ノード

$ gcloud compute tpus stop tpu-name \
--zone=zone

Google Cloud コンソールで Cloud TPU を停止する

Google Cloud コンソールに移動します。
左側のナビゲーションメニューから、[Compute Engine] > [TPU] を選択します。コンソールに TPU ページが表示されます。
Cloud TPU の横にあるチェックボックスをオンにして、[停止] をクリックします。

Cloud TPU リソースの起動

停止した Cloud TPU は再開できます。

`gcloud` を使用した Cloud TPU の起動

停止された Cloud TPU を起動して、使用を再開できます。

停止した Cloud TPU の開始に使用するコマンドは、TPU VM と TPU ノードのどちらを使用しているかによって異なります。詳細については、システムアーキテクチャをご覧ください。

TPU VM

$ gcloud compute tpus tpu-vm start tpu-name --zone=zone

TPU ノード

$ gcloud compute tpus start tpu-name --zone=zone

Google Cloud コンソールで Cloud TPU を起動する

Google Cloud コンソールに移動します。
左側のナビゲーションメニューから、[Compute Engine] > [TPU] を選択します。コンソールに TPU ページが表示されます。
Cloud TPU の横にあるチェックボックスをオンにして、[開始] をクリックします。

Compute Engine VM および Cloud TPU リソースを削除する

Cloud TPU は、使用が終了すると削除できます。

`gcloud` を使用した Cloud TPU の削除

使用するコマンドは、TPU VM を使用するか TPU ノードを使用するかによって異なります。詳細については、システムアーキテクチャをご覧ください。

TPU VM

$ gcloud compute tpus tpu-vm delete tpu-name \
  --zone=zone

コマンドフラグの説明

zone: Cloud TPU を削除するゾーン。

TPU ノード

$ gcloud compute tpus execution-groups delete tpu-name \
  --zone=zone

コマンドフラグの説明

zone: Cloud TPU を削除するゾーン。

Google Cloud コンソールでの Cloud TPU の削除

Google Cloud コンソールに移動します。
左側のナビゲーションメニューから、[Compute Engine] > [TPU] を選択します。コンソールに TPU ページが表示されます。
Cloud TPU の横にあるチェックボックスをオンにして、[削除] をクリックします。

高度な設定

カスタムネットワークリソース

TPU を作成するときに、ネットワークかサブネットワークのいずれかまたは両方を指定できます。これを行うには、gcloud コマンドまたは curl 呼び出しを送信します。

gcloud CLI でネットワークまたはサブネットワークを指定するには、次のコマンドを使用します。

--network [NETWORK] --subnetwork [SUBNETWORK]

curl 呼び出しでネットワークまたはサブネットワークを指定するには、次のコマンドを使用します。

network_config: {network: '[NETWORK]', subnet: '[SUBNETWORK]', enable_external_ips: true}

ネットワーク

TPU に使用するネットワークを指定することもできます。指定しない場合は、default ネットワークが使用されます。

有効なネットワークのフォーマット:

https://www.googleapis.com/compute/{version}/projects/{proj-id}/global/networks/{network}
compute/{version}/projects/{proj-id}/global/networks/{network}
compute/{version}/projects/{proj-##}/global/networks/{network}
projects/{proj-id}/global/networks/{network}
projects/{proj-##}/global/networks/{network}
global/networks/{network}
{network}

サブネットワーク

特定のサブネットワークを使用するように、サブネットワークを指定できます。指定するサブネットワークは、TPU を実行するゾーンと同じリージョンに存在する必要があります。

有効な形式:

https://www.googleapis.com/compute/{version}/projects/{proj-id}/regions/{region}/subnetworks/{subnetwork}
compute/{version}/projects/{proj-id}/regions/{region}/subnetworks/{subnetwork}
compute/{version}/projects/{proj-##}/regions/{region}/subnetworks/{subnetwork}
projects/{proj-id}/regions/{region}/subnetworks/{subnetwork}
projects/{proj-##}/regions/{region}/subnetworks/{subnetwork}
regions/{region}/subnetworks/{subnetwork}
{subnetwork}

限定公開の Google アクセス

TPU VM に SSH 接続するには、TPU VM のアクセス構成を追加するか、TPU VM が接続されたサブネットワークの限定公開の Google アクセスを有効にする必要があります。

アクセス構成を追加するには、enable_external_ips を設定する必要があります。TPU を作成すると、enable_external_ips がデフォルトで設定されます。無効にするには、次のコマンドを入力します。

--internal-ips

または、curl 呼び出しを使用します。

network_config: {enable_external_ips: true}

限定公開の Google アクセスを構成したら、SSH 経由で VM に接続します。

カスタムサービスアカウント

各 TPU VM には、API リクエストを行うために使用するサービスアカウントが関連付けられています。TPU VM は、このサービスアカウントを使用して Cloud TPU API を呼び出し、Cloud Storage やその他のサービスにアクセスします。デフォルトでは、TPU VM はデフォルトの Compute Engine サービスアカウントを使用します。

--service-account フラグを使用して TPU VM を作成するときに、カスタムサービスアカウントを指定できます。サービスアカウントは、TPU VM を作成する Google Cloud プロジェクトと同じプロジェクトで定義する必要があります。TPU VM に使用されるカスタムサービスアカウントには、Cloud TPU API を呼び出すための TPU 閲覧者のロールが必要です。TPU VM で実行されるコードが他の Google Cloud サービスを呼び出す場合は、これらのサービスにアクセスするために必要なロールが必要です。

TPU を作成するときに、--service-account フラグを使用してカスタムサービスアカウントを指定できます。サービスアカウントの詳細については、サービスアカウントをご覧ください。

次のコマンドを使用して、カスタムサービスアカウントを指定します。

`gcloud` CLI を使用して TPU VM を作成する

$ gcloud compute tpus tpu-vm create tpu-name \
    --zone=us-central2-b \
    --accelerator-type=tpu-type \
    --version=tpu-vm-tf-2.15.0-pjrt \
    --service-account=

`curl` を使用して TPU VM を作成する

$ curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d "{accelerator_type: 'v4-8', \
  runtime_version:'tpu-vm-tf-2.15.0-pjrt', \
  network_config: {enable_external_ips: true}, \
  shielded_instance_config: { enable_secure_boot: true }}" \
  service_account: {email: ''} \
  https://tpu.googleapis.com/v2/projects/project-id/locations/us-central2-b/nodes?node_id=node_name

カスタムサービスアカウントを使用するには、Google Cloud Storage バケット用のサービスアカウントを承認する必要があります。詳細については、Cloud Storage バケットへの接続をご覧ください。

カスタム VM SSH メソッド

SSH 用にファイアウォールを設定します。

デフォルトのネットワークは、すべての VM への SSH アクセスを許可するようにあらかじめ構成されています。デフォルトのネットワークを使用しない場合や、デフォルトのネットワーク設定が編集されている場合は、ファイアウォールルールを追加して、SSH アクセスを明示的に有効にする必要があります。
```
$ gcloud CLI compute firewall-rules create \
--network=network allow-ssh \
--allow=tcp:22
```
TPU VM に SSH 接続します。
```
$ gcloud compute tpus tpu-vm ssh tpu-name \
--zone=us-central2-b \
--project=project-id
```
必須フィールド
- tpu-name: TPU ノードの名前
- zone: TPU ノードのロケーション。現在、us-central2-b だけがサポートされています。
- project-id: 上記で作成したプロジェクト。
省略可能なフィールドの一覧については、gcloud API のドキュメントをご覧ください。

TPU を管理する

前提条件

Cloud TPU の作成

gcloud を使用した Cloud TPU の作成

TPU VM

コマンドフラグの説明

必須フラグ

TPU ノード

コマンドフラグの説明

gcloud を使用した Cloud TPU のキューに入れられたリソースの作成

起動スクリプトを実行する

Google Cloud コンソールでの Cloud TPU の作成

curl を使用した Cloud TPU VM の作成

必須項目

Cloud TPU への接続

TPU VM

TPU ノード

Cloud TPU リソースの一覧表示

gcloud を使用した Cloud TPU リソースの一覧表示

TPU VM

TPU ノード

Google Cloud コンソールでの Cloud TPU リソースの一覧表示

Cloud TPU に関する情報の取得

gcloud を使用して Cloud TPU に関する情報を取得する

TPU VM

TPU ノード

Google Cloud コンソールで Cloud TPU に関する情報を取得する

Cloud TPU リソースの停止

gcloud を使用した Cloud TPU の停止

TPU VM

TPU ノード

Google Cloud コンソールで Cloud TPU を停止する

Cloud TPU リソースの起動

gcloud を使用した Cloud TPU の起動

TPU VM

TPU ノード

Google Cloud コンソールで Cloud TPU を起動する

Compute Engine VM および Cloud TPU リソースを削除する

gcloud を使用した Cloud TPU の削除

TPU VM

コマンドフラグの説明

TPU ノード

コマンドフラグの説明

Google Cloud コンソールでの Cloud TPU の削除

高度な設定

カスタム ネットワーク リソース

ネットワーク

サブネットワーク

限定公開の Google アクセス

カスタム サービス アカウント

gcloud CLI を使用して TPU VM を作成する

curl を使用して TPU VM を作成する

カスタム VM SSH メソッド

`gcloud` を使用した Cloud TPU の作成

`gcloud` を使用した Cloud TPU のキューに入れられたリソースの作成

`curl` を使用した Cloud TPU VM の作成

`gcloud` を使用した Cloud TPU リソースの一覧表示

`gcloud` を使用して Cloud TPU に関する情報を取得する

`gcloud` を使用した Cloud TPU の停止

`gcloud` を使用した Cloud TPU の起動

`gcloud` を使用した Cloud TPU の削除

カスタムネットワークリソース

カスタムサービスアカウント

`gcloud` CLI を使用して TPU VM を作成する

`curl` を使用して TPU VM を作成する