This tutorial shows you how to train the Deeplab-v3 model on Cloud TPU.
This model is an image semantic segmentation model. Image semantic segmentation models focus on identifying and localizing multiple objects in a single image. This type of model is frequently used in machine learning applications such as autonomous driving, geospatial image processing, and medical imaging.
In this tutorial, you'll run a training model against the PASCAL VOC 2012 dataset. For more information on this data set, see The PASCAL Visual Object Classes Homepage.
Before you begin
Before starting this tutorial, check that your Google Cloud Platform project is correctly set up.
Sign in to your Google Account.
If you don't already have one, sign up for a new account.
Select or create a GCP project.
Make sure that billing is enabled for your Google Cloud Platform project. Learn how to enable billing.
This walkthrough uses billable components of Google Cloud Platform. Check the Cloud TPU pricing page to estimate your costs. Be sure to clean up resources you create when you've finished with them to avoid unnecessary charges.
Set up your resources
This section provides information on setting up Cloud Storage storage, VM, and Cloud TPU resources for tutorials.
Create a Cloud Storage bucket
You need a Cloud Storage bucket to store the data you use to train
your model and the training results. The
ctpu up tool used in this tutorial
sets up default permissions for the Cloud TPU service account. If you want
finer-grain permissions, review the access level permissions.
The bucket location must be in the same region as your virtual machine (VM) and your TPU node. VMs and TPU nodes are located in specific zones, which are subdivisions within a region.
Go to the Cloud Storage page on the GCP Console.
Create a new bucket, specifying the following options:
- A unique name of your choosing.
- Default storage class:
- Location: Specify a bucket location in the same region where you plan to create your TPU node. See TPU types and zones to learn where various TPU types are available.
This section demonstrates using the Cloud TPU provisioning
creating and managing Cloud TPU project resources. The
resources are comprised of a virtual machine (VM) and a Cloud TPU
resource that have the same name. These resources
must reside in the same region/zone as the bucket you just created.
You can also set up your VM and TPU resources using
gcloud commands or through
the Cloud Console. See the
creating and deleting TPUs page
to learn all the ways you can set up and manage your Compute Engine VM
and Cloud TPU resources.
ctpu up to create resources
Open a Cloud Shell window.
gcloud config set project <Your-Project>to use the project where you want to create Cloud TPU.
ctpu upspecifying the flags shown for either a Cloud TPU device or Pod slice. Refer to CTPU Reference for flag options and descriptions.
Set up a Cloud TPU device:
$ ctpu up
The following configuration message appears:
ctpu will use the following configuration: Name: [your TPU's name] Zone: [your project's zone] GCP Project: [your project's name] TensorFlow Version: 1.14 VM: Machine Type: [your machine type] Disk Size: [your disk size] Preemptible: [true or false] Cloud TPU: Size: [your TPU size] Preemptible: [true or false] OK to create your Cloud TPU resources with the above configuration? [Yn]:
Press y to create your Cloud TPU resources.
ctpu up command creates a virtual machine (VM) and Cloud TPU
From this point on, a prefix of
(vm)$ means you should run the command on the
Compute Engine VM instance.
Verify your Compute Engine VM
ctpu up command has finished executing, verify that your shell
prompt has changed from
change shows that you are now logged into your Compute Engine VM.
Install additional packages
For this model, you need to install the following additional packages on your Compute Engine instance:
(vm)$ sudo apt-get install python-pil python-numpy && \ pip install --user jupyter && \ pip install --user matplotlib && \ pip install --user PrettyTable
Clone the TensorFlow models and tpu repositories
Run the following command to clone the TensorFlow models repository to your Compute Engine instance:
(vm)$ git clone https://github.com/tensorflow/models.git && \ git clone https://github.com/tensorflow/tpu.git
Add tensorflow/models/research/ to PYTHONPATH
Next, add the models in
tensorflow/models/research to the
(vm)$ cd ~/models/research && \ export PYTHONPATH=$PYTHONPATH:`pwd`:`pwd`/slim
Download and convert the PASCAL VOC 2012 dataset
This model uses the PASCAL VOC 2012 dataset for training and evaluation. Run the
following script to download the dataset and convert it to TensorFlow's
(vm)$ cd ~/models/research/deeplab/datasets/ && \ bash download_and_convert_voc2012.sh && \ cd ~/
Download the pretrained checkpoint
In this step, you download the a modified resnet 101 pretrained checkpoint. To start, download the checkpoint:
(vm)$ wget http://download.tensorflow.org/models/resnet_v1_101_2018_05_04.tar.gz
Then, extract the contents of the
(vm)$ tar -vxf resnet_v1_101_2018_05_04.tar.gz
Upload data to your Cloud Storage bucket
At this point, you can now upload your data to the Cloud Storage bucket you created earlier:
(vm)$ gsutil cp -r ~/models/research/deeplab/datasets/pascal_voc_seg/tfrecord gs://YOUR-BUCKET-NAME && gsutil -m cp -r ~/resnet_v1_101 gs://YOUR-BUCKET-NAME
Train the model
You're now ready to train the model. Be sure to change
to the name of your Cloud Storage bucket.
(vm)$ python ~/tpu/models/experimental/deeplab/main.py \ --mode='train' \ --num_shards=8 \ --alsologtostderr=true \ --model_dir=gs://YOUR-BUCKET-NAME \ --dataset_dir=gs://YOUR-BUCKET-NAME/tfrecord \ --init_checkpoint=gs://YOUR-BUCKET-NAME/resnet_v1_101/model.ckpt \ --model_variant=resnet_v1_101_beta \ --image_pyramid=1. \ --aspp_with_separable_conv=false \ --multi_grid=1 \ --multi_grid=2 \ --multi_grid=4 \ --decoder_use_separable_conv=false \ --train_split='train'
Evaluate the model
When the training completes, you can evaluate the model. To do so, change the
--mode flag from
(vm)$ python ~/tpu/models/experimental/deeplab/main.py \ --mode='eval' \ --num_shards=8 \ --alsologtostderr=true \ --model_dir=gs://YOUR-BUCKET-NAME \ --dataset_dir=gs://YOUR-BUCKET-NAME/tfrecord \ --init_checkpoint=gs://YOUR-BUCKET-NAME/resnet_v1_101/model.ckpt \ --model_variant=resnet_v1_101_beta \ --image_pyramid=1. \ --aspp_with_separable_conv=false \ --multi_grid=1 \ --multi_grid=2 \ --multi_grid=4 \ --decoder_use_separable_conv=false \ --train_split='train'
To avoid incurring charges to your GCP account for the resources used in this topic:
Disconnect from the Compute Engine VM:
Your prompt should now be
user@projectname, showing you are in the Cloud Shell.
In your Cloud Shell, run
ctpu deletewith the --zone flag you used when you set up the Cloud TPU to delete your Compute Engine VM and your Cloud TPU:
$ ctpu delete [optional: --zone]
ctpu statusto make sure you have no instances allocated to avoid unnecessary charges for TPU usage. The deletion might take several minutes. A response like the one below indicates there are no more allocated instances:
2018/04/28 16:16:23 WARNING: Setting zone to "us-central1-b" No instances currently exist. Compute Engine VM: -- Cloud TPU: --
gsutilas shown, replacing
YOUR-BUCKET-NAMEwith the name of the Cloud Storage bucket you created for this tutorial:
$ gsutil rm -r gs://YOUR-BUCKET-NAME
- Learn more about
ctpu, including how to install it on a local machine.
- Explore the TPU tools in TensorBoard.