Criar perfil de cargas de trabalho PyTorch XLA

A criação de perfil é uma maneira de analisar e melhorar o desempenho dos modelos. Embora haja muito mais do que isso, às vezes pode ser útil pensar na criação de perfil como operações de tempo e partes do código que são executadas em dispositivos (TPUs) e hosts (CPUs). Neste guia, apresentamos uma visão geral rápida de como criar o perfil do código para treinamento ou inferência. Para mais informações sobre como analisar os perfis gerados, consulte os guias a seguir.

• Depuração de desempenho do PyTorch XLA em VMs de TPU – parte 1
• Depuração de desempenho do PyTorch XLA em VMs de TPU: parte 2
• Depuração de desempenho do PyTorch XLA em VMs de TPU: parte 3

Comece já

Criar uma TPU

1. Exporte as variáveis de 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
   

   Exportar descrições de variáveis

   TPU name

   O nome que você quer usar para o Cloud TPU.

   zone

   A zona em que você planeja criar o Cloud TPU.

   project ID

   O ID do projeto que você está usando para treinar e criar o perfil do modelo.

   accelerator-type

   O tipo de acelerador especifica a versão e o tamanho do Cloud TPU que você quer criar. Para mais informações sobre os tipos de aceleradores compatíveis com cada versão de TPU, consulte Versões de TPU.

   version

   A versão do ambiente de execução do Cloud TPU. Um padrão é mostrado na variável exportada, mas você também pode usar um da lista de configurações compatíveis.

2. Iniciar os recursos da 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. Mova o código para o diretório principal na VM da TPU usando o comando gcloud scp. Exemplo:

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

Criação de perfil

Observação: um v4-8 inclui quatro dispositivos TPU. Cada worker cria um perfil de apenas um dispositivo TPU dos quatro disponíveis. Em breve, será possível criar perfis dos quatro dispositivos TPU para cada worker.

Um perfil pode ser capturado manualmente por meio de capture_profile.py ou programaticamente no script de treinamento usando as APIs torch_xla.debug.profiler.

Como iniciar o servidor de perfil

Para capturar um perfil, um servidor de perfis precisa estar em execução no script de treinamento. Inicie um servidor com um número de porta de sua escolha, por exemplo, 9012, conforme mostrado no comando a seguir.

Observação: consulte este exemplo de script (em inglês) que inclui as etapas a seguir.

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

O servidor pode ser iniciado no início da função main.

Observação: se você estiver usando o módulo Lightning, em vez de iniciar um servidor, transmita profiler="xla" para trainer, e ele iniciará automaticamente o servidor na porta 9012.

Agora é possível capturar perfis conforme descrito na próxima seção. O script cria o perfil de tudo o que acontece em um dispositivo TPU.

Como adicionar traces

Se você também quiser criar o perfil das operações na máquina host, adicione xp.StepTrace ou xp.Trace ao código. Essas funções rastreiam o código Python na máquina host. Pense nisso como a medição de quanto tempo leva para executar o código Python no host (CPU) antes de passar o "gráfico" para o dispositivo TPU. Portanto, é muito útil para analisar a sobrecarga de rastreamento. É possível adicionar isso ao loop de treinamento em que o código processa lotes de dados, por exemplo,

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

ou unir partes individuais do código com

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

Importante: evite unir xm.mark_step() com xp.Trace. Nesse caso, o código falhará com uma mensagem de erro semelhante a: "RuntimeError: Expecting scope to be empty but it is train_loop." . xp.StepTrace não terá esse problema, já que adiciona xm.mark_step() automaticamente ao sair do escopo. Além disso, você pode receber esse erro ao usar torchdynamo, porque ele pode invocar xm.mark_step internamente. A solução alternativa atual é não usar xp.Trace.

Se você estiver usando o Lighting, poderá pular a adição de rastros, já que isso é feito automaticamente em algumas partes do código. No entanto, se você quiser adicionar outros traces, insira-os no loop de treinamento.

Você poderá capturar a atividade do dispositivo após a compilação inicial. Aguarde até que o modelo inicie as etapas de treinamento ou inferência.

Captura manual

O script capture_profile.py do repositório do Pytorch XLA permite capturar rapidamente um perfil. É possível fazer isso copiando o arquivo de perfil de captura diretamente para sua VM da TPU. O comando a seguir o copia para o diretório principal.

$ 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 o treinamento, execute o seguinte comando para capturar um perfil:

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

Esse comando salva arquivos .xplane.pb no logdir. É possível alterar o diretório de geração de registros ~/profiles/ para seu local e nome preferidos. Também é possível salvar diretamente no bucket do Cloud Storage. Para fazer isso, defina logdir como gs://your_bucket_name/.

Captura programática

Em vez de capturar o perfil manualmente acionando um script, é possível configurar o script de treinamento para acionar um perfil automaticamente usando a API torch_xla.debug.profiler.trace_detached no script de treinamento.

Observação: a API trace_detached está disponível apenas em builds noturnos ou após a versão 2.2. Para capturar programaticamente em versões anteriores de torch_xla, você pode copiar o corpo do método para criar a linha de execução de captura em segundo plano diretamente.

Por exemplo, para capturar automaticamente um perfil em um período e uma etapa específicos, configure o script de treinamento para consumir as variáveis de 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)
      ...

Isso salvará os arquivos .xplane.pb no diretório especificado pela variável de ambiente PROFILE_LOGDIR.

Análise no TensorBoard

Para analisar ainda mais os perfis, use o TensorBoard com o plug-in do TensorBoard da TPU
na mesma máquina ou em outra (recomendado).

Para executar o TensorBoard em uma máquina remota, conecte-se a ela usando SSH e ative o encaminhamento de portas. Por exemplo,

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

ou

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

Na máquina remota, instale os pacotes necessários e inicie o TensorBoard, supondo que você tenha perfis nessa máquina em ~/profiles/. Se você armazenou os perfis em outro diretório ou bucket do Cloud Storage, especifique os caminhos corretamente, por exemplo, gs://your_bucket_name/profiles.

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

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

Observação: é importante ter arquivos .xplane na mesma estrutura aninhada gerada quando você captura um perfil. Por exemplo: ~/profiles/plugins/profile/2023_04_10_21_40_22/localhost_9012.xplane.pb

Observação: se você receber o erro "plug-ins duplicados", talvez haja vários pacotes com o TensorBoard. Desinstale todos esses pacotes e execute os comandos pip install novamente. Por exemplo, talvez seja necessário executar:

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

Como executar o TensorBoard

No navegador local, acesse: http://localhost:6006/ e escolha PROFILE no menu suspenso para carregar seus perfis.

Consulte Ferramentas do TPU para informações sobre as ferramentas do TensorBoard e como interpretar a saída.