Install the AR SDK and Associated Software

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

The SDK is delivered as a .tar.gz package, which is a compressed tar format.

See the README_quickstart.md file for more detailed instructions about setting up the environment and prerequisites to use the SDK. Install xz-utils to uncompress the SDK tarball if it is not already installed.

• To install the SDK:

  $ sudo apt update
  $ sudo apt install xz-utils
  $ sudo tar -xvf NVIDIA_AR_SDK_linux_<version>.tar.gz -C /usr/local
  

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

• To use the automated script for feature installation, obtain your NGC API key using the steps here (https://docs.nvidia.com/ngc/gpu-cloud/ngc-user-guide/index.html#generating-api-key) and run the following commands:

  $ cd /usr/local/ARSDK/features
  $ export NGC_API_KEY=<your_API_key>
  $ ./install_feature.sh --gpu <your_GPU> --feature <feature_name> --ngc-org <NGC_ORG> --ngc-team <NGC_TEAM>
  

  ========================================
  ARSDK 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 or comma-separated list
    -v <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
    -h                    Show this help message
  
  Examples:
    # Install single feature:
    install_feature.sh -f nvargazeredirection
  
    # Install multiple features (comma-separated):
    install_feature.sh -f nvargazeredirection,nvarlipsync,nvarbodydetection
  
  Example Maxine AR SDK features (non-exhaustive, case-insensitive):
    • nvarbodyposeestimation  - Body pose estimation
    • nvarbodydetection       - Body detection
    • nvarlandmarkdetection   - Face landmark tracking
    • nvargazeredirection     - Eye contact/gaze redirection
    • nvarlipsync             - Lip synchronization
    • nvarfaceexpressions     - Face expression estimation
  
  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.