Profila carichi di lavoro XLA PyTorch

La profilazione è un modo per analizzare e migliorare le prestazioni dei modelli. Sebbene ci sia molto di più, a volte può essere utile considerare la profilazione come operazioni di temporizzazione e parti del codice che vengono eseguite su dispositivi (TPU) e host (CPU). Questa guida fornisce una rapida panoramica su come profilare il codice per l'addestramento o l'inferenza. Per ulteriori informazioni su come analizzare i profili generati, consulta le seguenti guide.

• Debug delle prestazioni di PyTorch XLA sulle VM TPU - Parte 1
• Debug delle prestazioni di PyTorch XLA sulle VM TPU - Parte 2
• Debug delle prestazioni di PyTorch XLA sulle VM TPU - parte 3

Inizia

Crea una TPU

1. Esporta le variabili di ambiente:

   $ export TPU_NAME=your_tpu_name
   $ export ZONE=us-central2-b
   $ export PROJECT_ID=project-id
   $ export ACCELERATOR_TYPE=v4-8
   $ export RUNTIME_VERSION=tpu-vm-v4-pt-2.0
   

   Esporta descrizioni variabili

   TPU name

   Il nome che vuoi utilizzare per Cloud TPU.

   zone

   La zona in cui prevedi di creare la Cloud TPU.

   project ID

   L'ID progetto che usi per addestrare e profilare il modello.

   accelerator-type

   Il tipo di acceleratore specifica la versione e le dimensioni della Cloud TPU che vuoi creare. Per maggiori informazioni sui tipi di acceleratori supportati per ogni versione di TPU, consulta Versioni TPU.

   version

   La versione del runtime di Cloud TPU. Nella variabile esportata viene mostrato un valore predefinito, ma puoi anche utilizzarne uno dall'elenco delle configurazioni supportate.

2. Avvia le risorse TPU

   $ gcloud compute tpus tpu-vm create ${TPU_NAME} \
   --zone us-central2-b \
   --accelerator-type ${ACCELERATOR_TYPE} \
   --version ${RUNTIME_VERSION} \
   --project $PROJECT_ID \
   --subnetwork=tpusubnet
   

3. Sposta il codice nella tua home directory sulla VM TPU utilizzando il comando gcloud scp. Ad esempio:

   $ gcloud compute tpus tpu-vm scp my-code-file ${TPU_NAME}: --zone ${ZONE}
   

Profilazione

Nota: la versione 4-8 include quattro dispositivi TPU. Ogni worker profila solo un dispositivo TPU dei 4 dispositivi disponibili. La profilazione di tutti e 4 i dispositivi TPU per ogni worker sarà supportata a breve.

Un profilo può essere acquisito manualmente tramite capture_profile.py o in modo programmatico all'interno dello script di addestramento utilizzando le API torch_xla.debug.profiler.

Avvio del server del profilo

Per acquisire un profilo, è necessario che un server di profilo sia in esecuzione all'interno dello script di addestramento. Avvia un server con un numero di porta a tua scelta, ad esempio 9012, come mostrato nel seguente comando.

Nota: puoi fare riferimento a questo script di esempio che include i seguenti passaggi.

import torch_xla.debug.profiler as xp
server = xp.start_server(9012)

Il server può essere avviato direttamente all'inizio della funzione main.

Nota: se utilizzi il modulo Lightning, invece di avviare un server, passa profiler="xla" a trainer e il server verrà avviato automaticamente alla porta 9012.

Ora puoi acquisire profili come descritto nella sezione seguente. Lo script profila tutto ciò che accade su un dispositivo TPU.

Aggiunta di tracce

Se vuoi profilare anche le operazioni sulla macchina host, puoi aggiungere xp.StepTrace o xp.Trace nel codice. Queste funzioni tracciano il codice Python sulla macchina host. È un po' come misurare il tempo necessario per eseguire il codice Python sull'host (CPU) prima di passare il "grafo" al dispositivo TPU. quindi è soprattutto utile per analizzare l'overhead di tracciamento). Puoi aggiungerlo all'interno del loop di addestramento, dove il codice elabora batch di dati, ad esempio

for step, batch in enumerate(train_dataloader):
    with xp.StepTrace('Training_step', step_num=step): 
       ...

o aggregare singole parti del codice

 with xp.Trace('loss'): 
    loss = ...

Importante: evita di aggregare xm.mark_step() con xp.Trace. In questo caso, il codice si arresta in modo anomalo con un messaggio di errore simile a questo: "RuntimeError: Expecting scope to be empty but it is train_loop." xp.StepTrace non avrà questo problema poiché aggiunge automaticamente xm.mark_step() all'uscita dall'ambito. Inoltre, potresti visualizzare questo errore quando utilizzi torchdynamo perché torchdynamo può richiamare internamente xm.mark_step. La soluzione alternativa attuale non è utilizzare xp.Trace.

Se utilizzi Lighting, puoi saltare l'aggiunta di tracce poiché l'operazione viene eseguita automaticamente in alcune parti del codice. Tuttavia, se vuoi aggiungere altre tracce, puoi inserirle all'interno del loop di addestramento.

Dopo la compilazione iniziale, potrai acquisire l'attività del dispositivo e attendere che il modello inizi i passaggi di addestramento o inferenza.

Acquisizione manuale

Lo script capture_profile.py del repository XLA Pytorch consente di acquisire rapidamente un profilo. Puoi eseguire questa operazione copiando il file del profilo di acquisizione direttamente nella VM TPU. Il comando seguente lo copia nella home directory.

$ gcloud compute tpus tpu-vm ssh ${TPU_NAME} \
--zone us-central2-b \
--worker=all \
--command="wget https://raw.githubusercontent.com/pytorch/xla/master/scripts/capture_profile.py"

Durante l'addestramento, esegui il comando seguente per acquisire un profilo:

$ gcloud compute tpus tpu-vm ssh ${TPU_NAME} \
--zone us-central2-b \
--worker=all \
--command="python3 capture_profile.py --service_addr "localhost:9012" --logdir ~/profiles/ --duration_ms 2000"

Questo comando salva .xplane.pb file in logdir. Puoi modificare la directory di logging ~/profiles/ impostando la posizione e il nome che preferisci. È anche possibile salvare direttamente nel bucket Cloud Storage. Per farlo, imposta logdir su gs://your_bucket_name/.

Acquisizione programmatica

Anziché acquisire il profilo manualmente attivando uno script, puoi configurare lo script di addestramento in modo che attivi automaticamente un profilo utilizzando l'API torch_xla.debug.profiler.trace_detached all'interno dello script di addestramento.

Nota: l'API trace_detached è disponibile solo nelle build notturne o dopo la release 2.2. Per acquisire in modo programmatico le versioni precedenti di torch_xla, puoi copiare il corpo del metodo per creare direttamente il thread di acquisizione in background.

Ad esempio, per acquisire automaticamente un profilo in un'epoca e in un passaggio specifici, puoi configurare lo script di addestramento in modo che utilizzi le variabili di ambiente PROFILE_STEP, PROFILE_EPOCH e PROFILE_LOGDIR:

import os
import torch_xla.debug.profiler as xp

# Within the training script, read the step and epoch to profile from the
# environment.
profile_step = int(os.environ.get('PROFILE_STEP', -1))
profile_epoch = int(os.environ.get('PROFILE_EPOCH', -1))
...

for epoch in range(num_epoch):
   ...
   for step, data in enumerate(epoch_dataloader):
      if epoch == profile_epoch and step == profile_step:
         profile_logdir = os.environ['PROFILE_LOGDIR']
         # Use trace_detached to capture the profile from a background thread
         xp.trace_detached('localhost:9012', profile_logdir)
      ...

I file .xplane.pb verranno salvati nella directory specificata dalla variabile di ambiente PROFILE_LOGDIR.

Analisi in TensorBoard

Per analizzare ulteriormente i profili, puoi utilizzare TensorBoard con il plug-in TPU TensorBoard
sulla stessa macchina o su un'altra macchina (consigliato).

Per eseguire TensorBoard su una macchina remota, connettiti mediante SSH e abilita il port forwarding. Ad esempio,

$ ssh -L 6006:localhost:6006 remote server address

o

$ gcloud compute tpus tpu-vm ssh $TPU_NAME --zone=$ZONE --ssh-flag="-4 -L 6006:localhost:6006"

Sul computer remoto, installa i pacchetti richiesti e avvia TensorBoard (supponendo che tu abbia profili su quella macchina in ~/profiles/). Se hai archiviato i profili in un'altra directory o in un bucket Cloud Storage, assicurati di specificare correttamente i percorsi, ad esempio gs://your_bucket_name/profiles.

(vm)$ pip install tensorflow-cpu tensorboard-plugin-profile 

(vm)$ tensorboard --logdir ~/profiles/ --port 6006

Nota: è importante avere .xplane file nella stessa struttura nidificata che viene generata quando acquisisci un profilo. Ad esempio: ~/profiles/plugins/profile/2023_04_10_21_40_22/localhost_9012.xplane.pb

Nota: se visualizzi l'errore "plug-in duplicati", è possibile che esistano più pacchetti con TensorBoard. Disinstalla tutti i pacchetti ed esegui di nuovo i comandi pip install. Ad esempio, potrebbe essere necessario eseguire:

(vm)$ pip uninstall tensorflow tf-nightly tensorboard tb-nightly tbp-nightly

Esecuzione di TensorBoard

Nel browser locale, vai all'indirizzo: http://localhost:6006/ e scegli PROFILE dal menu a discesa per caricare i tuoi profili.

Consulta la pagina Strumenti TPU per informazioni sugli strumenti TensorBoard e su come interpretare l'output.