Scope and Release Coverage
🚧 Documentation is under development
The Holoscan SDK guide is currently under active development. Some sections may be incomplete or change without notice.
Questions? Contact RidgeRun or email to support@ridgerun.com.
-
Overview
-
Build, Run, and Validate
-
Core Concepts
-
Operators and Graphs
-
Tensor Data and Memory
-
Interprocess Communication
-
-
Application and Operator Development
- Building an HSDK Application
- Writing a Minimal Operator
- Typed Parameters and Configuration
- Reading, Writing, and Forwarding Data
- Writing Tensor Operators
- Complete Operator Patterns
- Authoring Runtime Behavior
- Runtime Parameter Updates
- Lifecycle Callbacks and Restart Control
- Performance and Debugging
- SDK Source Map
-
Operator Reference
-
Core Operators
-
Holoscan Camera
-
Holoscan RidgeRun
- Overview
- Build and Installation
- ArgusCameraOp
- V4L2SourceOp
- V4L2UserPtrSourceOp
- BgraToPlanarTensorOp
- RawBayerToBgraOp
- RawBayerToYoloTensorOp
- YuyvToBgraOp
- TensorRtInferenceOp
- DrmDisplayOp
- DrmBgraDisplayOp
- X11DisplayOp
- CudaCompositorOp
- DepthColorizerOp
- FakesinkOp
- FrameSkipperOp
- InterprocessSrcOp
- TestPatternOp
-
-
Migration from Holoscan 4.x
-
Examples
-
Core
-
Holoscan Camera
-
Holoscan RidgeRun
-
-
Benchmark and Use Cases
-
Holoscan vs GStreamer
- Overview
-
Capture and Display
-
Capture and Inference
- Compare the workloads
- Implemented Applications
- Framework Selection
- Interprocess
-
Scope and Release Coverage
HSDK applications can turn camera, sensor, network, or generated data into a running pipeline. This guide focuses on the decisions that shape an application: how work is connected, how data is represented, how samples are selected, how a graph is built and run, and how a result reaches a display, another process, or a control path.
The guide uses the C++ application model as its main thread. It covers image processing, inference, visualization, multisensor fusion, control-oriented results, Tensor data, structured schemas, run control, and process boundaries. The examples use synthetic data when that keeps the idea independent from a particular device; camera pages explain the additional steps when physical acquisition matters.
RidgeRun works with your team on camera integration, application development and performance optimization. Contact RidgeRun to see how we can help with your project, or visit How Can RidgeRun Help? for examples of the work we can do together.
Choose a Starting Point
Use the route that matches what you need to do next:
| If you need to... | Start with |
|---|---|
| Understand what Holoscan is useful for and how the pieces fit together | Holoscan SDK at a Glance |
| Understand the path from an application description to execution | Architecture and Execution Model |
| Install the SDK and run a complete example | Build, Run, and Validate |
| Learn the vocabulary used by every application | Operators and Graphs and Tensor Contracts and Memory Types |
| Write an operator or assemble a custom application | Application, Graph, and Operator Anatomy |
| Select a ready-made processing or camera stage | Core operator reference or Holoscan Camera |
| Adapt an existing application | Migration Concept Map |
Follow the Learning Flow
The pages follow one path through the application-development process:
- Overview explains the outcomes, the graph mental model, and the compose–compile–run path.
- Build, Run, and Validate gets one example running and separates setup problems from application problems.
- Core Concepts defines graphs, operators, ports, samples, payloads, timing, Tensor data, memory, and process boundaries.
- User Guides show how to write applications and operators using that vocabulary.
- Operator Reference and Examples help you choose a ready-made stage or adapt a complete workflow.
Official Documentation and Supporting References
The official NVIDIA Holoscan SDK documentation remains the authoritative source for the complete installation matrix, API reference, and broader platform coverage. Use the official Getting Started sequence when you want NVIDIA's installation-to-first-application route, or when a platform requirement must be verified against the current documentation.
The SDK Source Map and Current Rules page provides traceability into the implementation.
Continue
Continue with Holoscan SDK at a Glance to see the user-facing pipeline model. Then follow Build, Run, and Validate and Run SDK Examples to build the SDK and run the first complete example.