Getting Started with Holoscan

Holoscan v0.6

As described in the Overview, the SDK provides many components and capabilities. The goal of this section is to provide a recommended path to getting started with the SDK.

The Holoscan SDK is optimized and compatible with multiple hardware platforms, including NVIDIA Developer Kits (aarch64) and x86_64 workstations. Learn more on the developer page to help you decide what hardware you should target.

Start with installing the SDK. If you have a need for it, you can go through additional recommended setups to achieve peak performance, or setup additional sensors from NVIDIA’s partners.

  1. Start with the Core Concepts to understand the technical terms used in this guide, and the overall behavior of the framework.

  2. Learn how to use the SDK in one of two ways (or both) based on your preference:

    1. Going through the Holoscan by Example tutorial which will build your knowledge step-by-step by going over concrete minimal examples in the SDK. You can refer to each example source code and run instructions to inspect them and run them as you go.

    2. Going through the condensed documentations that should cover all capabilities of the SDK using minimal mock code snippets, including creating an application, creating a distributed application, and creating operators.

The Holoscan SDK does not only provide a framework to build and run applications, but also a set of reusable operators to facilitate implementing applications for streaming, AI, and other general domains.

The list of existing operators is available here, which points to the C++ or Python API documentation for more details. Specific documentation is available for the visualization (codename: HoloViz) and inference (codename: HoloInfer) operators.

Additionally, HoloHub is a central repository for users and developers to share reusable operators and sample applications with the Holoscan community, extending the capabilities of the SDK:

  • Just like the SDK operators, the HoloHub operators can be used in your own Holoscan applications.

  • The HoloHub sample applications can be used as reference implementations to complete the examples available in the SDK.

Take a glance at HoloHub to find components you might want to leverage in your application, improve upon existing work, or contribute your own additions to the Holoscan platform.

The steps above cover what is required to write your own application and run it. For facilitating packaging and distributing, the Holoscan SDK includes utilities to package and run your Holoscan application in a OCI-compliant container image.

  • Expand your understanding of the framework with details on the logging utility or the data flow tracking benchmarking tool.

  • Learn more details on the configurable components that control the execution of your application, like [Schedulers], [Conditions], and [Resources]. (Advanced) These components are part on the GXF execution backend, hence the Graph Execution Framework section at the bottom of this guide if deep understanding of the application execution is needed.

Previous Relevant Technologies
Next SDK Installation
© Copyright 2022-2023, NVIDIA. Last updated on Feb 9, 2024.