设置 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 Training 服务会使用该新的服务账号来访问 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 实例

您可以使用现有存储桶，而不是按照此处所述的存储桶创建步骤执行操作。使用现有存储桶时，该存储桶的 REGION 必须与创建 Vertex AI TensorBoard 实例所在的区域相同。

LOCATION=LOCATION_ID
GCS_BUCKET_NAME="PROJECT_ID-tensorboard-logs-${LOCATION_ID}"
gsutil mb -l ${LOCATION_ID} "gs://${GCS_BUCKET_NAME}"

将 LOCATION_ID 替换为在其中创建 Vertex AI TensorBoard 实例的区域，例如 us-central1。

创建 Vertex AI TensorBoard 实例

必须先存在 Vertex AI TensorBoard 实例（该实例是存储 Vertex AI TensorBoard 实验的区域化资源），然后才能直观呈现实验。具体有两种方案可供选择。您可以使用默认实例，也可以手动创建一个。您可以在项目和区域中创建多个实例，但大多数用户只需要单个实例。

使用默认 Vertex AI TensorBoard 实例

初始化 Vertex AI 实验时，系统会自动创建默认的 TensorBoard 实例。此支持性 TensorBoard 与 Vertex AI 实验关联，并与所有后续 Vertex AI Experiments 运行搭配使用。这是 Vertex AI TensorBoard 的最简单入门方式，应满足大多数用户的需求。

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,
    )

手动创建 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 Experiments 不会删除。

如需删除 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 实例 ID

TensorBoard 实例 ID 是与 TensorBoard 实例关联的生成的 ID 值。如需查找 TENSORBOARD_INSTANCE_ID，请转到 Google Cloud 控制台的 Vertex AI 部分中的“实验”页面，然后选择 TensorBoard 实例标签页。