Is this page helpful?

Install the AR SDK#

The AR 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 AR SDK Core, navigate to NVIDIA Augmented Reality SDK Collection on the NVIDIA GPU Cloud (NGC) website, and follow the instructions in the “Getting Started” section.

The SDK is delivered as a compressed .zip file.

  • To install the SDK Core, extract the contents of the AR SDK Core package to your desired location.

  • To use the install_feature.ps1 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:

    # Allow download script to run without any restrictions or warnings:
Set-ExecutionPolicy Bypass -Scope Process

cd /path/to/ARSDK/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>

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

========================================
AR SDK Feature Installation Script
========================================

Usage: .\install_feature.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: 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
  -help                 : Show this help message

Examples:
  # Install single feature (auto-detect GPU and latest compatible version):
  .\install_feature.ps1 -features nvargazeredirection

  # Install single feature with specific GPU:
  .\install_feature.ps1 -gpu 89 -features nvargazeredirection

  # Install single feature with specific version:
  .\install_feature.ps1 -features nvargazeredirection -version 1.1.0.0

  # Install multiple features (comma-separated):
  .\install_feature.ps1 -gpu 89 -features nvargazeredirection,nvarlipsync,nvarbodydetection

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

Example AR SDK features (non-exhaustive, case-insensitive):
  * nvarbodyposeestimation  - Body pose estimation
  * nvarbodydetection       - Body detection
  * nvarlandmarkdetection   - Face landmark Detection
  * nvargazeredirection     - Eye contact/gaze redirection
  * nvarlipsync             - Lip synchronization
  * nvarfaceexpressions     - Face expression estimation

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.