Skip to navigation

Air SDK

View as Markdown

This project provides a Python SDK for interacting with the NVIDIA Air API.

Prerequisite

The SDK requires Python 3.10. There are a number of ways to achieve this such as poetry, uv or virtualenv. The following shows how to achieve this on a few popular OS’s using virtualenv.

# Install Python 3.10
brew install python@3.10  # MacOS
apt-get install python3.10  # Ubuntu/Debian
sudo pacman -S python310  # Arch
# Install, create and activate a Python 3.10 virtual environment
python3.10 -m pip install virtualenv
python3.10 -m virtualenv venv
. venv/bin/activate

Installation

The package is available on PyPI.

pip install nv-air-sdk==1.0.0

Authentication Options

  1. NGC Device Login with AirApi.with_device_login(email=<YOUR_EMAIL>, org_num=<YOUR_NGC_ORG_NUMBER>)
  2. NGC CLI Login with AirApi.with_ngc_config() (or just AirApi())
  3. Explicitly specify an NGC API Key (also known as a Scoped API Key, or “SAK”) by instantiating AirApi.with_api_key(api_key=<YOUR_NGC_API_KEY>)

To use option 2 you will need to have the NGC CLI installed and to have configured it with ngc config set. This will create a file at ~/.ngc/config which contains your NGC credentials that will be auto-detected by the Air SDK.

We do not support NGC service keys yet.

Examples

Examples overview

API Reference

air_sdk API reference