Vertex AI TensorBoard einrichten

Für die Einrichtung von Vertex AI TensorBoard sind Folgendes erforderlich:

1. Erstellen Sie ein Dienstkonto mit den erforderlichen Berechtigungen.
2. Erstellen Sie einen Cloud Storage-Bucket zum Speichern von Vertex AI TensorBoard-Logs.
3. Erstellen Sie eine Vertex AI TensorBoard-Instanz.

Erstellen Sie ein Dienstkonto mit den erforderlichen Berechtigungen.

Für die Einbindung von Vertex AI TensorBoard in benutzerdefiniertes Training ist das Anhängen eines Dienstkonto erforderlich.

1. Erstellen Sie ein Dienstkonto:

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

   Ersetzen Sie dabei Folgendes:

   • PROJECT_ID: die ID des Projekts, in dem Sie ein Dienstkonto erstellen.

   • USER_SA_NAME: Eindeutiger Name für das erstellte Dienstkonto.

2. Das neue Dienstkonto wird vom Vertex AI-Trainingsdienst für den Zugriff auf Google Cloud-Dienste und -Ressourcen verwendet. Verwenden Sie die folgenden Befehle, um diese Rollen bei Bedarf zuzuweisen:

   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-Bucket zum Speichern von Vertex AI TensorBoard-Logs erstellen

Zum Speichern der von Ihrem Trainingsskript generierten Vertex AI TensorBoard-Logs ist ein Cloud Storage-Bucket erforderlich. Der Bucket muss regional sein, d. h. er darf nicht für eine Mehrfachregion oder Dual-Region festgelegt werden und die folgenden Ressourcen müssen sich alle in derselben Region befinden:

• Cloud Storage-Bucket
• Vertex AI-Trainingsjob
• Vertex AI TensorBoard-Instanz

Sie können einen vorhandenen Bucket verwenden, anstatt den hier beschriebenen Schritt zur Erstellung des Buckets auszuführen. Wenn Sie einen vorhandenen Bucket verwenden, muss der Standort des Buckets mit dem Standort übereinstimmen, an dem Ihre Vertex AI TensorBoard-Instanz erstellt wurde.

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

Ersetzen Sie LOCATION_ID durch den Standort, an dem die Vertex AI TensorBoard-Instanz erstellt wurde. Beispiel: us-central1.

Vertex AI TensorBoard-Instanz erstellen

Eine Vertex AI TensorBoard-Instanz ist eine regionale Ressource, in der Ihre Vertex AI TensorBoard-Tests gespeichert werden. Sie muss vorhanden sein, bevor die Tests visualisiert werden können. Sie haben zwei Möglichkeiten zur Auswahl. Sie können entweder eine Standardinstanz verwenden oder eine manuell erstellen. Sie können innerhalb eines Projekts und einer Region mehrere Instanzen erstellen. Die meisten Nutzer benötigen jedoch nur eine einzige Instanz.

Standard-Vertex AI TensorBoard-Instanz verwenden

Beim Initialisieren eines Vertex AI-Tests wird automatisch eine Standard-TensorBoard-Instanz erstellt. Dieses unterstützende TensorBoard ist mit dem Vertex AI-Test verknüpft und wird für alle nachfolgenden Vertex AI-Testausführungen verwendet. Die tensorboard_resource_name kann direkt aus dem Test abgerufen werden. Dies ist der einfachste Einstieg in Vertex AI TensorBoard und sollte den Anforderungen der meisten Nutzer entsprechen.

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-Instanz manuell erstellen

Sie können ein Vertex AI TensorBoard manuell erstellen. Dies ist nützlich, wenn Nutzer eher mit der Google Cloud Console vertraut sind, wenn Nutzer ein CMEK-fähiges TensorBoard benötigen (siehe CMEK) oder für Nutzer, die mehrere TensorBoards verwenden möchten. Diese Instanz kann dann direkt angegeben werden, wenn Sie einen Vertex AI-Test initialisieren, eine Testausführung starten oder den Trainingscode konfigurieren.

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-Instanz löschen

Wenn Sie eine TensorBoard-Instanz löschen, werden dieses TensorBoard und alle zugehörigen TensorBoard-Tests und TensorBoard-Ausführungen gelöscht. Die Vertex AI-Tests, mit denen die Instanz verknüpft ist, werden nicht gelöscht.

Informationen zum Löschen von einem Vertex AI-Test und seinen zugehörigen Vertex AI TensorBoard-Tests finden Sie unter Test löschen.

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

Relevante Begriffe

Auf diese Begriffe, „TensorBoard-Ressourcenname“ und „TensorBoard-Instanz-ID“ wird in zahlreichen Beispielen verwiesen.

Name der TensorBoard-Ressource

Mit dem TensorBoard-Ressourcennamen wird die Vertex AI TensorBoard-Instanz vollständig identifiziert. Das Format dafür ist:

projects/PROJECT_ID_OR_NUMBER/locations/REGION/tensorboards/TENSORBOARD_INSTANCE_ID

Der TensorBoard-Ressourcenname wird in den Logeinträgen ausgegeben, wenn er mit der gcloud CLI oder dem Vertex AI SDK erstellt wird. Er kann auch erstellt werden, indem die entsprechenden Werte für die Platzhalter angegeben werden.

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-Instanz-ID

Die TensorBoard-Instanz-ID ist ein generierter ID-Wert, der mit einer TensorBoard-Instanz verknüpft ist. Um TENSORBOARD_INSTANCE_ID zu finden, rufen Sie in der Google Cloud Console den Abschnitt „Tests“ von Vertex AI auf und wählen Sie den Tab TensorBoard-Instanzen aus.

Sie können die Instanz-ID auch aus dem TensorBoard-Ressourcennamen abrufen.