Pulling and Running NVIDIA AI Enterprise Containers

The AI and data science applications and frameworks are distributed as NGC container images through the NVIDIA NGC Enterprise Catalog. Each container image contains the entire user-space software stack that is required to run the application or framework; namely, the CUDA libraries, cuDNN, any required Magnum IO components, TensorRT, and the framework.

Execute the following workflow steps within the environment with which you would like to pull AI and data science containers into.

First you will need to sign into NGC with your NVIDIA account and password.

ngc1.png

Navigate to setup.

ngc2.png

Select “Get API Key”.

ngc3.png

Generate your API key.

ngc4.png

Confirm Generate a New API Key.

ngc5.png

Copy your API Key to the clipboard

Note

Selecting confirm will generate a new API key, and your old API key will become invalid (if applicable).

ngc6.png

When you are interacting with the repository from the command line you are required to use an API key if you want to pull locked container images or push back to the registry. The API key is unique to you and tied to your account.

Important

Keep your API key secret and in a safe place. Do not share it or store it in a place where others can see or copy it.


Return to the SSH session and/or environment terminal to log into Docker and begin pulling containers down from the NVIDIA AI Enterprise Catalog.

Log into the NGC container registry.

Copy
Copied!
            

docker login nvcr.io


When prompted for your username, enter the following text:

Copy
Copied!
            

$oauthtoken

Note

The $oauthtoken username is a special username that indicates that you will authenticate with an API key and not a username and password.


When prompted for your password, paste your NGC API key as shown in the following example.

Copy
Copied!
            

Username: $oauthtoken Password: my-api-key

Note

When you get your API key as explained in Generating Your NGC API Key, copy it to the clipboard so that you can paste the API key into the command shell when you are prompted for your password.


An example container pull using Tensorflow has been provided with detailed steps in the below sections. We will use the “Pull Tag” function to easily copy and paste our container pull commands into the desired environment.

Navigate to the Enterprise Catalog.

ngc7.png

Navigate to Entities to find the TensorRT container tag (or any other containers you require):

ngc8.png

Select the desired container.

ngc9.png

Navigate to Pull Tag and copy the command to your clipboard.

ngc10.png

Paste the command into your SSH session

Copy
Copied!
            

docker pull nvcr.io/nvaie/tensorrt-2-0:22.02-nvaie-2.0-py3

ngc11.png

For each AI or data science application that you are interested in, load the container using the pull command function.

For reference, the Docker pull commands for downloading the container for each application or framework are detailed below with the context of <NVAIE-MAJOR-VERSION>:<NVAIE-CONTAINER-TAG>

To ensure your cloud instance is GPU accelerated, use docker run –gpus to run NVIDIA AI Enterprise containers in your cloud VMI instance.

  • Example using all GPUs

    Copy
    Copied!
                

    $ docker run --gpus all


  • Example using two GPUs

    Copy
    Copied!
                

    $ docker run --gpus 2


  • Example using specific GPUs

    Copy
    Copied!
                

    $ docker run --gpus "device=1,2" ... $ docker run --gpus "device=UUID-ABCDEF,1"


To run NVIDA AI Enterprise containers in your cloud VMI, refer to the Enterprise Catalog on NGC for the correct pull tag to use for a specific container, then enter the following docker images:

Log in to your cloud VMI instance via a terminal to run the MNIST example.

Note that the PyTorch example will download the MNIST dataset from the web.

  1. Pull and run the PyTorch container:

    Copy
    Copied!
                

    docker pull nvcr.io/nvaie/pytorch-2-0:22.02-nvaie-2.0-py3 docker run --gpus all --rm -it nvcr.io/nvaie/pytorch-2-0:22.02-nvaie-2.0-py3


  2. Run the MNIST example:

    Copy
    Copied!
                

    cd /workspace/examples/upstream/mnist python main.py


© Copyright 2022-2023, NVIDIA. Last updated on May 17, 2023.