Is this page helpful?

Install the VFX SDK#

The VFX SDK comprises the SDK Core and a set of optional features that can be downloaded and installed individually. The SDK Core and features are distributed through the NVIDIA GPU Cloud (NGC) platform.

The SDK Core includes the API headers, library files, and runtime dependencies. It does not include the libraries and models that are required to run any of the features. After installation, the SDK Core provides a script to fetch and install features from NGC.

To download the VFX SDK Core, navigate to NVIDIA Video Effects SDK Collection on the NVIDIA GPU Cloud (NGC) website, and follow the instructions in the “Getting Started” section.

The SDK is delivered as a .tgz package, which is a compressed tar format. Before extracting the SDK Core package, install xz-utils if it is not already installed. For example, on Ubuntu use the command sudo apt install xz-utils.

To install the SDK Core, extract the contents of the VFX SDK Core package as follows:
```
sudo tar -xvf VFXSDK_linux_<version>.tgz -C /usr/local
```
To use the install_feature.sh script for feature installation, obtain your NGC API key by using the steps in Generating a Personal API Key in the NGC User Guide. Then use the following template commands to install a feature:
```
cd /usr/local/VideoFX/features
export NGC_CLI_API_KEY=<your_API_key>
sudo --preserve-env=NGC_CLI_API_KEY ./install_feature.sh --gpu <your_GPU> --feature <feature_name> --ngc-org <NGC_ORG> --ngc-team <NGC_TEAM>
```

Note

When running in privileged mode, omit sudo --preserve-env=NGC_CLI_API_KEY; however, the NGC_CLI_API_KEY environment variable must still be set.

The following lists the arguments and usage for the install_feature.sh script:

========================================
VFX SDK Feature Installation Script
=======================================
Usage: install_feature.sh [OPTIONS]
Options:
  -g, --gpu <gpu>        GPU architecture (e.g., a100, b200)
  -f, --feature <list>   Feature(s) to install (case-insensitive, default: all)
                        Can be a single feature, comma-separated list, or 'all'
  -v, --version <ver>    Feature version (default: latest from NGC)
                        applicable when specific features are specified (not 'all')
  --ngc-org <org>        NGC organization (default: nvidia)
  --ngc-team <team>      NGC team (default: maxine)
  --list-features        Query NGC for complete list of available features
  -h, --help             Show this help message

Examples:
  # Install single feature (auto-detect GPU and latest compatible version):
  sudo --preserve-env=NGC_CLI_API_KEY ./install_feature.sh -f nvvfxgreenscreen

  # Install single feature with specific GPU:
  sudo --preserve-env=NGC_CLI_API_KEY ./install_feature.sh -f nvvfxgreenscreen -g a100

  # Install single feature with specific version:
  sudo --preserve-env=NGC_CLI_API_KEY ./install_feature.sh -f nvvfxvideosuperres -v 1.2.0.0

  # Install multiple features (comma-separated):
  sudo --preserve-env=NGC_CLI_API_KEY ./install_feature.sh -f nvvfxgreenscreen,nvvfxvideosuperres,nvvfxdenoising

  # Install all features:
  sudo --preserve-env=NGC_CLI_API_KEY ./install_feature.sh -f all

Example VFX SDK features (non-exhaustive, case-insensitive):
  • nvvfxvideosuperres      - Video super resolution
  • nvvfxdenoising          - Video denoising
  • nvvfxupscale            - Video upscaling
  • nvvfxgreenscreen        - AI green screen
  • nvvfxbackgroundblur     - Background blur

For complete list of features, use: --list-features

Note: Dependencies are installed automatically and won't be reinstalled if already present

Supported GPUs: a40/l40/l4/a30/b200/a2/h100/a10/t4/b100/a16/a100/b40

The following table lists supported GPUs and their corresponding CUDA Compute Capability versions:

GPU	CUDA CC
t4	7.5
a100, a30	8.0
a2, a10, a16, a40	8.6
l4, l40	8.9
h100	9.0
b100, b200	10.0
b40	12.0

For a full list of NVIDIA GPUs and their corresponding CUDA Compute Capability versions, see the CUDA GPU Compute Capability table.