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.
- Getting Started
- Obtaining the Holoscan SDK
- Roadmap
- AI Coding Assistants
- Troubleshooting and Feedback
- Contributing to Holoscan SDK
- Repository structure
- License
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:
- An introduction to the NVIDIA Holoscan platform, including the Holoscan C++/Python SDK;
- Requirements and setup steps;
- Detailed SDK documentation, including a developer introduction, examples, and API details.
We also recommend visiting NVIDIA HoloHub to view community projects and reusable components available for your Holoscan project.
The Holoscan User Guide documents several options to install and run the Holoscan SDK:
- As an NGC Container 🐋
- As a Debian Package 📦️
- As a Python Wheel 🐍
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.
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.
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/skillsCheck 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.
We appreciate community discussion and feedback in support of Holoscan platform users and developers. We ask that users:
- Review the Holoscan SDK Frequently Asked Questions document for common solutions and workarounds.
- Direct questions to the NVIDIA Support Forum.
- Enter SDK issues on the SDK GitHub Issues board.
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.
The repository is organized as such:
benchmark/: SDK performance coverageci/: ABI export-macro allowlists and related CI artifactscmake/: CMake configuration filesdata/: created during the build when dataset download is enableddocs/: user-guide MDX sources and imagesexamples/: source code for the examplesinclude/: source code for the holoscan SDK coremodules/: source code for optional SDK modules, including Inference, Vision, and Visualizationpython/: python bindings for the holoscan SDKschemas/: FlatBuffers schema definitionsscripts/: utility scriptsskills/: agent-readable skills for installing and using the SDK from an AI coding assistantsrc/: source code for the holoscan SDK coretests/: tests for the holoscan SDK
Holoscan SDK is licensed under the Apache License, Version 2.0. Third-party notices are listed in NOTICE.txt.