Relighting

Generate API Key

Pull and Run the NIM

NVIDIA AI for Media Relighting uses gRPC APIs for inferencing requests.

An NGC API Key is required to pull the container image and download models from NGC. Pass the value of the API Key to the docker run command in the next section as the NGC_API_KEY environment variable as indicated.

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:

export NGC_API_KEY=<PASTE_API_KEY_HERE>

Run one of the following commands to make the key available at startup:

# If using bash
echo "export NGC_API_KEY=<value>" >> ~/.bashrc

# If using zsh
echo "export NGC_API_KEY=<value>" >> ~/.zshrc

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.

To pull the NIM container image from NGC, first authenticate with the NVIDIA Container Registry with the following command:

echo "$NGC_API_KEY" | docker login nvcr.io --username '$oauthtoken' --password-stdin

Optionally, set the manifest profile that matches your GPU architecture. If omitted, the NIM automatically selects the correct profile based on the detected hardware.

export NIM_MANIFEST_PROFILE=<enter_valid_manifest_profile_id>

The following command launches the Relighting container with the gRPC service. Find reference to runtime parameters for the container here.

docker run -it --rm --name=relighting-nim \
  --runtime=nvidia \
  --gpus all \
  --shm-size=8GB \
  -e NGC_API_KEY=$NGC_API_KEY \
  -e NIM_MANIFEST_PROFILE=$NIM_MANIFEST_PROFILE \
  -e NIM_MAX_CONCURRENCY_PER_GPU=1 \
  -e NIM_HTTP_API_PORT=8000 \
  -e NIM_GRPC_API_PORT=8001 \
  -p 8000:8000 \
  -p 8001:8001 \
  -p 9002:9002 \
  nvcr.io/nim/nvidia/ai4m-relighting:1.1.0

Please note, the flag --gpus all is used to assign 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 will get an output ending similar to the following:

Triton server is ready
[INFO MAXINE BASE LOGGER ... base_service.py:_serve_threading:295 PID:...] Using Insecure Server Credentials
[INFO MAXINE BASE LOGGER ... base_service.py:_serve_threading:300 PID:...] Listening to 0.0.0.0:8001

By default the Relighting gRPC service is hosted on port 8001. You will use this port for inferencing requests. The port is configurable via the NIM_GRPC_API_PORT environment variable.

Verify the NIM is Ready

Install grpcurl from github.com/fullstorydev/grpcurl/releases and perform a health check:

wget https://raw.githubusercontent.com/grpc/grpc/master/src/proto/grpc/health/v1/health.proto
grpcurl --plaintext --proto health.proto localhost:8001 grpc.health.v1.Health/Check

If the service is ready, you get a response similar to:

{ "status": "SERVING" }

Test the NIM

You will need a system with git and Python 3.10+ installed.

Download the Relighting Python client code by cloning the NVIDIA AI for Media NIM Clients Repository:

git clone https://github.com/NVIDIA-Maxine/nim-clients.git
cd nim-clients/relighting

Install the dependencies for the Python client:

pip install -r requirements.txt

Go to the scripts directory:

cd scripts

Run the command to send a gRPC request:

python3 relighting.py --target <server_ip:port> --video-input <input_file_path> --output <output_file_path>

Example command with sample input:

python3 relighting.py --target 127.0.0.1:8001 --video-input ../assets/sample_video.mp4 --output output.mp4

For more details on getting started with this NIM including configuring parameters, visit the Relighting Docs.