Getting Started
Prerequisites
Check the Support Matrix to make sure that you have the supported hardware and software stack.
NGC Authentication
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. If this key is to be reused for other purposes, you can include more services.
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.
Launching the NIM Container
The following command launches the Background Noise Removal NIM container with the gRPC service. For a list of parameters, see Runtime Parameters for the Container.
Streaming NIM (recommended):
Streaming mode provides lower latency than transactional mode because it processes audio chunk-by-chunk without file I/O overhead. By default, streaming mode selects the v2-48k model.
Transactional NIM:
The flag --gpus all is used to assign all available GPUs to the Docker container. This fails on multiple GPU unless all GPUs are same. To assign specific GPUs to the Docker container (when multiple GPUs are available in your machine), use --gpus '"device=0,1,2..."'.
If the command runs successfully, you get an output ending similar to the following:
By default, the Background Noise Removal gRPC service is hosted on port 8001. You must use this port for inferencing requests.
Selecting a Model Profile
You can select a model profile by using the optional NIM_MODEL_PROFILE parameter. If you don’t provide NIM_MODEL_PROFILE, the NIM automatically selects a matching NIM_MODEL_PROFILE based on the target hardware architecture of Model Type v2-48k.
However, if you specify NIM_MODEL_PROFILE, ensure that the associated GPU architecture is compatible with the target hardware. An incorrect NIM_MODEL_PROFILE produces a deserialization error on inference.
If a non-supported GPU is used for launching the NIM, you get an error:
nimlib.exceptions.NIMProfileIDNotFound: Could not match a profile in manifest at /opt/nim/etc/default/model_manifest.yaml.
For more information about NIM_MODEL_PROFILE, refer to the NIM Model Profile Table.
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
Stopping the Container
The following commands can be used to stop the container.