Parallax
Docs

From install to first detection in an afternoon.

The SDK gives you the same session, camera, graph and event types in Swift, Kotlin, C++ and Python. Start with install, then the fifteen-line quickstart.

Get started

Install

Pick the package for your platform. Every package includes the Runtime, the Depth models and the parallax command-line tool. Nothing is downloaded at run time.

Swift Package Manager

iOS 17, macOS 14, visionOS 1 and later
// Package.swift
.package(url: "https://github.com/parallax-labs/parallax-swift", from: "3.4.0")

Gradle

Android API 29 and later, arm64-v8a
// build.gradle.kts
implementation("ai.parallax:parallax-android:3.4.0")

pip

Python 3.10 and later, macOS arm64 and Linux aarch64 / x86_64
$ pip install parallax-sdk==3.4.0

CMake

C++17, Linux aarch64 for Jetson, Hailo and Ambarella boards
# CMakeLists.txt
find_package(Parallax 3.4 REQUIRED)
target_link_libraries(app PRIVATE Parallax::runtime)
Get started

Quickstart

Open the first camera, run Depth-S with tracking and print every event with its timing. This is the same graph that runs on dock-03.

# quickstart.py
import parallax as px

session = px.Session(device="auto", offline=True)
camera = session.camera(index=0, fps=128)

graph = px.Graph([
    px.models.DepthS(precision="int8"),
    px.models.DepthTrack(max_age_s=2.0),
    px.policy.Zone("bay-2", polygon=[(0.1, 0.6), (0.5, 0.6), (0.5, 1.0), (0.1, 1.0)]),
])

for event in session.watch(camera, graph):
    print(event.kind, event.track_id, f"{event.latency_ms:.1f} ms")
    if event.stale: print("  reused:", event.stale_nodes)

Run it with python quickstart.py. Expect the first event within a second and latency around 7.8 ms on a Hexagon device.

Learn

Concepts

Six ideas cover most of the SDK. They are the same in every language.

Session

The Runtime on one device. It owns the compiled schedule, the camera and the frame budget.

Graph

The models and policies that run on every frame, in order, each with a slice of the budget.

Frame budget

The time each frame has to reach a decision. By default, the camera's frame interval.

Event

What a graph emits: boxes, tracks, keypoints or zone changes, with timing for every node.

Stale results

If a node overruns, its last good result is reused and marked stale, so events are never late.

Traces

A per-frame record of where the budget went. Open them in Studio or export them as benchmarks.

Learn

Platform guides

Each chip family has its own capture path, memory limits and thermal behaviour. These guides cover what changes.

Apple Silicon

Neural Engine scheduling, AVFoundation capture and running in visionOS immersive spaces.

Qualcomm Hexagon

QCS and Snapdragon targets, zero-copy from the Spectra ISP and thermal limits.

NVIDIA Jetson

Splitting a graph across GPU and DLA, and running alongside ROS 2 nodes.

Hailo

Host board setup, PCIe and M.2 modules, and pairing a Hailo-8 with an Arm host.

Ambarella

CVflow targets, on-camera deployment and the CV72S image pipeline.

Fleets

Signing graphs, rolling them out to many devices and reading events from your own systems.

Reference

API reference

The four core types. Signatures are shown in Python; Swift, Kotlin and C++ use the same names in their own casing.

Session(device, offline=True, budget_ms=None)

Opens the Runtime on a device. device is "auto" or a chip id such as "qcs8550". budget_ms defaults to the camera's frame interval.

session.watch(camera, graph) → Iterator[Event]
session.trace(seconds) → Trace
session.close()

session.camera(index | uri, fps=None)

Opens a local sensor by index, or a stream by URI. Capture runs through the image processor with a zero-copy hand-off where the chip allows it.

camera.calibrate(seconds=120) → SensorProfile
camera.fps, camera.resolution, camera.sensor

Graph(nodes, on_overrun="reuse")

An ordered list of models and policies compiled into one schedule. on_overrun is "reuse", "skip" or "degrade", and can be set per node.

graph.compile(target) → Schedule
graph.budget() → dict[node, ms]

Event

One decision from one frame. Carries boxes, tracks, keypoints or zone changes, plus timing for every node and a list of nodes that reused a stale result.

event.kind, event.track_id, event.box, event.zone
event.latency_ms, event.node_ms, event.stale, event.stale_nodes
Help

Support

Stuck on a chip, a camera or a number that does not match ours? Send us a trace from Studio or parallax bench and an engineer will read it.

Ship perception that keeps up with the camera.

Install the SDK, run the quickstart and send us your first trace.