Getting Started
Authenticate with NGC, launch the Eye Contact NIM container, and set environment variables and runtime flags before you send inference requests.
Prerequisites
Check the Support Matrix to make sure that you have the supported hardware and software stack.
NGC Authentication
An NGC API key is required to pull the container image and download models. Complete the following steps to create the key, export it, and log in to the NVIDIA Container Registry.
Generate an API Key
An NGC API key is required to access NGC resources. You can generate a key at NGC API Keys.
When creating an NGC API Personal key, ensure that at least “NGC Catalog” is selected from the “Services Included” dropdown. More Services can be included if this key is to be reused for other purposes.
Personal keys allow you to configure an expiration date, revoke or delete the key using an action button, and rotate the key as needed. For more information about key types, please refer the NGC User Guide.
Export the API Key
Pass the value of the API key to the docker run command in the next section as the NGC_API_KEY environment variable to download the appropriate models and resources when starting the NIM.
If you are not familiar with how to create the NGC_API_KEY environment variable, the simplest way is to export it in your terminal:
Run one of the following commands to make the key available at startup:
Other, more secure options include saving the value in a file, so that you can retrieve with cat $NGC_API_KEY_FILE, or using a password manager.
Docker Login to NGC
To pull the NIM container image from NGC, first authenticate with the NVIDIA Container Registry with the following command:
Use $oauthtoken as the username and NGC_API_KEY as the password. The $oauthtoken username is a special name that indicates that you will authenticate with an API key and not a user name and password.
Launching the NIM Container
The following command launches the Eye Contact NIM container with the gRPC service. For a list of parameters, refer to Runtime Parameters for the Container.
There is also an option to cache the model manifest locally. For more details, refer to Model Caching.
The flag --gpus all assigns all available GPUs to the Docker container.
To assign specific GPUs to the Docker container (in case of multiple GPUs available in your machine), use --gpus '"device=0,1,2..."'.
If the command runs successfully, you get a response similar to the following.
By default, the Eye Contact gRPC service is hosted on port 8001. You must use this port for inferencing requests.
Environment Variables
The following table describes the environment variables that can be passed into a NIM as a -e argument added to a docker run command:
Runtime Parameters for the Container
The following table describes the docker run flags used to launch the Eye Contact NIM container.
Stopping the Container
Use the following commands to stop the container: