Holoscan SDK

The Holoscan SDK is part of NVIDIA Holoscan, the AI sensor processing platform that combines hardware systems for low-latency sensor and network connectivity, optimized libraries for data processing and AI, and core microservices to run streaming, imaging, and other applications, from embedded to edge to cloud. It can be used to build streaming AI pipelines for a variety of domains, including Medical Devices, High Performance Computing at the Edge, Industrial Inspection and more.

Table of Contents

Getting Started

Start with a prebuilt NGC container, Debian package, or Python wheel, then run a sample application from the user guide. Select the documentation version that matches your installed SDK. For this 5.x development branch, follow the checked-in Getting Started guide.

Building from source is documented in DEVELOP.md. Running the SDK test suite with ./run test requires GPU access through the NVIDIA Container Toolkit.

The Holoscan User Guide includes:

We also recommend visiting NVIDIA HoloHub to view community projects and reusable components available for your Holoscan project.

Obtaining the Holoscan SDK

The Holoscan User Guide documents several options to install and run the Holoscan SDK:

Visit the Holoscan User Guide for guidance to help choose which installation option may be right for your use case.

If the options above do not support your use case, you may prefer to build the SDK from source.

Please review Holoscan SDK prerequisites before getting started.

Roadmap

See ROADMAP.md for how monthly releases are planned, what the 5.x series is aiming at, and where to follow live milestones. Release planning is tracked with GitHub Milestones. Issues labeled needs triage sit outside a milestone and are revisited each month. See the GitHub Releases page for what shipped in recent versions.

AI Coding Assistants

The Holoscan SDK user guide includes AI Coding Assistants guidance for grounding AI coding assistants in the 5.x API, examples, and compile-time diagnostics.

Holoscan also publishes coding-assistant skills in skills/. Install them from the NVIDIA catalog with the skills CLI:

npx skills add nvidia/skills

Check each skill's supported SDK versions before using it with this development branch. See skills/README.md for install options, supported workflows, and contribution limits.

Troubleshooting and Feedback

We appreciate community discussion and feedback in support of Holoscan platform users and developers. We ask that users:

Contributing to Holoscan SDK

Holoscan SDK is developed internally and released as open source software. We welcome community contributions and may include them in Holoscan SDK releases at our discretion. Please refer to the Holoscan SDK Contributing Guide for more information.

Repository structure

The repository is organized as such:

License

Holoscan SDK is licensed under the Apache License, Version 2.0. Third-party notices are listed in NOTICE.txt.