設定 Vertex AI TensorBoard

設定 Vertex AI TensorBoard 時，必須具備下列項目：

1. 建立具備必要權限的服務帳戶。
2. 建立 Cloud Storage 值區來儲存 Vertex AI TensorBoard 記錄檔。
3. 建立 Vertex AI TensorBoard 執行個體。

建立具備必要權限的服務帳戶

如要將 Vertex AI TensorBoard 與自訂訓練整合，您必須附加服務帳戶。

1. 建立服務帳戶：

   gcloud --project=PROJECT_ID iam service-accounts create USER_SA_NAME
   

   更改下列內容：

   • PROJECT_ID：您要建立服務帳戶的專案 ID。

   • USER_SA_NAME：您要建立的服務帳戶專屬名稱。

2. Vertex AI 訓練服務會使用新的服務帳戶存取 Google Cloud 服務和資源。視需要使用下列指令授予這些角色：

   SA_EMAIL="USER_SA_NAME@PROJECT_ID.iam.gserviceaccount.com"
   
   gcloud projects add-iam-policy-binding PROJECT_ID \
      --member="serviceAccount:${SA_EMAIL}" \
      --role="roles/storage.admin"
   
   gcloud projects add-iam-policy-binding PROJECT_ID \
      --member="serviceAccount:${SA_EMAIL}" \
      --role="roles/aiplatform.user"
   

建立 Cloud Storage 值區來儲存 Vertex AI TensorBoard 記錄

您需要 Cloud Storage 值區來儲存訓練指令碼產生的 Vertex AI TensorBoard 記錄。值區必須是地區 (即非多地區或雙地區)，且下列資源必須位於相同的地區：

• Cloud Storage 值區
• Vertex AI 訓練工作
• Vertex AI TensorBoard 執行個體

您可以使用現有值區，而不需要按照本文所述的步驟建立值區。使用現有值區時，值區的位置必須與 Vertex AI TensorBoard 執行個體建立的位置相同。

GCS_BUCKET_NAME="PROJECT_ID-tensorboard-logs-LOCATION_ID"
gcloud storage buckets create "gs://${GCS_BUCKET_NAME}" --location=LOCATION_ID

將 LOCATION_ID 替換為 Vertex AI TensorBoard 執行個體建立的位置，例如 us-central1。

GCS_BUCKET_NAME 可用於使用 REST 建立自訂訓練工作。

建立 Vertex AI TensorBoard 執行個體

您必須先建立 Vertex AI TensorBoard 執行個體 (這是用於儲存 Vertex AI TensorBoard 實驗的區域資源)，才能以視覺化方式呈現實驗。有兩種方法。您可以使用預設執行個體，也可以手動建立執行個體。您可以在專案和區域中建立多個執行個體，但大多數使用者只需要一個執行個體。

使用預設的 Vertex AI TensorBoard 執行個體

初始化 Vertex AI 實驗時，系統會自動建立預設的 TensorBoard 例項。這個後端 TensorBoard 會與 Vertex AI 實驗建立關聯，並用於所有後續的 Vertex AI 實驗執行作業。您可以直接從實驗中擷取 tensorboard_resource_name。這是開始使用 Vertex AI TensorBoard 最簡單的方式，應該能滿足大多數使用者的需求。

from google.cloud import aiplatform


def create_experiment_default_tensorboard_sample(
    experiment_name: str,
    experiment_description: str,
    project: str,
    location: str,
):
    aiplatform.init(
        experiment=experiment_name,
        experiment_description=experiment_description,
        project=project,
        location=location,
    )

    tensorboard = aiplatform.Experiment(experiment_name).get_backing_tensorboard_resource()
    print(f"Tensorboard resource name: {tensorboard.name}")

手動建立 Vertex AI TensorBoard 執行個體

您可以手動建立 Vertex AI TensorBoard。這對使用者來說很有幫助，因為使用者可以更輕鬆地使用 Google Cloud 控制台，或是需要使用 CMEK 啟用 TensorBoard 的使用者 (請參閱 CMEK)，或是想要使用多個 TensorBoard 的使用者。您可以在初始化 Vertex AI 實驗、啟動實驗執行作業或設定訓練程式碼時，直接指定這個例項。

def create_tensorboard_sample(
    project: str,
    location: str,
    display_name: Optional[str] = None,
):
    aiplatform.init(project=project, location=location)

    tensorboard = aiplatform.Tensorboard.create(
        display_name=display_name,
        project=project,
        location=location,
    )

    aiplatform.init(
        project=project,
        location=location,
        experiment_tensorboard=tensorboard
    )

    return tensorboard

resource "google_vertex_ai_tensorboard" "default" {
  display_name = "vertex-ai-tensorboard-sample-name"
  region       = "us-central1"
}

刪除 TensorBoard 執行個體

刪除 TensorBoard 執行個體會刪除該 TensorBoard 和所有相關聯的 TensorBoard 實驗和 TensorBoard 執行作業。與執行個體相關聯的 Vertex AI 實驗不會遭到刪除。

如要刪除 Vertex AI Experiments 及其相關的 Vertex AI TensorBoard 實驗，請參閱「刪除實驗」。

def delete_tensorboard_instance_sample(
    tensorboard_resource_name: str,
    project: str,
    location: str,
):
    aiplatform.init(project=project, location=location)

    tensorboard = aiplatform.Tensorboard(
        tensorboard_name=tensorboard_resource_name
    )

    tensorboard.delete()

相關字詞

這些字詞 (「TensorBoard 資源名稱」和「TensorBoard 執行個體 ID」) 在許多範例中都有提及。

TensorBoard 資源名稱

TensorBoard 資源名稱可用於完整識別 Vertex AI TensorBoard 執行個體。格式如下：

projects/PROJECT_ID_OR_NUMBER/locations/REGION/tensorboards/TENSORBOARD_INSTANCE_ID

使用 gcloud CLI 或 Vertex AI SDK 建立 TensorBoard 時，記錄訊息會顯示 TensorBoard 資源名稱，也可以為預留位置提供適當的值來建立 TensorBoard。

from google.cloud import aiplatform


def get_experiment_backing_tensorboard_sample(
    experiment_name: str,
    project: str,
    location: str,
):
    backing_tensorboard = aiplatform.Experiment(
        project=project,
        location=location,
        experiment_name=experiment_name
    ).get_backing_tensorboard_resource()

    return backing_tensorboard.name

TensorBoard 執行個體 ID

TensorBoard 執行個體 ID 是與 TensorBoard 執行個體相關聯的產生 ID 值。如要找出 TENSORBOARD_INSTANCE_ID，請前往 Google Cloud 控制台的「Experiments」頁面「Vertex AI」專區，然後選取「TensorBoard Instances」分頁標籤。

您也可以從 TensorBoard 資源名稱擷取執行個體 ID。