Como treinar o ShapeMask no Cloud TPU (TF 2.x)

Neste documento, você verá como executar o modelo ShapeMask usando a Cloud TPU com o conjunto de dados COCO.

Nas instruções abaixo, presume-se que você conheça a execução de um modelo na Cloud TPU. Se você conhece a Cloud TPU há pouco tempo, consulte o guia de início rápido para ver os conceitos básicos.

Se você planeja treinar em uma fração do pod da TPU, veja como realizar o treinamento em pods de TPU para entender as alterações de parâmetros necessárias para frações de pod.

Objetivos

  • Criar um bucket do Cloud Storage para armazenar o conjunto de dados e a saída do modelo.
  • Preparar o conjunto de dados COCO.
  • Configurar uma VM do Compute Engine e um nó da Cloud TPU para treinamento e avaliação.
  • Executar treinamento e avaliação em uma única Cloud TPU ou em um pod da Cloud TPU.

Custos

Neste tutorial, há componentes faturáveis do Google Cloud, entre eles:

  • Compute Engine
  • Cloud TPU
  • Cloud Storage

Use a calculadora de preços para gerar uma estimativa de custos baseada na projeção de uso. Novos usuários do Google Cloud podem estar qualificados para uma avaliação gratuita.

Antes de começar

Antes de começar o tutorial, verifique se o projeto do Google Cloud foi configurado corretamente.

  1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.
  2. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  3. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como confirmar se o faturamento está ativado para o projeto.

  4. Este tutorial usa componentes faturáveis do Google Cloud. Consulte a página de preços da Cloud TPU para fazer uma estimativa dos custos. Para evitar cobranças desnecessárias, não se esqueça de apagar os recursos criados ao terminar de usá-los.

Se você planeja treinar em uma fração do pod da TPU, veja como realizar o treinamento em pods de TPU para entender as alterações de parâmetros necessárias para frações de pod.

Configurar os recursos

Nesta seção, fornecemos informações sobre como configurar os recursos do Cloud Storage, da VM e do Cloud TPU para este tutorial.

  1. Abra uma janela do Cloud Shell.

    Abrir o Cloud Shell

  2. Crie uma variável para o ID do seu projeto.

    export PROJECT_ID=project-id
    
  3. Configure a ferramenta de linha de comando gcloud para usar o projeto em que a Cloud TPU será criada.

    gcloud config set project ${PROJECT_ID}
    

    Na primeira vez que você executar esse comando em uma nova VM do Cloud Shell, será exibida uma página Authorize Cloud Shell. Clique em Authorize na parte inferior da página para permitir que gcloud faça chamadas de API do GCP com suas credenciais.

  4. Crie uma conta de serviço para o projeto da Cloud TPU.

    gcloud beta services identity create --service tpu.googleapis.com --project $PROJECT_ID
    

    O comando retorna uma conta de serviço do Cloud TPU com o formato a seguir:

    service-PROJECT_NUMBER@cloud-tpu.iam.gserviceaccount.com
    

  5. Crie um bucket do Cloud Storage usando o seguinte comando:

    gsutil mb -p ${PROJECT_ID} -c standard -l europe-west4 -b on gs://bucket-name
    

    Esse bucket do Cloud Storage armazena os dados usados para treinar o modelo e os resultados do treinamento. A ferramenta gcloud compute tpus execution-groups usada neste tutorial configura permissões padrão para a conta de serviço do Cloud TPU configurada na etapa anterior. Caso queira permissões mais específicas, consulte as permissões de nível de acesso.

    O local do bucket precisa estar na mesma região da máquina virtual (VM) e do nó da TPU. As VMs e os nós da TPU estão localizados em zonas específicas, que são subdivisões dentro de uma região.

  6. Inicie uma instância de VM do Compute Engine.

    $ gcloud compute tpus execution-groups create \
     --vm-only \
     --name=shapemask-tutorial \
     --zone=europe-west4-a \
     --disk-size=300 \
     --machine-type=n1-standard-16 \
     --tf-version=2.5.0
    

    Descrições de sinalizações de comando

    vm-only
    Crie somente uma VM. Por padrão, o comando gcloud compute tpus execution-groups cria uma VM e uma Cloud TPU.
    name
    O nome da Cloud TPU a ser criada.
    zone
    A zona em que você planeja criar a Cloud TPU.
    disk-size
    O tamanho do disco rígido em GB da VM criada pelo comando gcloud compute tpus execution-groups .
    machine-type
    O tipo de máquina da VM do Compute Engine a ser criado.
    tf-version
    A versão do gcloud compute tpus execution-groups do Tensorflow é instalada na VM.

    Para mais informações sobre o comando gcloud, consulte a referência da gcloud.

  7. A configuração especificada aparecerá. Digite y para aprovar ou n para cancelar.

    Quando o comando gcloud compute tpus execution-groups terminar a execução, verifique se o prompt do shell foi alterado de username@projectname para username@vm-name. Essa alteração mostra que você fez login na VM do Compute Engine.

    gcloud compute ssh shapemask-tutorial --zone=europe-west4-a
    

    Ao continuar essas instruções, execute cada comando que começa com (vm)$ na instância do Compute Engine.

  8. Crie uma variável de ambiente para armazenar o local do bucket do Cloud Storage.

    (vm)$ export STORAGE_BUCKET=gs://bucket-name
    
  9. Crie uma variável de ambiente para o diretório de dados.

    (vm)$ export DATA_DIR=${STORAGE_BUCKET}/coco
    
  10. Clone o repositório tpu.

    (vm)$ git clone -b shapemask https://github.com/tensorflow/tpu/
    
  11. Instale os pacotes necessários para pré-processar os dados.

    (vm)$ sudo apt-get install -y python3-tk && \
      pip3 install --user Cython matplotlib opencv-python-headless pyyaml Pillow && \
      pip3 install --user "git+https://github.com/cocodataset/cocoapi#egg=pycocotools&subdirectory=PythonAPI"
    

Preparar o conjunto de dados COCO

  1. Execute o script download_and_preprocess_coco.sh para converter o conjunto de dados COCO em um conjunto de TFRecords (*.tfrecord) esperado pelo aplicativo de treinamento.

    (vm)$ sudo bash /usr/share/tpu/tools/datasets/download_and_preprocess_coco.sh ./data/dir/coco
    

    Isso instala as bibliotecas necessárias e executa o script de pré-processamento. A saída são alguns arquivos *.tfrecord no diretório de dados.

  2. Depois de converter os dados para TFRecords, use o comando gsutil para copiá-los do armazenamento local para o bucket do Cloud Storage. Também é preciso copiar os arquivos de anotação. Eles ajudam a validar o desempenho do modelo.

    (vm)$ gsutil -m cp ./data/dir/coco/*.tfrecord ${DATA_DIR}
    (vm)$ gsutil cp ./data/dir/coco/raw-data/annotations/*.json ${DATA_DIR}
    

Configure e inicie a Cloud TPU

  1. Inicie um recurso do Cloud TPU usando o comando gcloud.

    (vm)$ gcloud compute tpus execution-groups create \
     --tpu-only \
     --accelerator-type=v3-8  \
     --name=shapemask-tutorial \
     --zone=europe-west4-a \
     --tf-version=2.5.0
    

    Descrições de sinalizações de comando

    tpu-only
    Cria a Cloud TPU sem criar uma VM. Por padrão, o comando gcloud compute tpus execution-groups cria uma VM e uma Cloud TPU.
    tpu-size
    O tipo da Cloud TPU a ser criada.
    name
    O nome da Cloud TPU a ser criada.
    zone
    A zona em que você planeja criar a Cloud TPU.
    tf-version
    A versão do Tensorflow gcloud compute tpus execution-groups é instalada na VM.
  2. Adicione uma variável de ambiente para o nome do Cloud TPU.

    (vm)$ export TPU_NAME=shapemask-tutorial
    
  3. A configuração especificada aparecerá. Digite y para aprovar ou n para cancelar.

    Você verá a mensagem: Operation success; not ssh-ing to Compute Engine VM due to --tpu-only flag. Como você já concluiu a propagação de chave SSH anteriormente, ignore essa mensagem.

  4. Adicione uma variável de ambiente para o nome do Cloud TPU.

    (vm)$ export TPU_NAME=shapemask-tutorial
    

Executar o treinamento e a avaliação

O script a seguir executa um treinamento de amostra que é treinado por apenas 100 etapas e leva aproximadamente seis minutos para ser concluído em uma TPU v3-8. O treinamento para a conversão leva cerca de 22.500 etapas e aproximadamente 6 horas em uma TPU v3-8.

  1. Adicione algumas variáveis de ambiente obrigatórias:

    (vm)$ export PYTHONPATH="${PYTHONPATH}:/usr/share/models"
    (vm)$ export RESNET_CHECKPOINT=gs://cloud-tpu-checkpoints/retinanet/resnet50-checkpoint-2018-02-07
    (vm)$ export TRAIN_FILE_PATTERN=${DATA_DIR}/train-*
    (vm)$ export EVAL_FILE_PATTERN=${DATA_DIR}/val-*
    (vm)$ export VAL_JSON_FILE=${DATA_DIR}/instances_val2017.json
    (vm)$ export SHAPE_PRIOR_PATH=gs://cloud-tpu-checkpoints/shapemask/kmeans_class_priors_91x20x32x32.npy
    (vm)$ export MODEL_DIR=${STORAGE_BUCKET}/shapemask
    
  2. Execute o seguinte script para treinar o modelo ShapeMask:

    (vm)$ python3 /usr/share/models/official/vision/detection/main.py \
    --strategy_type=tpu \
    --tpu=${TPU_NAME} \
    --model_dir=${MODEL_DIR} \
    --mode=train \
    --model=shapemask \
    --params_override="{train: {total_steps: 100, learning_rate: {init_learning_rate: 0.08, learning_rate_levels: [0.008, 0.0008], learning_rate_steps: [15000, 20000], }, checkpoint: { path: ${RESNET_CHECKPOINT},prefix: resnet50}, train_file_pattern: ${TRAIN_FILE_PATTERN}}, shapemask_head: {use_category_for_mask: true, shape_prior_path: ${SHAPE_PRIOR_PATH}}, shapemask_parser: {output_size: [640, 640]}}"
    

    Descrições de sinalizações de comando

    strategy_type
    Para treinar o modelo RetinaNet em uma TPU, é necessário definir o distribution_strategy como tpu.
    tpu
    O nome da Cloud TPU. Isso é definido usando a variável de ambiente TPU_NAME.
    model_dir
    O bucket do Cloud Storage em que os checkpoints e os resumos são armazenados durante o treinamento. Use uma pasta atual para carregar os checkpoints gerados anteriormente criados em uma TPU do mesmo tamanho e versão do TensorFlow.
    mode
    Um de train, eval ou train_and_eval.
    model
    O modelo a ser treinado.
    params_override
    Uma string JSON que modifica parâmetros de script padrão. Para mais informações sobre parâmetros de script, consulte /usr/share/models/official/vision/detection/main.py.

    A saída do script de treinamento terá esta aparência:

    Train Step: 100/100  / loss = {
     'total_loss': 10.152124404907227,
     'loss': 10.152124404907227,
     'retinanet_cls_loss': 1.3409545421600342,
     'l2_regularization_loss': 4.6183762550354,
     'retinanet_box_loss': 0.012389584444463253,
     'shapemask_prior_loss': 0.183448925614357,
     'shapemask_coarse_mask_loss': 1.7648673057556152,
     'shapemask_fine_mask_loss': 1.790102243423462,
     'model_loss': 5.533748626708984,
     'learning_rate': 0.021359999
    }
    / training metric = {
    'total_loss': 10.152124404907227,
    'loss': 10.152124404907227,
    'retinanet_cls_loss': 1.3409545421600342,
    'l2_regularization_loss': 4.6183762550354,
    'retinanet_box_loss': 0.012389584444463253,
    'shapemask_prior_loss': 0.183448925614357,
    'shapemask_coarse_mask_loss': 1.7648673057556152,
    'shapemask_fine_mask_loss': 1.790102243423462,
    'model_loss': 5.533748626708984,
    'learning_rate': 0.021359999
    }
  3. Execute o script para avaliar o modelo ShapeMask:

    (vm)$ python3 /usr/share/models/official/vision/detection/main.py \
    --strategy_type=tpu \
    --tpu=${TPU_NAME} \
    --model_dir=${MODEL_DIR} \
    --checkpoint_path=${MODEL_DIR} \
    --mode=eval_once \
    --model=shapemask \
    --params_override="{eval: { val_json_file: ${VAL_JSON_FILE}, eval_file_pattern: ${EVAL_FILE_PATTERN}, eval_samples: 5000 }, shapemask_head: {use_category_for_mask: true, shape_prior_path: ${SHAPE_PRIOR_PATH}}, shapemask_parser: {output_size: [640, 640]}}"
    

    Descrições de sinalizações de comando

    strategy_type
    Para treinar o modelo RetinaNet em uma TPU, é necessário definir o distribution_strategy como tpu.
    tpu
    O nome da Cloud TPU. Isso é definido usando a variável de ambiente TPU_NAME.
    model_dir
    O bucket do Cloud Storage em que os checkpoints e os resumos são armazenados durante o treinamento. Use uma pasta atual para carregar os checkpoints gerados anteriormente criados em uma TPU do mesmo tamanho e versão do TensorFlow.
    mode
    Um de train, eval ou train_and_eval.
    model
    O modelo a ser treinado.
    params_override
    Uma string JSON que modifica parâmetros de script padrão. Para mais informações sobre parâmetros de script, consulte /usr/share/models/official/vision/detection/main.py.

A saída do script de avaliação será semelhante a esta:

756s 62ms/step
- loss: 0.4864
- accuracy: 0.8055
- val_loss: 0.3832
- val_accuracy: 0.8546

A partir daqui, é possível concluir este tutorial e limpar os recursos do GCP ou explorar a execução do modelo em um pod da Cloud TPU.

Como escalonar o modelo com os pods da Cloud TPU

Para resultados mais rápidos, escalone o modelo com os pods da Cloud TPU. O modelo Mask RCNN totalmente compatível pode funcionar com as seguintes frações de pod:

  • v2-32
  • v3-32

Ao trabalhar com pods da Cloud TPU, primeiro treine o modelo usando um pod e, em seguida, use um único dispositivo da Cloud TPU para avaliá-lo.

Como treinar com pods da Cloud TPU

Se você já tiver excluído sua instância do Compute Engine, crie uma nova seguindo as etapas em Configurar seus recursos.

O treinamento de amostra abaixo é executado por apenas 20 etapas e leva aproximadamente 10 minutos para ser concluído em um nó de TPU v3-32. O treinamento para a conversão leva cerca de 11.250 etapas e aproximadamente duas horas em um pod de TPU v3-32.

  1. Exclua o recurso da Cloud TPU criado para treinar o modelo em um único dispositivo.

    (vm)$ gcloud compute tpus execution-groups delete shapemask-tutorial \
      --zone=europe-west4-a \
      --tpu-only
  2. Execute o comando gcloud compute tpus execution-groups, usando o parâmetro accelerator-type para especificar a fração de pod a ser usada. Por exemplo, o comando a seguir usa uma fração de pod v3-32.

    (vm)$ gcloud compute tpus execution-groups  create --name=shapemask-tutorial \
      --accelerator-type=v3-32  \
      --zone=europe-west4-a \
      --tf-version=2.5.0 \
      --tpu-only
    

    Descrições de sinalizações de comando

    name
    O nome da Cloud TPU a ser criada.
    accelerator-type
    O tipo da Cloud TPU a ser criada.
    zone
    A zona em que você planeja criar a Cloud TPU.
    tf-version
    A versão do gcloud do Tensorflow é instalada na VM.
    tpu-only
    Crie apenas uma Cloud TPU. Por padrão, o comando gcloud cria uma VM e uma Cloud TPU.
  3. Atualize as variáveis de ambiente TPU_NAME e MODEL_DIR.

    (vm)$ export TPU_NAME=shapemask-tutorial
    (vm)$ export MODEL_DIR=${STORAGE_BUCKET}/shapemask-pods
    
  4. Inicie o script de treinamento.

    (vm)$ python3 /usr/share/models/official/vision/detection/main.py \
    --strategy_type=tpu \
    --tpu=${TPU_NAME} \
    --model_dir=${MODEL_DIR} \
    --mode=train \
    --model=shapemask \
    --params_override="{train: { batch_size: 128, iterations_per_loop: 500, total_steps: 20, learning_rate: {'learning_rate_levels': [0.008, 0.0008],'learning_rate_steps': [10000, 13000]}, checkpoint: {path: ${RESNET_CHECKPOINT}, prefix: resnet50/}, train_file_pattern: ${TRAIN_FILE_PATTERN}}, eval: {val_json_file: ${VAL_JSON_FILE}, eval_file_pattern: ${EVAL_FILE_PATTERN}},shapemask_head: {use_category_for_mask: true, shape_prior_path: ${SHAPE_PRIOR_PATH}}}"
    

    Descrições de sinalizações de comando

    strategy_type
    Para treinar o modelo RetinaNet em uma TPU, é necessário definir o distribution_strategy como tpu.
    tpu
    O nome da Cloud TPU. Isso é definido usando a variável de ambiente TPU_NAME.
    model_dir
    O bucket do Cloud Storage em que os checkpoints e os resumos são armazenados durante o treinamento. Use uma pasta atual para carregar os checkpoints gerados anteriormente criados em uma TPU do mesmo tamanho e versão do TensorFlow.
    mode
    Um de train, eval ou train_and_eval.
    model
    O modelo a ser treinado.
    params_override
    Uma string JSON que modifica parâmetros de script padrão. Para mais informações sobre parâmetros de script, consulte /usr/share/models/official/vision/detection/main.py.

A resposta do script de treinamento será semelhante a esta:

Train Step: 20/20  / loss = {
  'total_loss': 12.213006973266602,
  'loss': 12.213006973266602,
  'retinanet_cls_loss': 1.9299328327178955,
  'l2_regularization_loss': 4.628948211669922,
  'retinanet_box_loss': 0.016126759350299835,
  'shapemask_prior_loss': 0.16990719735622406,
  'shapemask_coarse_mask_loss': 3.688129425048828,
  'shapemask_fine_mask_loss': 1.1426670551300049,
  'model_loss': 7.584057807922363,
  'learning_rate': 0.009632
}
/ training metric = {
  'total_loss': 12.213006973266602,
  'loss': 12.213006973266602,
  'retinanet_cls_loss': 1.9299328327178955,
  'l2_regularization_loss': 4.628948211669922,
  'retinanet_box_loss': 0.016126759350299835,
  'shapemask_prior_loss': 0.16990719735622406,
  'shapemask_coarse_mask_loss': 3.688129425048828,
  'shapemask_fine_mask_loss': 1.1426670551300049,
  'model_loss': 7.584057807922363,
  'learning_rate': 0.009632
}

Como avaliar o modelo

Nesta etapa, use um único nó da Cloud TPU para avaliar o modelo treinado acima em relação ao conjunto de dados COCO. A avaliação leva cerca de 20 minutos.

  1. Exclua o recurso da Cloud TPU criado para treinar o modelo em um pod.

    (vm)$ gcloud compute tpus execution-groups delete shapemask-tutorial \
      --zone=europe-west4-a \
      --tpu-only
  2. Inicie um novo dispositivo de TPU para executar a avaliação.

    (vm)$ gcloud compute tpus execution-groups create --tpu-only \
      --name=shapemask-tutorial \
      --accelerator-type=v3-8 \
      --zone=europe-west4-a \
      --tf-version=2.5.0 \
    
    

    Descrições de sinalizações de comando

    tpu-only
    Crie apenas uma Cloud TPU. Por padrão, o comando gcloud cria uma VM e uma Cloud TPU.
    name
    O nome da Cloud TPU a ser criada.
    accelerator-type
    O tipo da Cloud TPU a ser criada.
    zone
    A zona em que você planeja criar a Cloud TPU.
    tf-version
    A versão do gcloud do Tensorflow é instalada na VM.
  3. Atualize a variável de ambiente TPU_NAME.

    (vm)$ export TPU_NAME=shapemask-tutorial
    
  4. Inicie a avaliação.

    (vm)$ python3 /usr/share/models/official/vision/detection/main.py \
    --strategy_type=tpu \
    --tpu=shapemask-tutorial \
    --model_dir=${MODEL_DIR} \
    --checkpoint_path=${MODEL_DIR} \
    --mode=eval_once \
    --model=shapemask \
    --params_override="{eval: { val_json_file: ${VAL_JSON_FILE}, eval_file_pattern: ${EVAL_FILE_PATTERN}, eval_samples: 5000 } }"
    

    Descrições de sinalizações de comando

    strategy_type
    Para treinar o modelo RetinaNet em uma TPU, é necessário definir o distribution_strategy como tpu.
    tpu
    O nome da Cloud TPU. Isso é definido usando a variável de ambiente TPU_NAME.
    model_dir
    O bucket do Cloud Storage em que os checkpoints e os resumos são armazenados durante o treinamento. Use uma pasta atual para carregar os checkpoints gerados anteriormente criados em uma TPU do mesmo tamanho e versão do TensorFlow.
    mode
    Um de train, eval ou train_and_eval.
    model
    O modelo a ser treinado.
    params_override
    Uma string JSON que modifica parâmetros de script padrão. Para mais informações sobre parâmetros de script, consulte /usr/share/models/official/vision/detection/main.py.

Limpeza

Para evitar cobranças na sua conta do Google Cloud pelos recursos usados no tutorial, exclua o projeto que os contém ou mantenha o projeto e exclua os recursos individuais.

  1. Desconecte-se da instância do Compute Engine, caso ainda não tenha feito isso:

    (vm)$ exit
    

    Agora, o prompt precisa ser username@projectname, mostrando que você está no Cloud Shell.

  2. No Cloud Shell, use o seguinte comando para excluir a VM do Compute Engine e o Cloud TPU:

    $ gcloud compute tpus execution-groups delete shapemask-tutorial \
      --zone=europe-west4-a
    
  3. Execute gcloud compute tpus execution-groups list para verificar se os recursos foram excluídos. A exclusão pode levar vários minutos. Uma resposta como esta indica que suas instâncias foram excluídas com sucesso.

    $ gcloud compute tpus execution-groups list \
     --zone=europe-west4-a
    

    Você verá uma lista vazia de TPUs como a seguinte:

       NAME             STATUS
    
  4. Exclua o bucket do Cloud Storage usando gsutil, conforme mostrado abaixo. Substitua bucket-name pelo nome do bucket no Cloud Storage.

    $ gsutil rm -r gs://bucket-name
    

A seguir

Treinar com diferentes tamanhos de imagem

Para explorar, use uma rede neural maior. Por exemplo, ResNet-101 em vez de ResNet-50. Uma imagem maior de entrada e uma rede neural mais potente produzirão um modelo mais lento, porém, mais preciso.

Usar uma base diferente

Se preferir, faça o pré-treinamento de um modelo do ResNet no seu próprio conjunto de dados e use-o como base para o modelo do ShapeMask. Com mais trabalho, você também pode trocar em uma rede neural alternativa no lugar do ResNet. Por fim, caso tenha interesse em implementar modelos próprios de detecção de objetos, essa rede pode ser uma boa base para fazer mais experimentos.