Configurar Vertex AI TensorBoard

Para configurar Vertex AI TensorBoard, debes cumplir los siguientes requisitos:

1. Crea una cuenta de servicio con los permisos necesarios.
2. Crea un segmento de Cloud Storage para almacenar los registros de Vertex AI TensorBoard.
3. Crea una instancia de Vertex AI TensorBoard.

Crear una cuenta de servicio con los permisos necesarios

Para integrar Vertex AI TensorBoard con el entrenamiento personalizado, es necesario asociar una cuenta de servicio.

1. Crea una cuenta de servicio:

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

   Haz los cambios siguientes:

   • PROJECT_ID: el ID del proyecto en el que vas a crear una cuenta de servicio.

   • USER_SA_NAME: un nombre único para la cuenta de servicio que vas a crear.

2. El servicio Vertex AI Training utiliza la nueva cuenta de servicio para acceder a Google Cloud servicios y recursos. Usa los siguientes comandos para asignar estos roles si es necesario:

   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"
   

Crear un segmento de Cloud Storage para almacenar los registros de Vertex AI TensorBoard

Se necesita un segmento de Cloud Storage para almacenar los registros de Vertex AI TensorBoard que genera tu secuencia de comandos de entrenamiento. El segmento debe ser regional, es decir, no multirregional ni birregional, y los siguientes recursos deben estar en la misma región:

• Segmento de Cloud Storage
• Tarea de entrenamiento de Vertex AI
• Instancia de Vertex AI TensorBoard

Puedes usar un segmento que ya tengas en lugar de seguir el paso para crear un segmento que se describe aquí. Si usas un bucket, su ubicación debe ser la misma en la que se creó tu instancia de Vertex AI TensorBoard.

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

Sustituye LOCATION_ID por la ubicación en la que se creó tu instancia de Vertex AI TensorBoard (por ejemplo, us-central1).

GCS_BUCKET_NAME se usa para crear una tarea de entrenamiento personalizada con REST.

Crear una instancia de Vertex AI TensorBoard

Para poder visualizar los experimentos, debe haber una instancia de Vertex AI TensorBoard, que es un recurso regionalizado que almacena los experimentos de Vertex AI TensorBoard. Tienes dos opciones. Puedes usar una instancia predeterminada o crear una manualmente. Puedes crear varias instancias en un proyecto y una región, pero la mayoría de los usuarios solo necesitan una instancia.

Usar la instancia predeterminada de Vertex AI TensorBoard

Al inicializar un experimento de Vertex AI, se crea automáticamente una instancia de TensorBoard predeterminada. Este TensorBoard de respaldo está asociado al experimento de Vertex AI y se usa con todas las ejecuciones posteriores de experimentos de Vertex AI. El tensorboard_resource_name se puede recuperar directamente del experimento. Esta es la forma más sencilla de empezar a usar Vertex AI TensorBoard y debería satisfacer las necesidades de la mayoría de los usuarios.

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}")

Crear manualmente una instancia de Vertex AI TensorBoard

Puedes crear manualmente un Vertex AI TensorBoard. Esto resulta útil para los usuarios que se sienten más cómodos con la consola Google Cloud , los que necesitan un TensorBoard con CMEK habilitado (consulta CMEK) o los que quieren usar varios TensorBoards. Esta instancia se puede especificar directamente al inicializar un experimento de Vertex AI, iniciar una ejecución de experimento o configurar el código de entrenamiento.

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"
}

Eliminar una instancia de TensorBoard

Si eliminas una instancia de TensorBoard, se eliminará esa instancia y todos los experimentos y ejecuciones de TensorBoard asociados. Los experimentos de Vertex AI a los que está asociada la instancia no se eliminan.

Para eliminar un experimento de Vertex AI y los experimentos de Vertex AI TensorBoard asociados, consulta Eliminar un experimento.

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

Términos relevantes

Estos términos, "nombre de recurso de TensorBoard" e "ID de instancia de TensorBoard", se mencionan en numerosos ejemplos.

Nombre del recurso de TensorBoard

El nombre de recurso de TensorBoard se usa para identificar por completo la instancia de Vertex AI TensorBoard. El formato es el siguiente:

projects/PROJECT_ID_OR_NUMBER/locations/REGION/tensorboards/TENSORBOARD_INSTANCE_ID

El nombre del recurso TensorBoard se imprime en los mensajes de registro cuando se crea con la CLI de gcloud o el SDK de Vertex AI. También se puede crear proporcionando los valores adecuados para los marcadores de posición.

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

ID de instancia de TensorBoard

El ID de instancia de TensorBoard es un valor de ID generado asociado a una instancia de TensorBoard. Para encontrar el TENSORBOARD_INSTANCE_ID, ve a la sección Vertex AI de la página Experiments (Experimentos) de la Google Cloud consola y selecciona la pestaña TensorBoard Instances (Instancias de TensorBoard).

También puedes obtener el ID de instancia a partir del nombre de recurso de TensorBoard.