Crea una plantilla de entorno de ejecución

En esta página, se muestra cómo crear una plantilla de entorno de ejecución en Colab Enterprise.

Para ejecutar código en tu notebook, usa un recurso de procesamiento llamado entorno de ejecución. Puedes usar el entorno de ejecución predeterminado o uno creado a partir de una plantilla del entorno de ejecución. Cuando creas una plantilla de entorno de ejecución, puedes configurarla para optimizar el rendimiento, el costo y otras características del entorno de ejecución según tus necesidades.

Obtén más información sobre los entornos de ejecución y las plantillas de entorno de ejecución.

Antes de comenzar

Accede a tu Google Cloud cuenta de. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Dataform, and Compute Engine APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Dataform, and Compute Engine APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Roles obligatorios

Para obtener los permisos que necesitas para crear una plantilla de entorno de ejecución en Colab Enterprise, pídele a tu administrador que te otorgue el rol de IAM de administrador de Colab Enterprise (roles/aiplatform.colabEnterpriseAdmin) en el proyecto. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

Uno o más de los roles necesarios incluyen el permiso dataform.repositories.list. Los usuarios a los que se les otorgó el permiso dataform.repositories.list o el rol Creador de código (roles/dataform.codeCreator) en un proyecto pueden enumerar los nombres de los elementos de código de ese proyecto mediante la API de Dataform o la interfaz de línea de comandos (CLI) de Dataform. Los usuarios que no son administradores que usan BigQuery Studio solo pueden ver los elementos de código que crearon o que se compartieron con ellos.

Crea la plantilla de entorno de ejecución

Para crear una plantilla de entorno de ejecución, puedes usar la Google Cloud consola, Google Cloud CLI, la API de REST o Terraform.

Console

Para crear una plantilla de entorno de ejecución, sigue estos pasos:

En la Google Cloud consola, ve a la página Plantillas de entorno de ejecución de Colab Enterprise.

Ir a Plantillas de entorno de ejecución
Haz clic en Plantilla nueva.

Aparecerá el cuadro de diálogo Crear nueva plantilla de entorno de ejecución.

Conceptos básicos del entorno de ejecución

En la sección Conceptos básicos del entorno de ejecución, ingresa un Nombre visible.
En el menú Región, selecciona la región en la que deseas que se ejecute el entorno de ejecución.
Opcional: Agrega una Descripción de tu plantilla de entorno de ejecución.
Opcional: Para agregar una etiqueta, haz clic en Agregar etiqueta y, luego, ingresa un par de Clave y Valor. Para agregar más etiquetas, repite este paso.
Haz clic en Continuar.

Configura el procesamiento

En la sección Configurar procesamiento, en el menú Tipo de máquina, selecciona un tipo de máquina. Para obtener información sobre los tipos de máquina, consulta la guía de comparaciones y recursos de familias de máquinas.

Si seleccionas un tipo de máquina que tiene GPU, selecciona el Tipo de acelerador y Recuento de acelerador. Si no puedes seleccionar la cantidad de GPU que deseas, es posible que debas aumentar tu cuota. Consulta Solicita un ajuste de cuota.
En el menú Tipo de disco de datos, selecciona un tipo de disco.
En el campo Tamaño del disco de datos, ingresa un tamaño en GB.
En la sección Cierre inactivo , haz lo siguiente:
- Para desactivar el cierre inactivo, borra Habilitar el cierre inactivo.
- Para cambiar el período de inactividad, en Tiempo de inactividad antes del cierre (Minutos), cambia la cifra a la cantidad de minutos de inactividad que deseas. En la Google Cloud consola, esta configuración se puede establecer con cualquier valor de número entero entre 10 y 1440.
Haz clic en Continuar.

Entorno

En la sección Entorno, selecciona un Entorno. La opción predeterminada es Más reciente (actualmente Python 3.12).
Opcional: En el campo Secuencia de comandos posterior al inicio, ingresa el URI de una secuencia de comandos posterior al inicio. Para obtener más información sobre el uso de una secuencia de comandos posterior al inicio, consulta Usa una secuencia de comandos posterior al inicio.
Opcional: En la URL de la secuencia de comandos posterior al inicio, selecciona el comportamiento de la secuencia de comandos posterior al inicio. El comportamiento predeterminado es Ejecutar una vez. Para obtener más información, consulta Comportamiento de la secuencia de comandos posterior al inicio.
Opcional: Para agregar una variable de entorno, haz clic en Agregar variable de entorno, y, luego, ingresa un par de Clave y Valor. Para agregar más variables de entorno, repite este paso.
Haz clic en Continuar.

Herramientas de redes y seguridad

En la sección Herramientas de redes y seguridad, en el menú Red, selecciona una red. Si no seleccionas una red, se seleccionará la red predeterminada.
En el menú Subred, selecciona una subred.
Para desactivar el acceso a Internet pública, desmarca Habilitar el acceso a Internet pública.
Para desactivar el acceso de credenciales de usuario final, desmarca Habilitar credenciales de usuario final.

Termina de crear la plantilla de entorno de ejecución

Haz clic en Crear para terminar de crear la plantilla de entorno de ejecución.

Tu plantilla de entorno de ejecución aparece en la lista en la pestaña Plantillas de entorno de ejecución.

gcloud

Antes de usar cualquiera de los datos de comando a continuación, realiza los siguientes reemplazos:

DISPLAY_NAME: el nombre visible de tu plantilla de entorno de ejecución
PROJECT_ID: el ID de tu proyecto
REGION: la región en la que deseas que se ejecute el entorno de ejecución
MACHINE_TYPE: el tipo de máquina que se usará para tu entorno de ejecución
ACCELERATOR_TYPE: el tipo de acelerador de hardware que se usará para tu entorno de ejecución
ACCELERATOR_COUNT: la cantidad de aceleradores que se usarán para tu entorno de ejecución

Ejecuta el siguiente comando:

Linux, macOS o Cloud Shell

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" \
    --project=PROJECT_ID \
    --region=REGION \
    --machine-type=MACHINE_TYPE \
    --accelerator-type=ACCELERATOR_TYPE \
    --accelerator-count=ACCELERATOR_COUNT

Windows (PowerShell)

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" `
    --project=PROJECT_ID `
    --region=REGION `
    --machine-type=MACHINE_TYPE `
    --accelerator-type=ACCELERATOR_TYPE `
    --accelerator-count=ACCELERATOR_COUNT

Windows (cmd.exe)

gcloud colab runtime-templates create --display-name="DISPLAY_NAME" ^
    --project=PROJECT_ID ^
    --region=REGION ^
    --machine-type=MACHINE_TYPE ^
    --accelerator-type=ACCELERATOR_TYPE ^
    --accelerator-count=ACCELERATOR_COUNT

Si deseas obtener más información sobre el comando para crear una plantilla de entorno de ejecución desde la línea de comandos, consulta la documentación de gcloud CLI.

REST

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

REGION: la región en la que deseas que se ejecute el entorno de ejecución
PROJECT_ID: el ID de tu proyecto
DISPLAY_NAME: el nombre visible de tu plantilla de entorno de ejecución
MACHINE_TYPE: el tipo de máquina que se usará para tu entorno de ejecución
ACCELERATOR_TYPE: el tipo de acelerador de hardware que se usará para tu entorno de ejecución
ACCELERATOR_COUNT: la cantidad de aceleradores que se usarán para tu entorno de ejecución

Método HTTP y URL:

POST https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates

Cuerpo JSON de la solicitud:

{
  "displayName": "DISPLAY_NAME",
  "machineSpec": {
    {
      "machineType": MACHINE_TYPE
      "acceleratorType": ACCELERATOR_TYPE,
      "acceleratorCount": ACCELERATOR_COUNT,
    }
  },
}

Para enviar tu solicitud, elige una de estas opciones:

curl

Nota: Con el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login, o a través del uso de Cloud Shell, que accede de forma automática a la CLI de gcloud. Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates"

PowerShell

Nota: En el siguiente comando, se supone que accediste a la CLI de gcloud con tu cuenta de usuario a través de la ejecución de gcloud init o gcloud auth login . Para comprobar la cuenta activa actual, ejecuta gcloud auth list.

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://REGION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/notebookRuntimeTemplates" | Select-Object -Expand Content

Si se ejecuta correctamente, el cuerpo de la respuesta contiene una instancia de operación.

Para obtener más información, consulta la documentación de la API de REST notebookRuntimeTemplates.create.

Terraform

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform. Para obtener más información, consulta la Terraform documentación de referencia del proveedor.

En el siguiente ejemplo, se usa el google_colab_runtime_template recurso de Terraform para crear una plantilla de entorno de ejecución de Colab Enterprise.

resource "google_compute_network" "my_network" {
  name = "{{index $.Vars "network_name"}}"
  auto_create_subnetworks = false
}

resource "google_compute_subnetwork" "my_subnetwork" {
  name   = "{{index $.Vars "network_name"}}"
  network = google_compute_network.my_network.id
  region = "us-central1"
  ip_cidr_range = "10.0.1.0/24"
}

resource "google_colab_runtime_template" "{{$.PrimaryResourceId}}" {
  name        = "{{index $.Vars "runtime_template_name"}}"
  display_name = "Runtime template full"
  location    = "us-central1"
  description = "Full runtime template"
  machine_spec {
    machine_type     = "n1-standard-2"
    accelerator_type = "NVIDIA_TESLA_T4"
    accelerator_count = "1"
  }

  data_persistent_disk_spec {
    disk_type    = "pd-standard"
    disk_size_gb = 200
  }

  network_spec {
    enable_internet_access = true
    network = google_compute_network.my_network.id
    subnetwork = google_compute_subnetwork.my_subnetwork.id
  }

  labels = {
    k = "val"
  }

  idle_shutdown_config {
    idle_timeout = "3600s"
  }

  euc_config {
    euc_disabled = false
  }

  shielded_vm_config {
    enable_secure_boot = false
  }

  network_tags = ["abc", "def"]

  encryption_spec {
    kms_key_name = "{{index $.Vars "key_name"}}"
  }

  software_config {
    env {
      name    = "TEST"
      value   = 1
    }

    post_startup_script_config {
      post_startup_script = "echo 'hello world'"
      post_startup_script_url = "gs://colab-enterprise-pss-secure/secure_pss.sh"
      post_startup_script_behavior = "RUN_ONCE"
    }

    colab_image {
      release_name = "py312"
    }
  }
}

Otorga acceso a la plantilla de entorno de ejecución

Después de crear una plantilla de entorno de ejecución, debes otorgarle acceso para que una principal pueda usarla. Una principal puede crear un entorno de ejecución a partir de una plantilla de entorno de ejecución solo cuando tiene lo siguiente:

Acceso a la plantilla del entorno de ejecución.
Los permisos necesarios para crear entornos de ejecución

Consulta Administra el acceso a una plantilla de entorno de ejecución.

Usa Colab Enterprise en una red de VPC compartida

Cuando creas una plantilla de entorno de ejecución o un entorno de ejecución en un proyecto de servicio de una red de VPC compartida, debes otorgar al agente de servicio de Vertex AI (service-SERVICE_PROJECT_NUMBER@gcp-sa-aiplatform.iam.gserviceaccount.com) permisos específicos en el proyecto host. Estos permisos se usan para hacer lo siguiente:

Validar la existencia y la accesibilidad de tu red y subred cuando creas la plantilla de entorno de ejecución
Aprovisionar la instancia de VM de Compute Engine subyacente dentro de la red de VPC compartida cuando creas un entorno de ejecución

Para asegurarte de que el agente de servicio de Vertex AI tenga los permisos necesarios para habilitar el uso de una plantilla de entorno de ejecución y un entorno de ejecución dentro de una red de VPC compartida, pídele a tu administrador que otorgue el rol de IAM de usuario de la red de Compute (roles/compute.networkUser) al agente de servicio de Vertex AI en el proyecto host.

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Es posible que tu administrador también pueda otorgar los permisos necesarios al agente de servicio de Vertex AI a través de roles personalizados o cualquier otro rol predefinido.

Programa ejecuciones de notebooks en una red de VPC compartida

Si deseas usar el programador de notebooks con una plantilla de entorno de ejecución o un entorno de ejecución en un proyecto de servicio de una red de VPC compartida, debes otorgar al agente de servicio de Colab Enterprise (service-SERVICE_PROJECT_NUMBER@gcp-sa-vertex-nb.iam.gserviceaccount.com) permisos específicos en el proyecto host. Estos permisos se usan para crear la VM de Compute Engine subyacente.

Para asegurarte de que el agente de servicio de Colab Enterprise tenga los permisos necesarios para usar notebooks programados dentro de una red de VPC compartida, pídele a tu administrador que otorgue el rol de IAM de usuario de la red de Compute (roles/compute.networkUser) al agente de servicio de Colab Enterprise en el proyecto host.

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Es posible que tu administrador también pueda otorgar los permisos necesarios al agente de servicio de Colab Enterprise a través de roles personalizados o cualquier otro rol predefinido.

Borra una plantilla de entorno de ejecución

Para borrar una plantilla de entorno de ejecución, sigue estos pasos:

En la Google Cloud consola, ve a la página Plantillas de entorno de ejecución de Colab Enterprise.

Ir a Plantillas de entorno de ejecución
En el menú Región, selecciona la región que contiene tu plantilla de entorno de ejecución.
Selecciona la plantilla de entorno de ejecución que deseas borrar.
Haz clic en Borrar.
Haz clic en Confirmar.

Solucionar problemas

En esta sección, se muestra cómo resolver problemas con la creación de plantillas de entorno de ejecución en Colab Enterprise.

No se pueden seleccionar suficientes GPU

Mientras creas una plantilla de entorno de ejecución, no puedes seleccionar la cantidad de GPU que deseas. Esto puede deberse a que no tienes suficiente cuota.

Colab Enterprise usa la cuota de Compute Engine para las GPU. Para obtener más información, consulta la descripción general de los límites y la cuota de Compute Engine.

Para resolver este problema, solicita un ajuste de cuota.

¿Qué sigue?

Obtén más información sobre los entornos de ejecución y las plantillas de entorno de ejecución.
Aprende a crear un entorno de ejecución basado en una plantilla del entorno de ejecución.