Getting Started
Authenticate with NGC, launch the Synthetic Video Detector NIM container, and set environment variables and runtime flags before you send inference requests.
Prerequisites
To ensure that you have the supported hardware and software stack, check the Support Matrix.
- NVIDIA GPU with Tensor cores and supported NVDEC (for hardware decoding).
- Recent NVIDIA driver and NVIDIA Container Toolkit correctly installed.
- Docker Engine installed and configured to access GPUs.
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
NVIDIA Synthetic Video Detector NIM is available only through the AI for Media Private Access Program. Joining the Private Access Program gives you an NGC API key with the permissions required for this NIM.
You can generate a key at NGC API Keys after joining the Private Access Program.
When creating an NGC API Personal key, ensure that at least NGC Catalog is selected from the Services Included dropdown. You can include more services 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, refer to NGC API Keys in 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.
Before pulling the container image, you must accept the Governing Terms on the Synthetic Video Detector NIM container page in NGC. This page is accessible only after enrollment in the AI for Media Private Access Program.
Launching the Container (Synthetic Video Detector NIM)
The following command launches the Synthetic Video Detector NIM container with the gRPC service. For a list of parameters, refer to Runtime Parameters for the Container.
By default, the NIM detects the host GPU architecture and downloads the matching model profile automatically. To pin a specific profile instead, refer to Overriding the Model Profile.
You can also 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..."'.
On bare-metal Linux systems with PCIe topology and multiple GPUs, the NIM pins each request to one GPU by default. To let Triton schedule across GPUs instead, set IOMMU to passthrough and NV_AI4M_SVD_PIN_MODEL_TO_SHM_GPU=false. Refer to PCIe Multi-GPU Systems.
If the docker run command runs successfully, you get a response similar to the following.
By default, the Synthetic Video Detector 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 Docker flags used in the launch command:
Stopping the Container
The following commands can be used to stop the container.