Introduction

NVIDIA® GPU Cloud (NGC) containers leverage the power of GPUs based on the NVIDIA Pascal™ and Volta™ architecture. NVIDIA DGX systems as well as Volta and Pascal-based virtual machines hosted on cloud service providers utilize these GPUs.

Aside from these classes of hardware, NGC containers can also run on PCs installed with an NVIDIA TITAN X (Pascal), TITAN Xp, or TITAN V graphics card. The document describes how to set up an NVIDIA TITAN PC to run NGC containers. Open the command line on the Ubuntu desktop and paste the code blocks into the command line.

Prerequisites

These instructions assume the following:
  • You have a single NVIDIA TITAN X (Pascal), TITAN Xp, or TITAN V installed on your PC.
  • You have Ubuntu Desktop 16.04 with 4.10 kernel installed. Ubuntu Desktop can be downloaded from https://www.ubuntu.com/download/desktop/.

Installing the NVIDIA Driver

NGC containers take advantage of the power of NVIDIA GPUs. Be sure your system is installed with the appropriate NVIDIA drivers.

Setting Up the Driver Repository

Install the NVIDIA Developer repository in preparation for installing the NVIDIA driver. The following code block
  1. Installs apt-transport-https.
  2. Installs curl.
  3. Sets up the /etc/apt/sources.list.d/cuda.list file.
  4. Installs the CUDA repository key.
  5. Raises the priority for the NVIDIA repository.
sudo apt-get install -y apt-transport-https curl 
cat <<EOF | sudo tee /etc/apt/sources.list.d/cuda.list > /dev/null 
deb https://developer.download.nvidia.com/compute/cuda/repos/ubuntu1604/x86_64 / 
EOF 

curl -s \
 https://developer.download.nvidia.com/compute/cuda/repos/ubuntu1604/x86_64/7fa2af80.pub \
 | sudo apt-key add - 

cat <<EOF | sudo tee /etc/apt/preferences.d/cuda > /dev/null 
Package: * 
Pin: origin developer.download.nvidia.com 
Pin-Priority: 600 
EOF

Installing the Drivers

These instructions will download a local copy of the NVIDIA drivers, set the priority of the local repo, and install the drivers.These steps are temporary and will be replaced once the developer.download.nvidia.com repository is updated with the latest drivers.
  1. Install the NVIDIA driver packages and reboot.
    wget -P /tmp https://us.download.nvidia.com/titan/linux/387.34/nvidia-driver-local-repo-ubuntu1604-387.34_1.0-1_amd64.deb
    sudo dpkg -i /tmp/nvidia-driver-local-repo-ubuntu1604-387.34_1.0-1_amd64.deb
    cat <<EOF | sudo tee /etc/apt/preferences.d/local-cuda > /dev/null
    Package: *
    Pin: origin ""
    Pin-Priority: 600
    EOF
    sudo apt-get update && sudo apt-get install -y cuda-drivers
    sudo reboot
     
    
  2. Upon reboot, confirm that you can see your TITAN card in the nvidia-smi output.
    nvidia-smi
    Example output (TITAN card in bold):
    +-----------------------------------------------------------------------------+
    | NVIDIA-SMI 387.34                 Driver Version: 387.34                    |
    |-------------------------------+----------------------+----------------------+
    | GPU  Name        Persistence-M| Bus-Id        Disp.A | Volatile Uncorr. ECC |
    | Fan  Temp  Perf  Pwr:Usage/Cap|         Memory-Usage | GPU-Util  Compute M. |
    |===============================+======================+======================|
    |   0 TITAN V              Off  | 00000000:02:00.0  On |                  N/A |
    | 23%   30C    P8    10W / 250W |    468MiB / 12188MiB |      0%      Default |
    +-------------------------------+----------------------+----------------------+

Installing Docker and the Docker Utility Engine for NVIDIA GPUs

The Docker runtime is required to run NGC containers. In addition, the Docker Utility Engine for NVIDIA GPUs (nvidia-docker) ensures that the high performance power of the GPU is leveraged when running NVIDIA-optimized Docker containers.

Installing the Docker Repository

The following code block will install the "docker-ce" repository. Refer to https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-docker-ce for more information.

The following code block

  1. Installs the Docker prerequisites.
  2. Adds the Docker official GPG key.
  3. Adds the official stable Docker repository.
sudo apt-get install -y ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository \
 "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" 

Installing the Docker Utility Engine for NVIDIA GPUs and Configuring Docker

NVIDIA recommends custom Docker settings for running NGC containers to achieve the best performance and compatibility. These settings are as follows:

Option Explanation
--disable-legacy-registry Disable v1 registries for security
--default-shm-size="1G" Set the default shared memory size to 1G
--host=fd:// Indicate systemd is starting the service, and to use socket activation
--storage-driver=overlay2 Use the overlay2 storage driver
LimitMEMLOCK=infinity Prevent memory from being paged out
LimitSTACK=67108864 Increase the stack limit to 64G
Issue the following commands to
  1. Install the Docker Utility Engine (nvidia-docker) repository and install.
  2. Configure the recommended settings.
  3. Set up permissions to use Docker without sudo each time.
  4. Reboot for the configuration and permissions to take effect.
curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | \
  sudo apt-key add -
curl -s -L https://nvidia.github.io/nvidia-docker/ubuntu16.04/amd64/nvidia-docker.list | \
  sudo tee /etc/apt/sources.list.d/nvidia-docker.list
sudo apt-get update
sudo apt-get install -y nvidia-docker

sudo mkdir -p /etc/systemd/system/docker.service.d/
cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/override.conf > /dev/null
[Service]
ExecStart=
ExecStart=/usr/bin/dockerd --disable-legacy-registry \\
 --default-shm-size="1G" \\
 --host=fd:// \\
 --storage-driver=overlay2
LimitMEMLOCK=infinity
LimitSTACK=67108864
EOF

sudo usermod -aG docker $USER
sudo reboot 
Note: This process will also install the Docker CE package, since it is a dependency for nvidia-docker. For more installation information, see https://github.com/NVIDIA/nvidia-docker/wiki/Installation-(version-1.0).

Using NGC Containers

Make sure you have performed the following steps from the NGC website (see the NGC Getting Started Guide)
  • Signed up for an NGC account at https://ngc.nvidia.com/signup.
  • Created an NGC API key for access to the NGC container registry.
  • Browsed the NGC website and identified an available NGC container and tag to run.
See the following documents for detailed instructions on using NGC Containers.

Notices

Notice

THE INFORMATION IN THIS GUIDE AND ALL OTHER INFORMATION CONTAINED IN NVIDIA DOCUMENTATION REFERENCED IN THIS GUIDE IS PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE INFORMATION FOR THE PRODUCT, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the product described in this guide shall be limited in accordance with the NVIDIA terms and conditions of sale for the product.

THE NVIDIA PRODUCT DESCRIBED IN THIS GUIDE IS NOT FAULT TOLERANT AND IS NOT DESIGNED, MANUFACTURED OR INTENDED FOR USE IN CONNECTION WITH THE DESIGN, CONSTRUCTION, MAINTENANCE, AND/OR OPERATION OF ANY SYSTEM WHERE THE USE OR A FAILURE OF SUCH SYSTEM COULD RESULT IN A SITUATION THAT THREATENS THE SAFETY OF HUMAN LIFE OR SEVERE PHYSICAL HARM OR PROPERTY DAMAGE (INCLUDING, FOR EXAMPLE, USE IN CONNECTION WITH ANY NUCLEAR, AVIONICS, LIFE SUPPORT OR OTHER LIFE CRITICAL APPLICATION). NVIDIA EXPRESSLY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR SUCH HIGH RISK USES. NVIDIA SHALL NOT BE LIABLE TO CUSTOMER OR ANY THIRD PARTY, IN WHOLE OR IN PART, FOR ANY CLAIMS OR DAMAGES ARISING FROM SUCH HIGH RISK USES.

NVIDIA makes no representation or warranty that the product described in this guide will be suitable for any specified use without further testing or modification. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to ensure the product is suitable and fit for the application planned by customer and to do the necessary testing for the application in order to avoid a default of the application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additional or different conditions and/or requirements beyond those contained in this guide. NVIDIA does not accept any liability related to any default, damage, costs or problem which may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this guide, or (ii) customer product designs.

Other than the right for customer to use the information in this guide with the product, no other license, either expressed or implied, is hereby granted by NVIDIA under this guide. Reproduction of information in this guide is permissible only if reproduction is approved by NVIDIA in writing, is reproduced without alteration, and is accompanied by all associated conditions, limitations, and notices.

Trademarks

NVIDIA, the NVIDIA logo, and Volta are trademarks and/or registered trademarks of NVIDIA Corporation in the Unites States and other countries.

Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.

Other company and product names may be trademarks of the respective companies with which they are associated.