Referencia de CTPU

Descripción general

Importante: La herramienta ctpu dejó de estar disponible y la funcionalidad de la herramienta se reemplazó por los comandos gcloud compute tpus correspondientes.

La herramienta de código abierto ctpu se usa para crear un conjunto de recursos de procesamiento, que consisten en una VM de Compute Engine y uno o más dispositivos de Cloud TPU. La herramienta está preinstalada en tu Cloud Shell.

Puedes encontrar la documentación y el código para ctpu en GitHub.

La herramienta ctpu usa la siguiente sintaxis:

ctpu <subcommand> <flags> <subcommand> <subcommand args> 

A continuación, se presentan los subcomandos para ctpu:

auth

Descripción

Configura o muestra las autorizaciones para las Cloud TPU.

Uso

ctpu auth <flags> <subcommand> <subcommand args>

Ejemplo

ctpu auth list --project="my-project" --zone=us-central1-a
ctpu auth list --project my-project --zone us-central1-a

Subcomandos

El comando ctpu auth es compatible con los siguientes subcomandos:

• add-bigtable: asegura que Cloud TPU está autorizado para Cloud Bigtable.
• add-gcs: Asegura que Cloud TPU esté autorizado para Cloud Storage.
• list: Muestra las autorizaciones de la cuenta de servicio Cloud TPU.
• commands: Enumera todos los nombres de los comandos
• flags: Describe todas las marcas de nivel superior conocidas.
• help: Describe subcomandos y su sintaxis.

Marcas opcionales

A continuación, se presentan los comandos opcionales para ctpu auth name | project | zone.

delete (rm)

Descripción

Borra la VM de Compute Engine y la Cloud TPU.

Uso

ctpu rm <flags>

Ejemplo

ctpu rm --zone=us-central1-b

help

Descripción

Enumera todos los subcomandos ctpu y las marcas de nivel superior.

Uso

ctpu help
ctpu help <subcommand>

Ejemplo

ctpu help   // list all ctpu subcommands and top level flags

ctpu help auth   // list all flags that can be used with `ctpu auth`
ctpu help up   // list all flags that can be used with `ctpu up`

list (ls)

Descripción

Enumera todas las VM de Compute Engine y las Cloud TPU en la zona especificada.

Uso

ctpu ls <flags>

Ejemplo

ctpu ls --zone=us-central1-b

pause (zz)

Descripción

Detiene la VM de Compute Engine y borra la Cloud TPU. Hace que se deje de cobrar por el uso de Cloud TPU hasta que ejecutes ctpu up.

Para asegurarte de que la Cloud TPU se detenga, debes especificar la zona y el nombre de Cloud TPU en la línea de comandos.

Importante: Se te cobrará por el espacio en el disco que ocupe la VM mientras esté en pausa.

Uso

ctpu pause <name, zone>

Ejemplo

ctpu pause --name=my-tpu --zone=us-central1-a  // pause the named TPU
in the specified zone

print-config (cfg)

Descripción

Imprime en pantalla la configuración actual del nombre de la Cloud TPU, el nombre del proyecto y la zona.

Ejemplo

ctpu print-config

quota

Descripción

Muestra una URL en la que puedes ver las cuotas.

Uso

ctpu quota

Ejemplo

ctpu quota
Output: Quotas cannot currently be displayed within ctpu.
To view your quota, open <url>
Request additional quota from <url>

restart

Descripción

Reinicia una Cloud TPU que aún se encuentra en el estado EN EJECUCIÓN (se muestra en ctpu status), pero que se detuvo debido a un problema de hardware. Usa gcloud compute tpu start o el START en Compute Engine > Página TPU en la consola de Cloud si la TPU está en el estado STOPPED.

restart no reinicia una Cloud TPU interrumpida. Debes ejecutar ctpu delete y ctpu up si se interrumpió la Cloud TPU.

Uso

ctpu restart <flags>

Ejemplo

ctpu restart --zone=us-central1-a

status (st)

Descripción

Consulta las API de GCP (solo zona predeterminada) para determinar el estado actual de la Cloud TPU y la VM de Compute Engine.

Importante: Si los recursos se ejecutan en una región o zona no predeterminadas, debes especificar la marca “--zone”.

Uso

ctpu st

Ejemplo

ctpu st --zone=us-central1-a
Status message:
  Your cluster is running!
    Compute Engine VM:  RUNNING
    Cloud TPU:     RUNNING 

tpu-locations

Descripción

Enumera todas las zonas en las que los tipos de TPU están disponibles.

Uso

ctpu tpu-locations

Resultado

Cloud TPU Locations:
    asia-east1-c
    europe-west4-a
    us-central1-a
    us-central1-b
    us-central1-c

tpu-sizes

Descripción

Enumera todos los tamaños de TPU disponibles en la zona especificada. Algunos tamaños solo están disponibles en ciertas zonas. (predeterminado = zona predeterminada)

Uso

tpu-sizes <zone>

Ejemplo

ctpu tpu-sizes --zone=us-central1-a

up

Descripción

Abre un conjunto de recursos de ctpu. La primera vez que ejecutas ctpu up en un proyecto, lleva más tiempo del que necesitará en futuras ejecuciones porque realiza tareas como la propagación de Llaves SSH y la activación de API.

• Habilita los servicios de Compute Engine y Cloud TPU.
• Crea una VM de Compute Engine con la última versión estable de TensorFlow preinstalada.
• Asigna una zona predeterminada, como us-central1-b, según tu ubicación.
• Pasa el nombre de la Cloud TPU a la VM de Compute Engine como una variable de entorno (TPU_NAME).
• Otorga funciones específicas de IAM a tu cuenta de servicio de Cloud TPU para garantizar que tu Cloud TPU tenga acceso a los recursos que necesita del proyecto de Google Cloud.
• Realiza otras comprobaciones.
• Accede a tu nueva VM de Compute Engine. El indicador de shell cambia de username@project a username@tpuname.

Puedes ejecutar ctpu up tantas veces como quieras. Por ejemplo, si pierdes la conexión SSH a la VM de Compute Engine, ejecuta ctpu up para restablecerla. Debes especificar una zona si Compute Engine no se encuentra en la zona predeterminada. Por ejemplo:

$ ctpu up --zone=us-central1-a

Uso

ctpu up <flags>

Ejemplo

ctpu up --tpu-size=v2-8 --disk-size-gb=320 --preemptible

Marcas

--disk-size-gb
Configura el tamaño del volumen raíz de la VM de Compute Engine. El valor debe ser un número entero. (predeterminado = 250)

--dry-run
No realiza cambios; imprime solo lo que habría pasado.

--forward-agent
Habilita el reenvío del agente de SSH cuando se establece una conexión SSH a la VM de Compute Engine. El reenvío del agente de SSH permite el acceso a repositorios compartidos (como GitHub) sin tener que colocar claves privadas en la VM de Compute Engine. (predeterminado = true)

--forward-ports
Reenvía de forma automática los puertos útiles de la VM de Compute Engine a tu máquina local. Los puertos reenviados son: 6006 (TensorBoard), 8888 (notebooks de Jupyter), 8470 (puerto TPU), 8466 (puerto de generador de perfiles de TPU). (predeterminado = true)

--gce-image
Anula la imagen de Compute Engine elegida de forma automática. Usa esta marca cuando uses tus propias imágenes personalizadas en lugar de las que se proporcionan en el TensorFlow instalado.

--gcp-network
Especifica la red en la que se deben crear la Cloud TPU y la VM asociada. Consulta Descripción general de la red de la nube privada virtual (VPC) para obtener información sobre las redes. (predeterminado = red predeterminada)

--log-http
Imprime el contenido completo de los pares HTTP de solicitud-respuesta. Para habilitar la impresión, configura esta marca como true. Usa esta marca cuando necesites un resultado de registro para presentar un informe de errores en ctpu. Para obtener más información, consulta README de ctpu.

--machine-type
Configura el tamaño de la VM de Compute Engine. Una lista completa de los tipos de máquinas se encuentra disponible en la página Tipos de máquina de Cloud. (predeterminado = n1-standard-2)

--name
Anula el nombre que se usará para las VM y la Cloud TPU. (predeterminado = tu nombre de usuario)

--noconf
Omite la confirmación.

--preemptible
Crea un nodo de Cloud TPU interrumpible. Una Cloud TPU interrumpible cuesta menos por hora que una no interrumpible. El servicio de Cloud TPU puede salir de un dispositivo interrumpible en cualquier momento. (predeterminado = no interrumpible)

--preemptible-vm
Crea una VM de Compute Engine interrumpible. Una VM interrumpible cuesta menos por hora que una no interrumpible. El servicio de Compute Engine puede salir de la instancia de VM en cualquier momento. (predeterminado = no interrumpible)

--print-welcome
Imprime siempre el mensaje de bienvenida.

--project
Reemplaza el nombre del proyecto de GCP para que se use cuando se asignan VM y TPU. Especifica un valor desde la configuración de la nube o los metadatos de Compute Engine, por lo general, el nombre del proyecto. Si no se puede encontrar un buen valor, debes proporcionar uno en la línea de comandos.

--tf-version
Configura la versión de TensorFlow que se usará cuando se cree la VM de Compute Engine y la Cloud TPU. (predeterminado = última actualización estable)

--tpu-only
Asigna solo una Cloud TPU. Usa esta marca solo si ya tienes una VM disponible.

--tpu-size
Configura el tamaño y la versión de hardware de una Cloud TPU.

--use-dl-images
Usa imágenes de VM de aprendizaje profundo (consulta los documentos: https://cloud.google.com/deep-learning-vm/), en lugar de las imágenes de máquina de TPU. (predeterminado = imágenes de máquina de TPU)

--vm-only
Asigna solo una VM. Usa esta marca cuando no estés listo para configurar y pagar una TPU.

--zone
Anula la zona de Compute Engine que se usará cuando se asignan las VM y Cloud TPU. En la línea de comandos, ejecuta ctpu help up para ver la lista.

version

Descripción

Imprime la versión de ctpu instalada.

Uso

ctpu version

Salida

ctpu version
Output: ctpu version: 1.9