NVIDIA GPU Cloud Documentation

NGC Documentation

• 1. NGC User Guide
  • 1.1. What is NVIDIA NGC?
  • 1.2. Why NGC Software
  • 1.3. NGC Organizations and Teams
    • 1.3.1. NVIDIA Cloud Accounts and NGC
    • 1.3.2. NGC Teams
    • 1.3.3. NGC Org Owner and Other Org Users
      • 1.3.3.1. Adding NGC Users to an Org
      • 1.3.3.2. Updating User Roles
      • 1.3.3.3. Removing a User from an NGC Org
      • 1.3.3.4. Securing the Owner Account with Multi-Factor Authentication
      • 1.3.3.5. Contacting your Org Owner
      • 1.3.3.6. External User Groups
        • 1.3.3.6.1. External User Groups: Quick Reference
        • 1.3.3.6.2. Creating a Managed External User Group
        • 1.3.3.6.3. Inviting Users to an External User Group
          • 1.3.3.6.3.1. Part 1: Inviting Users to an External User Group
          • 1.3.3.6.3.2. Part 2: Management UI and Invitation Redirection
          • 1.3.3.6.3.3. Part 3: Invitation templates (for UCS Team invites)
          • 1.3.3.6.3.4. Part 4: Monitor and Resend
        • 1.3.3.6.4. Managing External Users’ Personal API Keys
        • 1.3.3.6.5. Guide for External Users: Accepting Invitations for Group Members
        • 1.3.3.6.6. Guide for External Users: Accepting Invitations for Group Admins or Operators
        • 1.3.3.6.7. Setting Up API Access
    • 1.3.4. Transferring Your Product Activation Invitation
  • 1.4. Accessing NGC Org
    • 1.4.1. Activating Your NGC Product from an NGC Email Invitation
      • 1.4.1.1. NGC Product Activation by Invitation - New User
      • 1.4.1.2. NGC Product Activation by Invitation - Existing User
    • 1.4.2. Activating NGC Product from an NVIDIA Commercial Entitlement Certificate
    • 1.4.3. Signing Up for a Free Individual NGC Org
    • 1.4.4. Setting up your NCA Account
      • 1.4.4.1. Setting Up NCA Recovery Email
    • 1.4.5. Accepting an NCA Invitation to Access NGC
  • 1.5. Using an External SSO for Enterprise Platform Authentication
    • 1.5.1. Federating IdP with NVIDIA Cloud Services
    • 1.5.2. Authenticating and Managing User Access
    • 1.5.3. NGC IdP Membership Rules
      • 1.5.3.1. Example
      • 1.5.3.2. Configuring NGC
  • 1.6. Activating Your Subscription (Offer Dependent)
  • 1.7. Switching Orgs or Teams After Logging into NGC
  • 1.8. NGC API Keys
    • 1.8.1. Supported NGC Applications and API Key Types
    • 1.8.2. Generating NGC API Keys
      • 1.8.2.1. Generating a Personal API Key
        • 1.8.2.1.1. Assigning Services to Your Personal API Key
        • 1.8.2.1.2. Generating a Legacy NGC API Key
      • 1.8.2.2. Generating a Service API Key
        • 1.8.2.2.1. Configuring Access to NGC Catalog Artifacts
          • 1.8.2.2.1.1. Setting the Path for Specific Artifacts
          • 1.8.2.2.1.2. Comprehensive Access Configuration
        • 1.8.2.2.2. Managing Service API Keys
        • 1.8.2.2.3. Least-Privilege Service Key Recipes
  • 1.9. Secure Sharing Service
    • 1.9.1. Securely Sharing Secrets
    • 1.9.2. Receiving a Secure Share Link
    • 1.9.3. Finding your Organization Name
  • 1.10. Notification Services
  • 1.11. Appendix
    • 1.11.1. NVIDIA NGC Network Protocols
• 2. NGC Catalog User Guide
  • 2.1. What is the NGC Catalog?
  • 2.2. Terms and Concepts
  • 2.3. Why NGC Software
  • 2.4. Accessing NGC Software
  • 2.5. Registering and Activating a New NGC Org to Obtain Authenticated Access
    • 2.5.1. Signing Up for an NVIDIA Cloud Account and Activating an Individual NGC Org
    • 2.5.2. NGC API Keys
      • 2.5.2.1. Supported NGC Applications and API Key Types
      • 2.5.2.2. Generating NGC API Keys
        • 2.5.2.2.1. Generating a Personal API Key
          • 2.5.2.2.1.1. Assigning Services to Your Personal API Key
          • 2.5.2.2.1.2. Generating a Legacy NGC API Key
        • 2.5.2.2.2. Generating a Service API Key
  • 2.6. Introduction to the NGC Catalog and NGC CLIs
    • 2.6.1. Installing NGC Catalog CLI
    • 2.6.2. Installing NGC Registry CLI
  • 2.7. Software Releases
    • 2.7.1. Overview
      • 2.7.1.1. Software Release Labels
    • 2.7.2. Release Types
      • 2.7.2.1. What Are Release Types?
      • 2.7.2.2. Key Principles
      • 2.7.2.3. Release Type Definitions
      • 2.7.2.4. Enterprise Policies for Release Types
      • 2.7.2.5. How to find Enterprise Products in NGC Catalog
      • 2.7.2.6. Enterprise Lifecycle Policies
    • 2.7.3. Using Release Types
      • 2.7.3.1. Release Types in the Catalog
      • 2.7.3.2. UI Features
      • 2.7.3.3. Release Types with NGC CLI and API
      • 2.7.3.4. Example 1: Find Release Types within a given Artifact (CLI)
      • 2.7.3.5. Example 2: Get Release Information Including Release Type (CLI)
      • 2.7.3.6. Example 3: Get Repository Details with Release Types (API)
    • 2.7.4. Frequently Asked Questions
    • 2.7.5. Next Steps
    • 2.7.6. Additional Resources
  • 2.8. Accepting Terms Before Downloading
  • 2.9. Docker Containers
    • 2.9.1. What Is a Docker Container?
    • 2.9.2. Why Use A Container?
    • 2.9.3. Searching and Filtering Containers
      • 2.9.3.1. Government Ready Artifacts
  • 2.10. NGC Container Images in NGC Catalog
    • 2.10.1. Why NGC Container Images?
      • 2.10.1.1. NGC Container Security Policy
      • 2.10.1.2. NVIDIA Security Risk Scale
      • 2.10.1.3. GPU-performance Tests for NGC Catalog Container Images
        • 2.10.1.3.1. NVIDIA Container Toolkit
    • 2.10.2. NVIDIA CUDA Toolkit
    • 2.10.3. Running Singularity Containers
      • 2.10.3.1. Prerequisites
      • 2.10.3.2. Converting to Singularity Image
      • 2.10.3.3. Running the Singularity Container
        • 2.10.3.3.1. Directory Access
        • 2.10.3.3.2. Command Line Execution with Singularity
        • 2.10.3.3.3. Interactive Shell with Singularity
  • 2.11. Prerequisites for Using NGC Catalog Container Images
    • 2.11.1. Prerequisites for Using NGC Containers on DGX Systems
    • 2.11.2. Prerequisites for Using NGC Containers on Cloud Platforms
    • 2.11.3. Prerequisites for Using NGC Containers on Other NVIDIA GPUs
    • 2.11.4. HPC Visualization Containers
      • 2.11.4.1. Prerequisites For HPC Visualization Containers
      • 2.11.4.2. Installing NVIDIA Docker 2.0
      • 2.11.4.3. ParaView With NVIDIA Holodeck
      • 2.11.4.4. ParaView With NVIDIA IndeX
        • 2.11.4.4.1. Single-Machine With GLX
        • 2.11.4.4.2. Server Container With EGL
        • 2.11.4.4.3. GLX Client Connecting To A Server
      • 2.11.4.5. ParaView With NVIDIA OptiX
        • 2.11.4.5.1. Single-Machine Container With GLX
        • 2.11.4.5.2. Server Container With EGL
        • 2.11.4.5.3. Running The GLX Client And Attaching To The Server
        • 2.11.4.5.4. Optional: Using The ParaView .config File
  • 2.12. Pulling NGC Containers from NGC Catalog
    • 2.12.1. Key NGC Container Registry Terminology
    • 2.12.2. Accessing and Pulling an NGC Container Image via the Docker CLI
      • 2.12.2.1. Logging in to the NGC Container Registry
      • 2.12.2.2. Pulling a Container from NGC Container Registry Using Docker CLI
    • 2.12.3. Accessing and Pulling an NGC Catalog Container Using NGC CLI
      • 2.12.3.1. Viewing Container Image Information
      • 2.12.3.2. Pulling a Container Image
    • 2.12.4. Retrieving VEX, SBOM, and Vulnerability Scan Results
      • 2.12.4.1. Using the HTTP API
        • 2.12.4.1.1. Retrieve VEX Document
        • 2.12.4.1.2. Retrieve SBOM Document
        • 2.12.4.1.3. Retrieve Vulnerability Scan Results
      • 2.12.4.2. Using the ORAS CLI
        • 2.12.4.2.1. Retrieve VEX Document
        • 2.12.4.2.2. Retrieve SBOM Document
  • 2.13. NGC Container Image Versions
  • 2.14. NVIDIA Signed Container Images in NGC Catalog
    • 2.14.1. Checking for Signed Container Images
      • 2.14.1.1. Using the NGC Catalog UI
      • 2.14.1.2. Using the NGC CLI
    • 2.14.2. Finding NVIDIA’s Public Key
      • 2.14.2.1. Using the NGC Catalog UI
      • 2.14.2.2. Using the NGC CLI
    • 2.14.3. Verifying NVIDIA’s Signature
      • 2.14.3.1. Using Cosign
      • 2.14.3.2. Using an Admission Controller in Kubernetes Clusters
  • 2.15. Running an NGC Container
    • 2.15.1. Enabling GPU Support for NGC Containers
    • 2.15.2. Running NGC Containers with Runtime Resources
      • 2.15.2.1. Specifying A User
      • 2.15.2.2. Setting The Remove Flag
      • 2.15.2.3. Setting The Interactive Flag
      • 2.15.2.4. Setting The Volumes Flag
      • 2.15.2.5. Setting The Mapping Ports Flag
      • 2.15.2.6. Setting The Shared Memory Flag
      • 2.15.2.7. Setting The Restricting Exposure Of GPUs Flag
      • 2.15.2.8. Container Lifetime
  • 2.16. Multi-Architecture Support for NGC Container Images
    • 2.16.1. Manifest Lists and Tags
    • 2.16.2. Basic Docker Commands for Multi-Architecture Images
  • 2.17. Customizing Containers
    • 2.17.1. Benefits and Limitations to Customizing a Container
    • 2.17.2. Example 1: Building a Container from Scratch
    • 2.17.3. Example 2: Customizing A Container Using Dockerfile
    • 2.17.4. Example 3: Customizing a Container Using docker commit
    • 2.17.5. Example 4: Developing a Container Using Docker
    • 2.17.6. Example 4.1: Package The Source into the Container
  • 2.18. Models
    • 2.18.1. What are Models
    • 2.18.2. Searching and Filtering Models
    • 2.18.3. Downloading Models via NGC CLI
    • 2.18.4. Downloading Models via WGET/cURL
      • 2.18.4.1. Downloading Guest Access Models via WGET/cURL
      • 2.18.4.2. Downloading Authenticated Access Models via WGET/cURL
    • 2.18.5. Downloading Models via Web UI
      • 2.18.5.1. Downloading the Latest Version of a Model
      • 2.18.5.2. Downloading a Specific Version of a Model
    • 2.18.6. NVIDIA Signed Models in the NGC Catalog
      • 2.18.6.1. Checking for Signed Models
      • 2.18.6.2. Using the NGC Catalog UI
      • 2.18.6.3. Using the NGC CLI
      • 2.18.6.4. Finding NVIDIA’s Root Certificate
      • 2.18.6.5. Verifying Model Signature
        • 2.18.6.5.1. Download Verification Tools
        • 2.18.6.5.2. Downloading Model Version and Signature
        • 2.18.6.5.3. Verifying Model Version Signature
  • 2.19. Resources
    • 2.19.1. What are Resources?
    • 2.19.2. Searching and Filtering Resources
    • 2.19.3. Downloading Resources via the NGC CLI
    • 2.19.4. Downloading Resources via WGET/cURL
      • 2.19.4.1. Downloading Guest Access Resources via WGET/cURL
      • 2.19.4.2. Downloading Authenticated Access Resources via WGET/cURL
    • 2.19.5. Downloading Resources via Web UI
    • 2.19.6. Verifying Resource Signature
      • 2.19.6.1. Download Verification Tools
      • 2.19.6.2. Downloading Resource Version and Signature
      • 2.19.6.3. Verifying Resource Version Signature
  • 2.20. Helm Charts
    • 2.20.1. Prerequisites
      • 2.20.1.1. Setting Up an NGC Helm Repository
    • 2.20.2. Searching for Available Helm Charts in the NGC Catalog
    • 2.20.3. Fetching Helm Charts
    • 2.20.4. Using the NGC Website to View the List of Helm Charts and Get Fetch Commands
  • 2.21. Collections
    • 2.21.1. What is an NGC Collection?
    • 2.21.2. Navigating NGC Collections
    • 2.21.3. Filtering NGC Collections
    • 2.21.4. Collections Page Overview
    • 2.21.5. Building with NGC Collections
      • 2.21.5.1. Example Use Case: Building an Intelligent Video Analytics (IVA) Application
    • 2.21.6. Using NGC Collections CLI
  • 2.22. SDK and AI Toolkits
  • 2.23. Deep Learning Frameworks
    • 2.23.1. GPU Operator
• 3. NGC Private Registry User Guide
  • 3.1. NGC Private Registry For Enterprise
    • 3.1.1. Increased Collaboration
    • 3.1.2. Enterprise Ready
  • 3.2. Getting Started
    • 3.2.1. Obtaining a Private Registry
    • 3.2.2. Activating a New NGC Account
      • 3.2.2.1. Joining an NGC Org or Team With an Existing NVIDIA Account
      • 3.2.2.2. Joining an Org or Team With a New NVIDIA Account
      • 3.2.2.3. Joining an Org as Org Owner
      • 3.2.2.4. Joining an Org or Team With an External SSO Company Account
      • 3.2.2.5. Switching Orgs or Teams After Logging into NGC
    • 3.2.3. NGC API Keys
      • 3.2.3.1. Supported NGC Applications and API Key Types
      • 3.2.3.2. Generating NGC API Keys
        • 3.2.3.2.1. Generating a Personal API Key
          • 3.2.3.2.1.1. Assigning Services to Your Personal API Key
          • 3.2.3.2.1.2. Generating a Legacy NGC API Key
        • 3.2.3.2.2. Generating a Service API Key
    • 3.2.4. Managing Users and Teams in NGC
      • 3.2.4.1. NGC Registry User Roles
      • 3.2.4.2. Creating Teams
      • 3.2.4.3. Creating Users
      • 3.2.4.4. Adding a New User to a Team
      • 3.2.4.5. Adding an Existing User to a Team
      • 3.2.4.6. Changing User Roles
    • 3.2.5. Introduction to the NGC Catalog and NGC CLIs
      • 3.2.5.1. Installing NGC Registry CLI
      • 3.2.5.2. Managing Users and Teams
        • 3.2.5.2.1. Inviting users to the organization’s NGC account
        • 3.2.5.2.2. Creating teams
        • 3.2.5.2.3. Adding users to teams
        • 3.2.5.2.4. Creating a team and adding a user in the same command
          • 3.2.5.2.4.1. User Roles and Permissions
  • 3.3. Docker Containers
    • 3.3.1. What Is A Docker Container?
    • 3.3.2. Why Use A Container?
    • 3.3.3. Using NGC Container Registry from the Docker Command Line
      • 3.3.3.1. Accessing the NGC Container Registry
      • 3.3.3.2. Uploading an NVIDIA Container Image onto Your System
      • 3.3.3.3. Tagging and Pushing a Container Image
    • 3.3.4. Using the Container Registry
      • 3.3.4.1. Viewing Container Image Information
      • 3.3.4.2. Pulling a Container Image
      • 3.3.4.3. Pushing a Container Image
      • 3.3.4.4. Removing a Container Image
    • 3.3.5. Updating Container Metadata
      • 3.3.5.1. Updating Container Metadata Via the NGC Website
      • 3.3.5.2. Updating Container Metadata Using the NGC CLI
    • 3.3.6. Multi-Architecture Support for NGC Container Images
  • 3.4. NGC Models
    • 3.4.1. Creating New NGC Models Using the NGC CLI
    • 3.4.2. Creating a New Model Using the NGC Website
    • 3.4.3. Uploading a New NGC Model Version Using the NGC CLI
    • 3.4.4. Uploading an NGC Model Version Using the NGC Website
    • 3.4.5. Editing NGC Model Information Using the NGC CLI
    • 3.4.6. Editing NGC Model Information Using the NGC Website
    • 3.4.7. Cloning NGC Model Version Using the NGC Website
    • 3.4.8. Creating a New NGC Model Version Using the NGC CLI
    • 3.4.9. Customer Managed Keys
      • 3.4.9.1. Using Customer Managed Keys via the NGC CLI
        • 3.4.9.1.1. Managing Encryption Keys
          • 3.4.9.1.1.1. Create a New Encryption Key
          • 3.4.9.1.1.2. Link an Existing Encryption Key
          • 3.4.9.1.1.3. List Encryption Keys
        • 3.4.9.1.2. Using Encryption Keys with Models
          • 3.4.9.1.2.1. View Key and Associated Models
          • 3.4.9.1.2.2. View Associated Key for a Model
        • 3.4.9.1.3. Revoking Access to Models
          • 3.4.9.1.3.1. Disassociate Key from Model
          • 3.4.9.1.3.2. Delete an Encryption Key
          • 3.4.9.1.3.3. Check Operation Status
      • 3.4.9.2. Using Customer Managed Keys via the Private Registry UI
        • 3.4.9.2.1. Creating an Encryption Key
        • 3.4.9.2.2. Unlinking the Encryption Key
          • 3.4.9.2.2.1. Unlink a Key from a Model (Model Details Page)
          • 3.4.9.2.2.2. Unlink a Key from a Model (Encryption Key List)
        • 3.4.9.2.3. Revoking the Encryption Key
  • 3.5. NGC Resources
    • 3.5.1. Before You Begin
    • 3.5.2. Uploading a Resource
    • 3.5.3. Updating a Resource
    • 3.5.4. Resource Commands
    • 3.5.5. Deleting a Resource
  • 3.6. NGC Helm Charts
    • 3.6.1. Introduction to NGC and Helm Charts
    • 3.6.2. Creating and Packaging a Helm Chart
    • 3.6.3. Manage Helm Charts Using the NGC Web UI
      • 3.6.3.1. Viewing the List of Helm Charts and Getting Fetch Commands
      • 3.6.3.2. Adding Helm Charts Using the NGC Web UI
      • 3.6.3.3. Updating the Helm Chart Page From the Website
      • 3.6.3.4. Removing Helm Charts from the Web UI
    • 3.6.4. Manage Helm Charts Using the NGC CLI
      • 3.6.4.1. Searching for Available Helm Charts in an Org
      • 3.6.4.2. Fetching Helm Charts
      • 3.6.4.3. Adding Helm Charts to a Private Registry
      • 3.6.4.4. Getting Information about a Helm Chart
      • 3.6.4.5. Pushing a Helm Chart
      • 3.6.4.6. Listing Helm Chart Versions
      • 3.6.4.7. Removing Helm Charts from a Private Registry
    • 3.6.5. Manage Helm Charts Using the NGC API
      • 3.6.5.1. Updating Information on the Helm Chart Page
      • 3.6.5.2. Deleting Helm Charts Using the NGC API
    • 3.6.6. Manage Helm Charts Using the Helm CLI
      • 3.6.6.1. Setting Up an NGC Helm Repository
      • 3.6.6.2. Searching for Available Helm Charts
      • 3.6.6.3. Fetching Helm Charts
      • 3.6.6.4. Adding Helm Charts to a Private NGC Org/Team
      • 3.6.6.5. Removing Helm Charts from a Private NGC Org/Team
  • 3.7. Private Registry Quotas and Limits
  • 3.8. Getting Support for NGC Container Registry
• 4. NGC API Field Value Reference
  • 4.1. productNames
  • 4.2. publishers
  • 4.3. applications
  • 4.4. industries
  • 4.5. technologies
  • 4.6. policies
  • 4.7. labels