page-type | languages | products | |||||
---|---|---|---|---|---|---|---|
sample |
|
|
This is a sample showing how to do real-time video analytics with NVIDIA Deepstream on a NVIDIA Jetson Nano device connected to Azure via Azure IoT Edge. Deepstream is a highly-optimized video processing pipeline, capable of running deep neural networks. It is a must-have tool whenever you have complex video analytics requirements, whether its real-time or with cascading AI models. IoT Edge gives you the possibility to run this pipeline next to your cameras, where the video data is being generated, thus lowering your bandwitch costs and enabling scenarios with poor internet connectivity or privacy concerns. With this solution, you can transform cameras into sensors to know when there is an available parking spot, a missing product on a retail store shelf, an anomaly on a solar panel, a worker approaching a hazardous zone, etc.
To complete this sample, you need a NVIDIA Jetson Nano device. This device is powerful enough to process 8 video streams at a resolution of 1080p, 30 frames-per-second with a resnet10 model and is compatible with IoT Edge. If you need to process more video streams, the same code works with more powerful NVIDIA Jetson devices like the TX2 or the Xavier, and with server-class appliances that includes NVIDIA T4 or other NVIDIA Tesla GPUs.
Check out this video to see this demo in action and understand how it was built:
- Hardware: You need a NVIDIA Jetson Nano device ideally with a 5V-4A barrel jack power supply like this one, which requires a jumper cable (such as these ones) on pins J48. See the Power Guide section of the Jetson Nano Developer Kit for more details. Alternatively, a 5V-2.5A Micro-USB power supply will work without a jumper cable but may limit the performance of your Deepstream application. In all cases, please make sure to use the default
Max
power source mode (e.g. 10W). To visualize the video feeds, you'll need an HDMI monitor and cable connected to your NVIDIA Jetson Nano.
- Flash your Jetson Nano SD Card: download and flash either this JetPack version 4.5 image. You can use BalenaEtcher tool to flash your SD card. Both of these images are based on Ubuntu 18.04 and already includes NVIDIA drivers version, CUDA and Nvidia-Docker.
Warning
This branch only works with DeepStream 5.1, which requires JetPack 4.5 (= Release 32, Revision 3). To older versions, please look at other branches of this repo. To double check, your JetPack version, you can use the following command:
head -n 1 /etc/nv_tegra_release
- Connect your Jetson Nano to your developer's machine with the USB Headless Mode: we'll do that by plugging a micro-USB cable from your Jetson Nano to your developer's machine and using the USB Headless Mode provided by NVIDIA. With this mode, you do not need to hook up a monitor directly to your Jetson Nano. Instead, plug your Jetson Nano to your computer with a micro-USB cable, boot your Jetson Nano and allow 1 minute for your Jetson Nano to boot. From your computer, follow the instructiosn on NVIDIA's website to connect to your Jetson Nano over the serial port.
-
Connect your Jetson Nano to the internet: Either use an ethernet connection, in which case you can skip this section or connect your device to WiFi using the command line:
To connect your Jetson to a WiFi network from a terminal, follow these steps
-
Re-scan available WiFi networks
sudo nmcli device wifi rescan
-
List available WiFi networks, and find the
ssid_name
of your network.sudo nmcli device wifi list
-
Connect to a selected WiFi network
sudo nmcli device wifi connect <ssid_name> password <password>
-
-
Connect your Jetson Nano to an SSH client: An SSH terminal is often more convenient than a serial terminal. So to make it easier to go through the steps of this sample, it is recommended to open an SSH connection with your favorite SSH Client.
-
Find your IP address using the USB Device Mode terminal
ifconfig
-
Make sure that your laptop is on the same network as your Jetson Nano device and open an SSH connection on your Jetson Device:
ssh your-username@your-ip-address
-
-
Install IoT Edge: See the Azure IoT Edge installation instructions for Ubuntu Server 18.04. Skip the Install Container Runtime section since we will be using nvidia-docker, which is already installed. Connect your device to your IoT Hub using the manual provisioning option. See this quickstart if you don't yet have an Azure IoT Hub.
-
Install VS Code and its the IoT Edge extension on your developer's machine: On your developer's machine, get VS Code and its IoT Edge extension. Configure this extension with your IoT Hub.
-
Install VLC to view RTSP video streams: On your developer's machine, install VLC.
The next sections walks you step-by-step to deploy Deepstream on an IoT Edge device and update its configuration. It explains concepts along the way. If all you want is to see the 8 video streams being processed in parallel, you can jump right to the final demo by directly deploying the deployment manifest in this repo.
We'll start by creating a new IoT Edge solution in VS Code, add the Deepstream module from the marketplace and deploy that to our Jetson Nano.
Note that you could also find Deepstream's module via the Azure Marketplace website here. You'll use VS code here since Deepstream is an SDK and typically needs to be tweaked or connected to custom modules to deliver an end-to-end solution at the edge.
In VS Code, from your development machine:
-
Start by creating a new IoT Edge solution:
- Open the command palette (Ctrl+Shift+P)
- Select
Azure IoT Edge: New IoT Edge Solution
- Select a parent folder
- Give it a name.
- Select
Empty Solution
(if prompted, accept to install iotedgehubdev)
-
Add the Deepstream module to your solution:
- Open the command palette (Ctrl+Shift+P)
- Select
Azure IoT Edge: Add IoT Edge module
- Select the default deployment manifest (deployment.template.json)
- Select
Module from Azure Marketplace
. - It opens a new tab with all IoT Edge module offers from the Azure Marketplace. Select the
Nvidia Deepstream SDK
one, select theNVIDIA DeapStream SDK 5.1 for ARM
plan and select thelatest
tag.
-
Deploy the solution to your device:
Generate IoT Edge Deployment Manifest
by right clicking on the deployment.template.json fileCreate Deployment for Single Device
by right clicking on the generated file in the /config folder- Select your IoT Edge device
-
Start monitoring the messages sent from the device to the cloud
- Right-click on your device (bottom left corner)
- Select
Start Monitoring Built-In Event Endpoint
After a little while, (enough time for IoT Edge to download and start DeepStream module which is 1.75GB and compile the AI model), you should be able to see messages sent by the Deepstream module to the cloud via the IoT Edge runtime in VS Code. These messages are the results of Deepstream processing a sample video and analyzing it with an sample AI model that detects people and cars in this video and sends a message for each object found.
We'll now modify the configuration of the Deepstream application and the IoT Edge deployment manifest to be able to see the output video streams. We'll do that by asking Deepstream to output the inferred videos to an RTSP video stream and visualize this RTSP stream with VLC.
-
Create your updated Deepstream config file on your Nano device: a. Open an SSH connection on your Nano device (for instance from VS Code terminal):
ssh your-nano-username@your-nano-ip-address
- Create a new folder to host modified Deepstream config files
cd /var sudo mkdir deepstream mkdir ./deepstream/custom_configs sudo chmod -R 777 /var/deepstream cd ./deepstream/custom_configs
-
Use your favorite text editor to create a copy of the sample Deepstream configuration file:
- Create and open a new file:
nano test5_config_file_src_infer_azure_iotedge_edited.txt
-
Copy and save the content of the original Deepstream configuration file which you can find in this repo under
test5_config_file_src_infer_azure_iotedge.txt
-
Create another configuration file specific to how messages are being sent (which is referenced in the above configuration file):
nano dstest5_msgconv_sample_config.txt
- Copy and save the content of the original messaging Deepstream configuration file which you can find in this repo under
dstest5_msgconv_sample_config.txt
-
Edit the configuration file:
- Disable the first sink (FakeSink) and add a new RTSP sink with the following properties:
[sink0] enable=0
[sink3] enable=1 #Type - 1=FakeSink 2=EglSink 3=File 4=RTSPStreaming type=4 #1=h264 2=h265 codec=1 sync=0 bitrate=4000000 # set below properties in case of RTSPStreaming rtsp-port=8554 udp-port=5400
- Reduce the number of inferences to be every 3 frames (see
interval
property) otherwise the Nano will drop some frames. In the next section, we'll use a Nano specific config to process 8 video streams in real-time:
[primary-gie] enable=1 gpu-id=0 batch-size=4 ## 0=FP32, 1=INT8, 2=FP16 mode bbox-border-color0=1;0;0;1 bbox-border-color1=0;1;1;1 bbox-border-color2=0;1;1;1 bbox-border-color3=0;1;0;1 nvbuf-memory-type=0 interval=2
- To make it easier to connect to the output RTSP stream, let's set DeepStream to continuously loop over the test input video files:
[tests] file-loop=1
- Save and Quit (CTRL+O, CTRL+X)
-
Mount your updated config file in the Deepstream module by adding its createOptions in the
deployment.template.json
file from your development's machine:- Add the following to your Deepstream createOptions:
"HostConfig":{ "Binds": ["/var/deepstream/custom_configs/:/opt/nvidia/deepstream/deepstream-5.1/sources/apps/sample_apps/deepstream-test5/custom_configs/"] }
- Edit your Deepstream application working directory and entrypoint to use this updated config file via Deepstream createOptions:
"WorkingDir": "/opt/nvidia/deepstream/deepstream-5.1/sources/apps/sample_apps/deepstream-test5/custom_configs/"
"Entrypoint":["/usr/bin/deepstream-test5-app","-c","test5_config_file_src_infer_azure_iotedge_edited.txt"]
-
Open the RTSP port of DeepStream module so that you can visualize this feed from another device:
- Add the following to your Deepstream createOptions, at the root:
"ExposedPorts":{ "8554/tcp": {} }
- Add the following to your Deepstream createOptions, in the
HostConfig
node:
"PortBindings": { "8554/tcp": [ { "HostPort": "8554" } ] }
-
Deploy your updated IoT Edge solution:
Generate IoT Edge Deployment Manifest
by right clicking on the deployment.template.json fileCreate Deployment for Single Device
by right clicking on the generated file in the /config folder- Select your IoT Edge device
- Start monitoring the messages sent from the device to the cloud by right clicking on the device (bottom left corner) and select
Start Monitoring Built-In Event Endpoint
-
Finally, open the default output RTSP stream generated by DeepStream with VLC:
- Open VLC
- Go to
Media
>Open Network Stream
- Paste the default
RTSP Video URL
generated by deepstream, which follows the formatrtsp://your-nano-ip-address:8554/ds-test
- Click
Play
You should now see messages recevied by IoT Hub via in VS Code AND see the processed video cia VLC.
We'll now update Deepstream's configuration to process 8 video streams concurrently (1080p 30fps).
We'll start by updating the batch-size to 8 instead of 4 (primagy-gie
/ batch-size
property). Then because Tthe Jetson Nano isn't capable of doing inferences on 240 frames per second with a ResNet10 model, we will instead run inferences every 5 frames (primagy-gie
/ interval
property) and use Deepstream's built-in tracking algorithm for in-between frames, which is less computationnally intensive (tracker
group). We'll also use a slightly lower inference resolution (defined via primagy-gie
/ config-file
property). These changes are captured in the Deepstream configuration file below specific to Nano.
-
Update your previously edited Deepstream config file:
- Open your previous config file:
nano test5_config_file_src_infer_azure_iotedge_edited.txt
-
Copy the content of Deepstream's configuration file named
test5_config_file_src_infer_azure_iotedge_nano_8sources.txt
from this repo -
Save and Quit (CTRL+O, CTRL+X)
-
To simulate 8 video cameras, download and add to Deepstream 8 videos files
- Open an ssh connection on your Nano device (password=
dlinano
):
ssh your-nano-username@your-nano-ip-address
- Host these video files on your local disk
cd /var/deepstream mkdir custom_streams sudo chmod -R 777 /var/deepstream cd ./custom_streams
- Download the video files
wget -O cars-streams.tar.gz --no-check-certificate "https://onedrive.live.com/download?cid=0C0A4A69A0CDCB4C&resid=0C0A4A69A0CDCB4C%21588371&authkey=AAavgrxG95v9gu0"
- Un-compress the video files
tar -xzvf cars-streams.tar.gz
- Mount these video streams by adding the following binding via the
HostConfig
node of Deepstream's createOptions:
"Binds": [ "/var/deepstream/custom_configs/:/root/deepstream_sdk_v4.0.2_jetson/sources/apps/sample_apps/deepstream-test5/custom_configs/", "/var/deepstream/custom_streams/:/root/deepstream_sdk_v4.0.2_jetson/sources/apps/sample_apps/deepstream-test5/custom_streams/" ]
- Open an ssh connection on your Nano device (password=
-
Verify that your are still using your updated configuration file and still expose Deepstream's RTSP port (8554). You can double check your settings by comparing your deployment file to the one in this repo.
-
To speed up IoT Edge message throughput, configure the edgeHub to use an in-memory store. In your deployment manifest, set the
usePersistentStorage
environment variable tofalse
in edgeHub configuration (next to itssettings
node) and disable unused protocol heads (DeepStream uses MQTT to communicate with the EdgeHub):"edgeHub": { "env": { "usePersistentStorage": { "value": "false" }, "amqpSettings__enabled": { "value": false }, "httpSettings__enabled": { "value": false } } }
-
Deploy your updated IoT Edge solution:
Generate IoT Edge Deployment Manifest
by right clicking on the deployment.template.json fileCreate Deployment for Single Device
by right clicking on the generated file in the /config folder- Select your IoT Edge device
-
Finally, wait a few moments for DeepStream to restart and open the default output RTSP stream generated by DeepStream with VLC:
- Open VLC
- Go to
Media
>Open Network Stream
- Paste the default
RTSP Video URL
generated by deepstream, which follows the formatrtsp://your-nano-ip-address:8554/ds-test
- Click
Play
You should now see the 8 video streams being processed and displayed via VLC.
Finally, let's use a custom AI model instead of DeepStream's default one. We'll take the use case of a soda can manufaturer who wants to improve the efficienty of its plant by detecting soda cans that fell down on production lines. We'll use simulated cameras to monitor each of the lines, collect images, train a custom AI model with Custom Vision which is a no-code computer vision AI model builder, to detects cans that are up or down and then deploy this custom AI model to DeepStream.
-
Let's start by creating a new Custom Vision project in your Azure subscription:
- Go to http://customvision.ai
- Sign-in
- Create a new Project
- Give it a name like
Soda Cans Down
- Pick up your resource, if none select
create new
and selectSKU - F0
(F0 is free) or (S0) - Select
Project Type
=Object Detection
- Select
Domains
=General (Compact)
We've already collected training images for you. Download this compressed folder, unzip it and upload the training images to Custom Vision.
-
We then need to label all of them:
- Click on an image
- Label the cans that are up as
Up
and the ones that are down asDown
- Hit the right arrow to move on to the next image and label the remaining 70+ images...or read below to use a pre-built model with this set of images
-
Once you're done labeling, let's train and export your model:
- Train your model by clicking on
Train
- Export it by going to the
Performance
tab, clicking onExport
and choosingONNX
Download
your custom AI model and unzip it
- Train your model by clicking on
-
Finally, we'll deploy this custom vision model to the Jetson Nano and configure DeepStream to use this model.
-
Open an ssh connection on your Nano device (password=
dlinano
):ssh your-nano-username@your-nano-ip-address
-
Create a folder to store your custom model:
cd /var/deepstream sudo mkdir custom_models sudo chmod -R 777 /var/deepstream cd ./custom_models
-
Copy this custom model to your Jetson Nano, either by copying your own model with
scp
or by using this pre-built one:wget -O cans-onnx-model.tar.gz --no-check-certificate "https://onedrive.live.com/download?cid=0C0A4A69A0CDCB4C&resid=0C0A4A69A0CDCB4C%21588388&authkey=AC4OIGTkjg_t5Cc" tar -xzvf cans-onnx-model.tar.gz
-
For DeepStream to understand how to parse the bounding boxes provided by a model from Custom Vision, we need to download an extra library:
wget -O libnvdsinfer_custom_impl_Yolo_Custom_Vision.so --no-check-certificate "https://onedrive.live.com/download?cid=0C0A4A69A0CDCB4C&resid=0C0A4A69A0CDCB4C%21595626&authkey=AC9Lfp4wuXSTFz4"
-
Download raw video streams that we'll use to simulate cameras
cd ../custom_streams wget -O cans-streams.tar.gz --no-check-certificate "https://onedrive.live.com/download?cid=0C0A4A69A0CDCB4C&resid=0C0A4A69A0CDCB4C%21588372&authkey=AJfRMnW2qvR3OC4" tar -xzvf cans-streams.tar.gz
-
Edit DeepStream configuration file to point to the updated video stream inputs and your custom vision model:
- Open DeepStream configuration file:
cd ../custom_configs nano test5_config_file_src_infer_azure_iotedge_edited.txt
-
Copy the content of Deepstream's configuration file named
test5_config_file_src_infer_azure_iotedge_nano_custom_vision.txt
from this repo -
Save and Quit (CTRL+O, CTRL+X)
-
Create another configuration file specific to the inference engine (which is referenced in the above configuration file):
nano config_infer_custom_vision.txt
- Copy the content of inference's configuration file named
config_infer_custom_vision.txt
from this repo - Double check that the
num-detected-classes
property maps to the number of classes or objects that you've trained your custom vision model for. - Save and Quit (CTRL+O, CTRL+X)
- Create a last configuration file to name your cameras (which is referenced via the
camera-id
property in the main DeepStream configuration file):
nano msgconv_config_soda_cans.txt
- Copy the content of inference's configuration file named
msgconv_config_soda_cans.txt
from this repo - Save and Quit (CTRL+O, CTRL+X)
-
- Mount these video streams, models, configuration files by adding the following bindings via the
HostConfig
node of Deepstream's createOptions:
"Binds": [
"/var/deepstream/custom_configs/:/opt/nvidia/deepstream/deepstream-5.1/sources/apps/sample_apps/deepstream-test5/custom_configs/",
"/var/deepstream/custom_streams/:/opt/nvidia/deepstream/deepstream-5.1/sources/apps/sample_apps/deepstream-test5/custom_streams/",
"/var/deepstream/custom_models/:/opt/nvidia/deepstream/deepstream-5.1/sources/apps/sample_apps/deepstream-test5/custom_models/"
]
-
Deploy your updated IoT Edge solution:
Generate IoT Edge Deployment Manifest
by right clicking on the deployment.template.json fileCreate Deployment for Single Device
by right clicking on the generated file in the /config folder- Select your IoT Edge device
-
Finally, wait a few moments for DeepStream to restart and open the default output RTSP stream generated by DeepStream with VLC:
- Open VLC
- Go to
Media
>Open Network Stream
- Paste the default
RTSP Video URL
generated by deepstream, which follows the formatrtsp://your-nano-ip-address:8554/ds-test
- Click
Play
We are now visualizing the processing of 3 real time (e.g. 30fps 1080p) video streams with a custom vision AI models that we built in minutes to detect custom visual anomalies!
A great learning resource to learn more about DeepStream is this free online course by NVIDIA.
Deesptream's SDK based on GStreamer. It is very modular with its concepts of plugins. Each plugins has sinks
and sources
. NVIDIA provides several plugins as part of Deepstream which are optimized to leverage NVIDIA's GPUs. How these plugins are connected with each others is defined in the application's configuration file.
You can learn more about its architecture in NVIDIA's official documentation (sneak peak below).
To quickly change a value in your config file, leverage the fact that it is being mounted from a local file so all you have to do is (for instance via an ssh terminal):
-
Open your config file (in
/var/deepstream/custom_configs
in this sample) -
Make your changes and save
-
Restart Deepstream container
iotedge restart NVIDIADeepStreamSDK
This assumes that you did not change any file names and thus the same IoT Edge deployment manifest applies.
To use your own source videos and AI models and quickly iterate on them, you can use the same technique used in this sample: mounting local folders with these assets. By doing that, you can quickly iterate on your assets, without any code change or re-compilation.
It is a very common configuration to have DeepStream take several live RTSP streams as inputs. All you have to do is modify DeepStream's configuration file and update its source group:
type=4
uri=rtsp://127.0.0.1:554/rtsp_path
and update its streammux group:
live-source=1
To output an RTSP stream with the final result, Deepstream can output RTSP videos on Tesla platforms but not on Jetson platforms for now. There is currently a limitation on RTSP encoding on Jetson platforms.
Deepstream supports a wide varity of options, a lot of which are available via configuraiton changes. To learn more about them, go to Deepstream's documentation:
- Configuration groups documents all configuration options for each out-of-box plugin
- Application tuning provides application tuning tips
To debug your DeepStream module, look at the last 200 lines of its logs:
iotedge logs NVIDIADeepStreamSDK --tail 200 -f
Sometimes it is helpful to verify the options that Docker took into account when creating your Deepstream container via IoT Edge. It is particularly useful to double-check the folders that have been mounted in your container. The simplest way to do that is to use the docker inspect
command:
sudo docker inspect NVIDIADeepStreamSDK
While Moby does, IoT Edge does not yet support the new way to mount NVIDIA GPUs into a Docker container. This support is planned with release 1.0.10 of IoT Edge for early 2020. For now, you still need to use the previous nvidia-docker runtime with Docker CE, which is installed by default on Jetson Nano. That's why Deepstream SDK on IoT Edge is currently in preview.
Deepstream relies on NVIDIA TensorRT in do the inferencing. Thus any AI models supported by TensorRT is supported with Deepstream. In practice, most of AI models are supported by TensorRT. See this list of all layers supported by TensorRT.
Of course it accepts AI models in TensorRT format but can also convert TensorFlow and ONNX models (see this documentation for more details on the ONNX -> TensorRT parser). Conversion is done automatically when launching the application.
You can thus build your AI model with Azure Machine Learning and work with ONNX format or use Custom Vision with their ONNX export. Instructions to use Custom Vision will soon be added to this repo.
You can also use pre-built models made freely available by NVIDIA here and customize them using NVIDIA's Transfer Learning Toolkit.
The Gst-nvmsgbroker
plugin is the one sending output messages. Its full documentation is available here.
By default, you can use the topic
property in Deepstream to set up the output of the Deepstream modules and define your routes in IoT Edge appropriately.
Iterating on a local model & config file locally and bind mounting them to the container is only recommended during active development, but it does not scale. To manage your application (AI model & config files artifacts in particular), you have two options:
- Package everything into one container. Have the artifacts you expect to change regularly like your AI model and config files in the latest layers of your docker container so that most of your docker image remains unchanged when updating those. Each model change will require a new module update.
- Use a separate 'artifacts' module to deliver these artifacts and bind mount them to the Deepstream module. That way you can use either twins or your own methods to configure your 'artifacts' module at scale.
Why is Deepstream running as one IoT Edge module with its own plugins vs plugins in different modules?
Deepstream does a lot of optimizations to be able to handle many video streams such as:
- zero in-memory copy, which is much easier to achieve from the same container
- pushing the entire pipeline on a GPU card, which requires the entire pipeline to be part of the same container to avoid hardware access conflicts
These types of optimizations only work when the entire pipeline is running in the same container and thus as one IoT Edge module. The output of Deepstream module can however be sent to other modules running on the same device, typically to run some business logic code or filtering logic.
For some use cases, the default Deepstream app is not enough. Whenever the changes are required in the plugin pipeline, configuration changes are not enough and a Deepstream app needs to be re-compiled.
A common example of a different pipeline is to have cascading AI models(ex: AI 1- detect a package, AI 2- detect a barcode, etc.).
To build your own Deepstream application or even build your own Deepstream plugin, you can follow this link: Deepstream documentation.
NVIDIA published some performance benchmarks on their documentation website.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.