Comienza a usar Vertex AI TensorBoard

Debe haber una instancia de TensorBoard de Vertex AI, que es un recurso regionalizado que almacena tus experimentos de TensorBoard de Vertex AI, antes de que se puedan visualizar los experimentos. Puedes crear varias instancias de un proyecto (por ejemplo, creadas de forma manual o predeterminada en el SDK del experimento).

Crea una instancia de Vertex AI TensorBoard

SDK de Vertex AI para Python

Crear una instancia de Vertex AI TensorBoard con el SDK de Vertex AI para Python.

SDK de Vertex AI para Python

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

  • project: ID del proyecto Puedes encontrar estos IDs en la página de bienvenida de la consola de Google Cloud.
  • display_name: Proporciona un nombre para tu instancia de TensorBoard.
  • location: Consulta la Lista de ubicaciones disponibles. Asegúrate de usar una región compatible con TensorBoard si creas una instancia de TensorBoard.

Consola de Google Cloud

Sigue estos pasos para crear una instancia de TensorBoard de Vertex AI con la consola de Google Cloud.

  1. Si eres nuevo en Vertex AI o si estás comenzando un proyecto nuevo, configura tu proyecto y tu entorno de desarrollo.
  2. En la sección de Vertex AI de la consola de Google Cloud, ve a la página Experimentos.

    Ir a la página Experimentos.
  3. Navega a la pestaña Instancias de TensorBoard.
  4. Haz clic en Crear en la parte superior de la página.
  5. Selecciona una región de la lista desplegable Región.
  6. Agrega una descripción. (opcional)
  7. Haz clic en Crear para crear la instancia de TensorBoard.

Crea instancia de TensorBoard

CLI de gcloud

Usa la CLI de Google Cloud para crear una instancia de TensorBoard de Vertex AI.
  1. Instala la CLI de gcloud
  2. Inicializa la CLI de Google Cloud mediante la ejecución de gcloud init.
  3. Para confirmar la instalación, explora los comandos.
     gcloud ai tensorboards --help 

    Los comandos incluye create, describe, list y delete. Si es necesario, puedes seguir estos pasos para establecer valores predeterminados para tu proyecto y región antes de continuar.
    Ahora puedes crear una instancia de Vertex AI TensorBoard.
  4. Autentícate en la CLI de gcloud.
    gcloud auth application-default login
  5. Para crear una instancia de Vertex AI TensorBoard, proporciona un nombre de proyecto y un nombre visible. Este paso puede tardar unos minutos en completarse por primera vez en un proyecto. Toma nota del nombre de la instancia de TensorBoard de Vertex AI (por ejemplo: projects/123/locations/us-central1/tensorboards/456) que se imprimirá al final del siguiente comando. La necesitarás en los pasos posteriores.
    gcloud ai tensorboards create --display-name DISPLAY_NAME \
         --project PROJECT_NAME
       

    Reemplaza lo siguiente:
    • PROJECT_NAME: el proyecto en el que deseas crear la instancia de Vertex TensorBoard
    • DISPLAY_NAME: un nombre descriptivo para la instancia de Vertex TensorBoard


Registros de TensorBoard

Vertex AI TensorBoard ofrece Google Cloud CLI y el SDK de Vertex AI para Python a fin de subir registros de TensorBoard. Puedes subir registros desde cualquier entorno que pueda conectarse a Google Cloud.

Crea un entorno virtual (opcional)

Opcional, pero recomendado:

  1. Crea un entorno virtual dedicado para instalar la CLI de Python del cargador de Vertex AI TensorBoard.
python3 -m venv PATH/TO/VIRTUAL/ENVIRONMENT
source PATH/TO/VIRTUAL/ENVIRONMENT/bin/activate
  1. Reemplaza PATH/TO/VIRTUAL/ENVIRONMENT por la ruta a tu entorno virtual dedicado.

Instala el paquete de Vertex AI TensorBoard mediante el SDK de Vertex AI

Para poder realizar la instalación correctamente, la herramienta de carga requiere la versión más reciente de pip.

pip install -U pip
pip install google-cloud-aiplatform[tensorboard]

Sube registros de TensorBoard de Vertex AI

SDK de Vertex AI para Python

Supervisión continua

Llama a aiplatform.start_upload_tb_log al comienzo del entrenamiento. El SDK abre una nueva conversación para subir. Este subproceso continúa supervisando cuando hay datos nuevos en el directorio. Cuando se complete el entrenamiento, llama a end_upload_tb_log, que finaliza el subproceso de carga. Si no se llama a end_upload_tb_log, un tiempo de espera de cierre cierra la conversación.

SDK de Vertex AI para Python

def upload_tensorboard_log_continuously_sample(
    tensorboard_experiment_name: str,
    logdir: str,
    tensorboard_id: str,
    project: str,
    location: str,
    experiment_display_name: Optional[str] = None,
    run_name_prefix: Optional[str] = None,
    description: Optional[str] = None,
) -> None:

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

    # Continuous monitoring
    aiplatform.start_upload_tb_log(
        tensorboard_id=tensorboard_id,
        tensorboard_experiment_name=tensorboard_experiment_name,
        logdir=logdir,
        experiment_display_name=experiment_display_name,
        run_name_prefix=run_name_prefix,
        description=description,
    )
    aiplatform.end_upload_tb_log()

  • tensorboard_experiment_name: El nombre de este experimento.
  • logdir: La ubicación de los registros de TensorBoard que se encuentran en tu sistema de archivos local o en Cloud Storage.
  • tensorboard_id:
    • Para encontrar el tensorboard_id, ve a la sección Vertex AI de la página Experimentos de la consola de Google Cloud y, luego, selecciona la pestaña Instancias de TensorBoard.
      Ir a la página Experimentos

      Crea instancia de TensorBoard
    Si no se establece, se usa el tensorboard_id en aiplatform.init.
  • project: ID del proyecto Puedes encontrar estos IDs en la página de bienvenida de la consola de Google Cloud.
  • location: Consulta Lista de ubicaciones disponibles
  • experiment_display_name: Es el nombre visible del experimento.
  • run_name_prefix: Si está presente, todas las ejecuciones creadas por esta invocación tendrán su nombre con el prefijo de este valor.
  • description: Una descripción de string para asignar al experimento.

Registro único

Llama a aiplatform.upload_tb_log para realizar una carga única de registros de TensorBoard. Sube solo los datos existentes en el registro y, luego, muestra los resultados de inmediato.

SDK de Vertex AI para Python

def upload_tensorboard_log_one_time_sample(
    tensorboard_experiment_name: str,
    logdir: str,
    tensorboard_id: str,
    project: str,
    location: str,
    experiment_display_name: Optional[str] = None,
    run_name_prefix: Optional[str] = None,
    description: Optional[str] = None,
    verbosity: Optional[int] = 1,
) -> None:

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

    # one time upload
    aiplatform.upload_tb_log(
        tensorboard_id=tensorboard_id,
        tensorboard_experiment_name=tensorboard_experiment_name,
        logdir=logdir,
        experiment_display_name=experiment_display_name,
        run_name_prefix=run_name_prefix,
        description=description,
    )

  • tensorboard_experiment_name: Este es el nombre de este experimento de TensorBoard. projects/{project}/locations/{location}/tensorboards/{tensorboard_id}
  • logdir: La ubicación de los registros de TensorBoard que se encuentran en tu sistema de archivos local o en Cloud Storage.
  • tensorboard_id:
    • Para encontrar el tensorboard_id, ve a la sección Vertex AI de la página Experimentos de la consola de Google Cloud y, luego, selecciona la pestaña Instancias de TensorBoard.
      Ir a la página Experimentos

      Crea instancia de TensorBoard
    Si no se establece, se usa el tensorboard_id en aiplatform.init.
  • project: ID del proyecto Puedes encontrar estos IDs en la página de bienvenida de la consola de Google Cloud.
  • location: Consulta Lista de ubicaciones disponibles
  • experiment_display_name: Es el nombre visible del experimento.
  • run_name_prefix: Si está presente, todas las ejecuciones creadas por esta invocación tendrán su nombre con el prefijo de este valor.
  • description: Una descripción de string para asignar al experimento.
  • verbosity: El nivel de verbosidad de las estadísticas, un número entero. Valor admitido: 0 - No se imprimen estadísticas de carga. 1 - Imprime estadísticas de carga mientras se suben datos (predeterminado).

CLI de gcloud


tb-gcp-uploader --tensorboard_resource_name \
  TENSORBOARD_INSTANCE_NAME \
  --logdir=LOG_DIR \
  --experiment_name=TB_EXPERIMENT_NAME --one_shot=True
  • TENSORBOARD_INSTANCE_NAME: Hay dos formas de identificar el nombre de la instancia:
    • El nombre completo se imprime al final del comando gcloud ai tensorboards create que usaste antes.
    • Si la instancia de TensorBoard se creó con la consola de Google Cloud, el TENSORBOARD_INSTANCE_NAME es projects/PROJECT_ID_OR_NUMBER/locations/REGION/tensorboards/TENSORBOARD_INSTANCE_ID.
      • Para encontrar el TENSORBOARD_INSTANCE_ID, ve a la sección Vertex AI de la página Experimentos de la consola de Google Cloud y, luego, selecciona la pestaña Instancias de TensorBoard.
        Ir a la página Experimentos

        Crea instancia de TensorBoard
  • LOG_DIR: Es la ubicación de los registros de eventos, que se encuentra en el sistema de archivos local o en Cloud Storage.
  • TB_EXPERIMENT_NAME: Es el nombre del experimento. por ejemplo test-experiment. El nombre del experimento debe ser único dentro de un recurso de TensorBoard.

De forma predeterminada, la CLI de cargador se ejecuta de forma indefinida y supervisa los cambios en LOG_DIR, y sube los registros recién agregados. --one_shot=True inhabilita el comportamiento. Ejecute tb-gcp-uploader --help para más información.

Ver un experimento de TensorBoard de Vertex AI

Puedes acceder a tu experimento de Vertex AI TensorBoard desde la consola de Google Cloud o, cuando usas el paquete de Vertex AI TensorBoard, Google Cloud CLI genera un vínculo a la instancia de Vertex AI TensorBoard.

Accede a T Vertex AI TensorBoard con la consola de Google Cloud

Puedes acceder a tu experimento de Vertex AI TensorBoard desde la consola de Google Cloud con los siguientes pasos.

  1. En la sección de Vertex AI de la consola de Google Cloud, ve a la página Experimentos.

    Ir a la página Experimentos

  2. En la pestaña Experimentos, desplázate o filtra la lista de experimentos para encontrarlo.

  3. Para abrir la página de la aplicación web de Vertex AI TensorBoard, haz clic en Abrir TensorBoard junto a tu experimento.

Visualiza TensorBoard

Aparecerá la vista de la aplicación web de Vertex AI TensorBoard.

Aparecerá la vista de TensorBoard

Puedes compartir el vínculo a esta vista con otras personas que tengan permiso.

Si usas Vertex AI TensorBoard con entrenamiento personalizado, selecciona el experimento en la página Seguimiento de experimentos. Aparecerá un botón Abrir TensorBoard en la parte superior de la página. Del mismo modo, si usas Vertex AI TensorBoard en un Vertex AI Pipelines, aparece el botón Abrir TensorBoard cuando seleccionas el componente asociado.

Además, cuando se usa el paquete de Vertex AI TensorBoard, Google Cloud CLI genera un vínculo a la instancia Vertex AI TensorBoard en las primeras líneas del registro en el que puedes ver el experimento. Por ejemplo: View your TensorBoard at https://us-central1.tensorboard.googleusercontent.com/experiment/projects+123+locations+us-central1+tensorboards+4567+experiments+my-experiment-name

Notebooks

¿Qué sigue?