Skip to content

NVIDIA/DeepStream

Repository files navigation

DeepStream

NVIDIA DeepStream SDK is a streaming analytics toolkit for AI-based video and image understanding, providing a GStreamer-based framework to build multi-stream, multi-model inference pipelines on NVIDIA GPUs (dGPU and Jetson).

DeepStream pipelines combine hardware-accelerated decoding/encoding, TensorRT inference, object tracking, and message-broker integrations to deliver real-time video analytics across dGPU and Jetson platforms.

Overview

This repository contains the complete source code for DeepStream 9.0.

Components (src/):

Tools (tools/):

AI agent skills (skills/, for Claude Code & compatible coding agents):

Requirements

Before building, ensure the following prerequisites are installed:

SBSA / DGX Spark: no DS deb package exists for this platform — use the NVIDIA SBSA Docker container, which bundles the compute stack and DeepStream. See build/BUILD.md.

Getting Started

# Install Git LFS (required for sample video streams used by some apps)
sudo apt-get install git-lfs

# Clone the repo with submodules
git clone --recurse-submodules https://github.com/NVIDIA/DeepStream.git && cd DeepStream

# Pull LFS-tracked files
git lfs install && git lfs pull

See build/BUILD.md for full build instructions, including system package dependencies (x86, aarch64, SBSA / DGX Spark), build/build.sh usage and environment variables (CUDA_VER, NVDS_VERSION), and build output locations under /opt/nvidia/deepstream/deepstream-9.0/.

Supported Platforms

Platform Architecture Notes
x86 dGPU x86_64 Ubuntu 24.04, CUDA 13.1, TensorRT 10.14.x, driver 590+
Jetson aarch64 JetPack 7.1 GA (CUDA 13.0, TensorRT 10.13.x)
SBSA / DGX Spark aarch64 No DS tar/deb package; build and run inside the NVIDIA SBSA Docker container
# Build. The script prompts for sudo only when installing to system paths.
bash build/build.sh

Usage

After bash build/build.sh, binaries are installed to /opt/nvidia/deepstream/deepstream-9.0/bin/. Run the reference deepstream-app with one of the sample configs:

cd /opt/nvidia/deepstream/deepstream-9.0/samples/configs/deepstream-app
deepstream-app -c source30_1080p_dec_infer-resnet_tiled_display.txt

# After the first install, clear the GStreamer plugin cache if needed:
rm -rf ~/.cache/gstreamer-1.0/

Each app must be run from its source directory so relative config paths resolve correctly. Refer to the README inside each app directory for app-specific run instructions and config options.

Running with Triton Inference Server (Docker)

Optional. Skip this if the bare-metal build above already works for you. Use the Triton container when you need Triton-backed inference, or when you're on SBSA / DGX Spark (where no native DS deb package exists).

NVIDIA publishes a DeepStream Docker image bundled with Triton Inference Server.

# One-time NGC login (get an API key from https://ngc.nvidia.com)
docker login nvcr.io           # username: $oauthtoken,  password: <NGC API key>

# Pull the image (use 9.0-triton-arm-sbsa instead on SBSA / DGX Spark)
docker pull nvcr.io/nvidia/deepstream:9.0-triton-multiarch

# Launch with display (use 'fakesink' in your pipeline for headless)
export DISPLAY=:0 && xhost +
docker run -it --rm --gpus all --network=host \
    -e DISPLAY=$DISPLAY -v /tmp/.X11-unix/:/tmp/.X11-unix \
    nvcr.io/nvidia/deepstream:9.0-triton-multiarch

# Inside the container, run a Triton-backed sample
cd /opt/nvidia/deepstream/deepstream-9.0/samples/configs/deepstream-app-triton
deepstream-app -c source30_1080p_dec_infer-resnet_tiled_display.txt

Prerequisites: Docker (docker-ce), the NVIDIA Container Toolkit, NVIDIA driver 590+, and an NGC API key. Triton sample model repos ship under /opt/nvidia/deepstream/deepstream/samples/triton_model_repo/. For gRPC-backed Triton, use samples/configs/deepstream-app-triton-grpc/ instead.

Documentation

Page Description
Overview & Architecture What DeepStream is, key features, and the GStreamer-based pipeline architecture.
Release Notes What's new in this release, supported platforms, and known issues.
Installation Step-by-step installation of the NVIDIA compute stack and DeepStream SDK on x86 and Jetson.
Docker Containers Available DeepStream NGC container images (incl. Triton variants) and how to pull and run them.
DeepStream Samples Reference walkthroughs of the bundled C/C++ sample applications and what each one demonstrates.
Reference Applications Advanced GitHub-hosted reference apps demonstrating specialized end-to-end pipelines.
TAO Apps DeepStream sample apps integrating TAO-trained models (detection, classification, segmentation, pose, LPR).
DeepStream Plugins Reference for every DeepStream GStreamer plugin — properties, pad caps, and usage.
Service Maker Build DeepStream pipelines declaratively with the C++ / Python Service Maker SDK.
Inference Builder Compose and configure DeepStream inference pipelines visually with the Inference Builder tool.
Auto Magic Calib Automatic camera calibration tool for multi-camera DeepStream deployments.
DeepStream Coding Agent Use the bundled skills/ with Claude Code and other AI coding assistants to generate DeepStream pipelines.

Repository Structure

DeepStream/
├── .claude/                                 # Claude Code project-local config (settings, commands)
├── .github/                                 # GitHub workflows, issue templates, CODEOWNERS
├── build/
│   ├── BUILD.md                             # build instructions
│   └── build.sh                             # top-level build driver
├── example_prompts/                         # example prompts for AI coding agents
├── includes/                                # shared public headers (ds3d, nvdsinferserver, …)
├── scripts/
│   ├── install_opensource_deps.sh           # builds open-source deps (OpenTelemetry, civetweb, …)
│   └── print_env.sh                         # env diagnostic helper for bug reports
├── skills/
│   ├── amc-run-sample-calibration/          # AMC sample-dataset calibration skill
│   ├── amc-run-video-calibration/           # AMC custom-video calibration skill
│   ├── amc-setup-calibration-stack/         # AMC microservice + UI launch skill
│   ├── deepstream-dev/                      # general DS development skill
│   ├── deepstream-generate-pipeline/        # interactive gst-launch pipeline builder
│   ├── deepstream-profile-pipeline/         # Nsight Systems profiling & config derivation
│   ├── deepstream-sop/                      # SOP step-sequence compliance microservice
│   └── deepstream-import-vision-model/      # autonomous vision-model onboarding skill
├── src/
│   ├── apps/                                # sample, reference, and TAO sample applications
│   ├── gst-plugins/                         # GStreamer plugin sources (per-plugin subdirs)
│   ├── gst-utils/                           # GStreamer utility library sources
│   ├── service-maker/                       # Service Maker C++/Python SDK and apps
│   └── utils/                               # utility library sources (per-library subdirs)
└── tools/
    ├── auto-magic-calib/                    # camera auto-calibration tool
    ├── inference_builder/                   # visual inference pipeline builder
    ├── sam2-onnx-tensorrt/                  # SAM2 ONNX-to-TensorRT conversion
    └── yolo_deepstream/                     # YOLO + TensorRT integration

Performance

Summary of benchmarks; for detailed performance numbers and hardware used, refer to the DeepStream Performance Guide.

Releases & Roadmap

Contribution Guidelines

This project is currently not accepting contributions.

Security

  • Vulnerability disclosure: SECURITY.md
  • Do not file public issues for security reports.

Support

Community

Join the DeepStream community to ask questions, share feedback, and report issues.

References

License

This project is licensed under CC-BY-4.0 AND Apache-2.0.

  • SPDX-License-Identifier: CC-BY-4.0 AND Apache-2.0

Third‑Party License/Notice

Refer THIRD_PARTY_LICENSES for all 3rd Party OSS licenses and Notices

About

NVIDIA DeepStream Monorepo: DeepStream SDK and reference apps for building GPU‑accelerated, real-time video and multi‑sensor analytics pipelines with GStreamer, TensorRT, and vision AI models across edge, on‑prem, and cloud deployments.

Topics

Resources

License

Code of conduct

Security policy

Stars

10 stars

Watchers

2 watching

Forks

Packages

 
 
 

Contributors