Install the VFX SDK

To install the VFX SDK, navigate to the VFX SDK Collection page, on the NVIDIA GPU Cloud (NGC) website, and follow the Getting Started instructions.

The SDK package includes the API headers, library files, and runtime dependencies. Sample apps are hosted separately on NVIDIA-Maxine/VFX-SDK-Samples.

The core SDK package does not contain the feature libraries and models that are required to run any of the VFX effects. To install feature libraries and model files, use the install_feature.ps1 script. The script fetches the libraries and models from the NVIDIA GPU Cloud (NGC).

To use the automated script to install the feature library and models, obtain your NGC API KEY using the steps in the NGC User Guide. Afterward, run the following commands in PowerShell:

REM Run the following commands to install PowerShell 7:

winget install --id Microsoft.PowerShell --source winget
winget install --id Microsoft.PowerShell.Preview --source winget

REM Allow download script to run without any restrictions or warnings:

Set-ExecutionPolicy Bypass -Scope Process
cd /path/to/VFXSDK/features/
$Env:NGC_CLI_API_KEY = "<your-ngc-api-key>"
./install_feature.ps1 -gpu <your_GPU> -features <feature_name> -ngc_org <NGC_ORG> -ngc_team <NGC_TEAM>

========================================
VFX SDK Feature Installation Script
========================================

Usage: .\install_feature_vfx.ps1 [OPTIONS]

Options:
  -gpu <gpu>            : GPU compute capability (e.g., 75, 86, 89, 120)
                          Optional - will auto-detect if not specified
  -features <features>  : Feature(s) to install (case-insensitive, default: all)
                          Can be a single feature, comma-separated list, or 'all'
  -version <version>    : Feature version (default: 1.0.0.0)
  -ngc_org <org>        : NGC organization (default: nvidia)
  -ngc_team <team>      : NGC team (default: maxine)
  -list_features        : Query NGC for complete list of available features
  -help                 : Show this help message

Examples:
  # Install single feature (auto-detect GPU):
  .\install_feature_vfx.ps1 -features nvvfxgreenscreen

  # Install single feature with specific GPU:
  .\install_feature_vfx.ps1 -gpu 89 -features nvvfxgreenscreen

  # Install multiple features (comma-separated):
  .\install_feature_vfx.ps1 -gpu 89 -features nvvfxgreenscreen,nvvfxartifactreduction,nvvfxdenoising

  # Install all features:
  .\install_feature_vfx.ps1 -gpu 89 -features all

Example Maxine VFX SDK features (non-exhaustive, case-insensitive):
  * nvvfxartifactreduction  - Artifact reduction
  * nvvfxsuperres           - Super resolution
  * nvvfxdenoising          - Video denoising
  * nvvfxupscale            - Video upscaling
  * nvvfxgreenscreen        - AI green screen
  * nvvfxbackgroundblur     - Background blur
  * nvvfxrelighting         - Relighting
  * nvvfxaigsrelighting     - AI green screen relighting

For complete list of features, use: -list_features

Supported GPU compute capabilities: 75, 86, 89, 120

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