.. DO NOT EDIT. .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY. .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE: .. "build/examples_distributed/distributed_slowfast.py" .. LINE NUMBERS ARE GIVEN BELOW. .. only:: html .. note:: :class: sphx-glr-download-link-note Click :ref:`here ` to download the full example code .. rst-class:: sphx-glr-example-title .. _sphx_glr_build_examples_distributed_distributed_slowfast.py: 1. Distributed training of deep video models ================================================ Training deep neural networks on videos is very time consuming. For example, training a state-of-the-art SlowFast network [Feichtenhofer18]_ on Kinetics400 dataset (with 240K 10-seconds short videos) using a server with 8 V100 GPUs takes more than 10 days. Slow training causes long research cycles and is not friendly for new comers and students to work on video related problems. Using distributed training is a natural choice. Spreading the huge computation over multiple machines can speed up training a lot. However, only a few open sourced Github repositories on video understanding support distributed training, and they often lack documentation for this feature. Besides, there is not much information/tutorial online on how to perform distributed training for deep video models. Hence, we provide a simple tutorial here to demonstrate how to use our code to perform distributed training of SlowFast models on Kinetics400 dataset. .. GENERATED FROM PYTHON SOURCE LINES 19-39 Distributed training -------------------- There are two ways in which we can distribute the workload of training a neural network across multiple devices, data parallelism and model parallelism. Data parallelism refers to the case where each device stores a complete copy of the model. Each device works with a different part of the dataset, and the devices collectively update a shared model. When models are so large that they don't fit into device memory, then model parallelism is useful. Here, different devices are assigned the task of learning different parts of the model. In this tutorial, we describe how to train a model with devices distributed across machines in a data parallel way. There are some key concepts in distributed training, such as server, worker, scheduler, kvstore, etc. Server is a node to store model's parameters or gradients, and communicate with workers. Worker is a node actually performing training on a batch of training samples. Before processing each batch, the workers pull weights from servers. The workers also send gradients to the servers after each batch. Scheduler is to set up the cluster for each node to communicate, and there is only one scheduler in the entire cluster Kvstore, which is key-value store, is a critical component used for multi-device training. It stores model parameters and optimizers, to receive gradient and update model. In order to keep this tutorial concise, I wouldn't go into details. Readers can refer to MXNet `official documentation `_ for more information. .. GENERATED FROM PYTHON SOURCE LINES 42-47 How to use our code to train a SlowFast model in a distributed manner? ---------------------------------------------------------------------- In order to perform distributed training, you need to (1) prepare the cluster; (2) install MXNet; and (3) prepare your code and data. .. GENERATED FROM PYTHON SOURCE LINES 49-62 We need a cluster that each node can communicate with each other. The first step is to generate ssh keys for each machine. For better illustration, let's assume we have four machines, node1, node2, node3 and node4. We use each of the machine as both server and worker. Note that, we can also have dedicated CPU machines as servers. First, ssh into node1 and type :: ssh-keygen -t rsa Just follow the default, you will have a file named ``id_rsa`` and a file named ``id_rsa.pub``, both under the ``~/.ssh/`` folder. ``id_rsa`` is the private RSA key, and ``id_rsa.pub`` is its public key. .. GENERATED FROM PYTHON SOURCE LINES 64-68 Second, copy both files (``id_rsa`` and ``id_rsa.pub``) of node1 to all other machines. For each machine, you will find an ``authorized_keys`` file under ``~/.ssh/`` folder as well. Append ``authorized_keys`` with the content of ``id_rsa.pub`` This step will make sure all the machines in the cluster is able to communicate with each other. .. GENERATED FROM PYTHON SOURCE LINES 70-73 Before moving on to next step, it is better to perform some sanity checks to make sure the communication is good. For example, if you can successfully ssh into other machines, it means they can communicate with each other now. You are good to go. If there is any error during ssh, you can use option ``-vvv`` to get verbose information for debugging. .. GENERATED FROM PYTHON SOURCE LINES 75-86 Once you get the cluster ready, it is time to install MXNet. MXNet provides a script ``tools/launch.py`` to make it easy to launch distributed training on a cluster with ssh, mpi, sge or yarn. Let's first install MXNet on all the machines. :: pip install mxnet-cu100 For more installation options (i.e., different versions of MXNet or CUDA), please check `GluonCV installation guide `_ for more information. One side note, `clush `_ is a good tool for cluster setup. It can be used for executing a command concurrently on a cluster of hosts, but we won't go into details here. .. GENERATED FROM PYTHON SOURCE LINES 88-95 Next, we need the script to launch the job, let's clone the repo as well. :: git clone https://github.com/apache/incubator-mxnet.git --recursive The script we need is under folder ``tools``, named ``launch.py``. Note that, this script can be put on any of the node because we only need it to launch the job. .. GENERATED FROM PYTHON SOURCE LINES 97-107 Now it is time to prepare your code and data in each node. The code needs to be in the same directoty on every machine so that a single command can work on multiple machines. Let's clone the GluonCV repo and install it, :: git clone https://github.com/dmlc/gluon-cv.git cd gluon-cv pip install -e . Similarly, the data needs to be in the same path on every machine as well so that the dataloader knows where to find the data. .. GENERATED FROM PYTHON SOURCE LINES 109-144 Finally, we can kickstart the training. Let's type the command below to start a training job with 4 machines. :: ../incubator-mxnet/tools/launch.py -n 4 -H host.txt --launcher ssh \ python ./scripts/action-recognition/train_recognizer.py --dataset kinetics400 \ --data-dir ~/.mxnet/kinetics400/train --val-data-dir ~/.mxnet/kinetics400/val \ --train-list ~/.mxnet/kinetics400/train.txt --val-list ~/.mxnet/kinetics400/val.txt \ --dtype float32 --mode hybrid --prefetch-ratio 1.0 --kvstore dist_sync_device \ --model slowfast_4x16_resnet50_kinetics400 --slowfast --slow-temporal-stride 16 \ --fast-temporal-stride 2 --video-loader --use-decord --num-classes 400 --batch-size 8 \ --num-gpus 8 --num-data-workers 32 --input-size 224 --new-height 256 --new-width 340 \ --new-length 64 --new-step 1 --lr-mode cosine --lr 0.4 --momentum 0.9 --wd 0.0001 \ --num-epochs 196 --warmup-epochs 34 --warmup-lr 0.01 --scale-ratios 1.0,0.8 \ --save-frequency 10 --log-interval 50 --logging-file slowfast_4x16.log --save-dir ./checkpoints Here, the ``host.txt`` file contains the private IP addresses of all machines, e.g., :: 123.123.1.123 123.123.2.123 123.123.3.123 123.123.4.123 ``--kvstore dist_sync_device`` is when there are multiple GPUs being used on each node, this mode aggregates gradients and updates weights on GPU. There are other modes, like dist_sync, dist_async etc. To find out more details, check out `this tutorial `_. Another thing to notice is the learning rate. For single node training, we set lr to 0.1. However, for multi-node training, we increase it to 0.4 because we have four machines. It's a good practice, called linear scaling rule, introduced in [Goyal17]_. When the minibatch size is multiplied by k, multiply the learning rate by k. All other hyper-parameters (weight decay, etc.) are kept unchanged. The linear scaling rule can help us to not only match the accuracy between using small and large minibatches, but equally importantly, to largely match their training curves, which enables rapid debugging and comparison of experiments prior to convergence. If everything is setup well, you will see the model is training now. All printed information will be captured and sent to the machine running launch.py. Checkpoints will be saved locally on each machine. .. GENERATED FROM PYTHON SOURCE LINES 146-154 Speed ----- Usually, the training will be faster when you use more machines, but not linear upscaling due to the communication cost. The actual speed up depends on the network bandwidth, server CPU capibility, dataloader efficiency, etc. For example, if you use our code on four P3.16xlarge machines on AWS in the same placement group, you will get 3x speed boost. Similar speed up ratio (0.75) can be observed when you use 8 machines or more. In our case, we use eight P3.16xlarge machines to train a ``slowfast_4x16_resnet50_kinetics400`` model. The training can be completed in 1.5 days. .. GENERATED FROM PYTHON SOURCE LINES 156-174 FAQ --- Q1: I see the error message below, what should I do? :: Permissions for 'id_rsa' are too open. It is recommended that your private key files are NOT accessible by others. This private key will be ignored. Answer: you need to make sure the permission of id_rsa is good via ``chmod 400 id_rsa`` after the copy. Q2: I can't find the file ``.ssh/authorized_keys``. Answer: Just create one with :: touch ~/.ssh/authorized_keys chmod 600 ~/.ssh/authorized_keys .. GENERATED FROM PYTHON SOURCE LINES 176-186 References ---------- .. [Goyal17] Priya Goyal, Piotr Dollár, Ross Girshick, Pieter Noordhuis, Lukasz Wesolowski, Aapo Kyrola, Andrew Tulloch, Yangqing Jia, Kaiming He. \ "Accurate, Large Minibatch SGD: Training ImageNet in 1 Hour." \ arXiv preprint arXiv:1706.02677 (2017). .. [Feichtenhofer18] Christoph Feichtenhofer, Haoqi Fan, Jitendra Malik, Kaiming He. \ "SlowFast Networks for Video Recognition." \ arXiv preprint arXiv:1812.03982 (2018). .. rst-class:: sphx-glr-timing **Total running time of the script:** ( 0 minutes 0.000 seconds) .. _sphx_glr_download_build_examples_distributed_distributed_slowfast.py: .. only :: html .. container:: sphx-glr-footer :class: sphx-glr-footer-example .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: distributed_slowfast.py ` .. container:: sphx-glr-download sphx-glr-download-jupyter :download:`Download Jupyter notebook: distributed_slowfast.ipynb ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_