# axelera-ai-hub/voyager-sdk architecture

> Architecture diagram of the GitHub repository axelera-ai-hub/voyager-sdk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/axelera-ai-hub/voyager-sdk
- Repository: https://github.com/axelera-ai-hub/voyager-sdk

## Overview

Voyager SDK is an edge-inference SDK for deploying models to Axelera Metis devices and running them in application pipelines. The main user journey is model deployment, then configuring and executing an inference pipeline that accepts frames and produces model metadata/results. The repository also exposes Python pipeline composition, evaluation, display, and lower-level C++/GStreamer integration. The graph combines README-described capabilities with relationships supported by the supplied source index; unsampled implementation details are not treated as inspected.

Main entry points: [`axelera/app/network.py`](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/network.py) (Network builder), [`axelera/app/pipe/manager.py`](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipe/manager.py) (Pipe manager), [`axelera/app/pipeline.py`](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipeline.py) (Pipeline translator), [`deploy.py`](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/deploy.py) (Deploy CLI)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_deploy["Model deployment"]
  node_deploy_cli["Deploy CLI<br/>[deploy.py]"]
  node_compiler["Model compiler<br/>[compile.py]"]
end

subgraph group_runtime["Pipeline runtime"]
  node_configuration["SDK configuration<br/>[config.py]"]
  node_network["Network builder<br/>[network.py]"]
  node_pipeline["Pipeline translator<br/>[pipeline.py]"]
  node_pipe_manager["Pipe manager<br/>[manager.py]"]
  node_torch_pipe["Torch pipeline<br/>[torch.py]"]
  node_device_manager["Device manager<br/>[device_manager.py]"]
end

subgraph group_operators["Inference operators"]
  node_inference_ops["Inference operators<br/>[inference.py]"]
  node_custom_preprocess["Custom preprocessing"]
  node_tracker["Multi-object tracking<br/>[TrackerFactory.cpp]"]
end

subgraph group_streaming["Streaming APIs"]
  node_inference_stream["InferenceStream API<br/>[inf_tracers.py]"]
  node_ax_inference_net["AxInferenceNet<br/>[AxInferenceNet.cpp]"]
  node_gst_plugins["GStreamer plugins<br/>[GstAxPlugins.cpp]"]
end

subgraph group_support["Data and results"]
  node_dataset_adapters["Dataset adapters<br/>[objdataadapter.py]"]
  node_evaluation["Evaluation<br/>[obj_eval.py]"]
  node_metadata["Inference metadata"]
  node_display["Result display<br/>[display.py]"]
end

node_engineer(("Application developer"))

node_engineer -->|"deploys model"| node_deploy_cli
node_deploy_cli -.->|"requests compilation"| node_compiler
node_engineer -->|"configures pipeline"| node_pipeline
node_pipeline -->|"reads settings"| node_configuration
node_network -->|"invokes compilation"| node_compiler
node_network -->|"uses operators"| node_inference_ops
node_network -->|"builds pipeline"| node_pipeline
node_pipe_manager -->|"loads network"| node_network
node_pipe_manager -->|"selects device"| node_device_manager
node_pipe_manager -->|"configures tracing"| node_inference_stream
node_torch_pipe -->|"creates metadata"| node_metadata
node_inference_ops -->|"uses preprocessing"| node_custom_preprocess
node_dataset_adapters -->|"supplies evaluation data"| node_evaluation
node_inference_stream -->|"renders results"| node_display
node_engineer -->|"integrates inference"| node_ax_inference_net
node_engineer -->|"integrates streaming"| node_gst_plugins
node_ax_inference_net -->|"transfers metadata"| node_metadata
node_engineer -->|"selects tracker"| node_tracker

click node_deploy_cli "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/deploy.py"
click node_compiler "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/compile.py"
click node_configuration "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/config.py"
click node_network "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/network.py"
click node_pipeline "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipeline.py"
click node_pipe_manager "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipe/manager.py"
click node_torch_pipe "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipe/torch.py"
click node_device_manager "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/device_manager.py"
click node_inference_ops "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/operators/inference.py"
click node_custom_preprocess "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/operators/custom_preprocessing.py"
click node_dataset_adapters "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/ax_datasets/objdataadapter.py"
click node_evaluation "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/ax_evaluators/obj_eval.py"
click node_metadata "https://github.com/axelera-ai-hub/voyager-sdk/tree/latest/axelera/app/meta"
click node_display "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/display.py"
click node_inference_stream "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/inf_tracers.py"
click node_ax_inference_net "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/operators/axstreamer/src/AxInferenceNet.cpp"
click node_gst_plugins "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/operators/gstaxstreamer/src/GstAxPlugins.cpp"
click node_tracker "https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/trackers/src/TrackerFactory.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_deploy_cli,node_compiler toneBlue
class node_configuration,node_network,node_pipeline,node_pipe_manager,node_torch_pipe,node_device_manager toneAmber
class node_inference_ops,node_custom_preprocess,node_tracker toneMint
class node_inference_stream,node_ax_inference_net,node_gst_plugins toneRose
class node_dataset_adapters,node_evaluation,node_metadata,node_display,node_engineer toneIndigo
```

## Components

### Model deployment

- [Deploy CLI](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/deploy.py): `deploy.py`
- [Model compiler](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/compile.py): `axelera/app/compile.py`

### Pipeline runtime

- [SDK configuration](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/config.py): `axelera/app/config.py`
- [Network builder](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/network.py): `axelera/app/network.py`
- [Pipeline translator](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipeline.py): `axelera/app/pipeline.py`
- [Pipe manager](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipe/manager.py): `axelera/app/pipe/manager.py`
- [Torch pipeline](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/pipe/torch.py): `axelera/app/pipe/torch.py`
- [Device manager](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/device_manager.py): `axelera/app/device_manager.py`

### Inference operators

- [Inference operators](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/operators/inference.py): `axelera/app/operators/inference.py`
- [Custom preprocessing](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/operators/custom_preprocessing.py): `axelera/app/operators/custom_preprocessing.py`
- [Multi-object tracking](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/trackers/src/TrackerFactory.cpp): `trackers/src/TrackerFactory.cpp`

### Streaming APIs

- [InferenceStream API](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/inf_tracers.py): `axelera/app/inf_tracers.py`
- [AxInferenceNet](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/operators/axstreamer/src/AxInferenceNet.cpp): `operators/axstreamer/src/AxInferenceNet.cpp`
- [GStreamer plugins](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/operators/gstaxstreamer/src/GstAxPlugins.cpp): `operators/gstaxstreamer/src/GstAxPlugins.cpp`

### Data and results

- [Dataset adapters](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/ax_datasets/objdataadapter.py): `ax_datasets/objdataadapter.py`
- [Evaluation](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/ax_evaluators/obj_eval.py): `ax_evaluators/obj_eval.py`
- [Inference metadata](https://github.com/axelera-ai-hub/voyager-sdk/tree/latest/axelera/app/meta): `axelera/app/meta`
- [Result display](https://github.com/axelera-ai-hub/voyager-sdk/blob/latest/axelera/app/display.py): `axelera/app/display.py`

### Other components

- **Application developer**

## Connections

- Application developer → Deploy CLI: deploys model (evidence: `README.md`)
- Deploy CLI → Model compiler: requests compilation
- Application developer → Pipeline translator: configures pipeline (evidence: `README.md`)
- Pipeline translator → SDK configuration: reads settings (evidence: `axelera/app/pipeline.py`)
- Network builder → Model compiler: invokes compilation (evidence: `axelera/app/network.py`)
- Network builder → Inference operators: uses operators (evidence: `axelera/app/network.py`)
- Network builder → Pipeline translator: builds pipeline (evidence: `axelera/app/network.py`)
- Pipe manager → Network builder: loads network (evidence: `axelera/app/pipe/manager.py`)
- Pipe manager → Device manager: selects device (evidence: `axelera/app/pipe/manager.py`)
- Pipe manager → InferenceStream API: configures tracing (evidence: `axelera/app/pipe/manager.py`)
- Torch pipeline → Inference metadata: creates metadata (evidence: `axelera/app/pipe/torch.py`)
- Inference operators → Custom preprocessing: uses preprocessing (evidence: `axelera/app/operators/inference.py`)
- Dataset adapters → Evaluation: supplies evaluation data (evidence: `ax_datasets/objdataadapter.py`)
- InferenceStream API → Result display: renders results (evidence: `axelera/app/inf_tracers.py`)
- Application developer → AxInferenceNet: integrates inference (evidence: `README.md`)
- Application developer → GStreamer plugins: integrates streaming (evidence: `README.md`)
- AxInferenceNet → Inference metadata: transfers metadata (evidence: `operators/axstreamer/src/AxInferenceNet.cpp`)
- Application developer → Multi-object tracking: selects tracker (evidence: `README.md`)
