Update savant rs 0.2.30 and fix minor bugs (#775)

* module image types documentation * added docs for auxiliary streams * Closes #766
insight-platform · Jun 10, 2024 · 641d16e · 641d16e
1 parent 8a1c922
commit 641d16e
Show file tree

Hide file tree

Showing 64 changed files with 79 additions and 119 deletions.
diff --git a/docs/source/advanced_topics/13_auxiliary_video_streams.rst b/docs/source/advanced_topics/13_auxiliary_video_streams.rst
@@ -0,0 +1,21 @@
+Auxiliary Video Streams
+-----------------------
+
+There are situations, when you want to create a video stream which is artificial and does not match to any source video streams.
+
+Examples of such streams are:
+
+- Grid streams (e.g. 2x2 grid of videos);
+- Video streams with augmentations (e.g. video with a sidebar or dashboard);
+- Videos of other resolutions, e.g. you transcode incoming 4k to 1080p, 720p, 480p, etc.
+- Super-resolution streams, e.g. you upscale incoming 720p to 1080p.
+- Frame interpolation streams, e.g. you create a 60fps video from 30fps video.
+
+Savant 0.4.1 introduces the concept of auxiliary streams. An auxiliary stream is a stream that is not directly associated with any source stream. It is created by the user in PyFunc and is sent directly to pipeline sink , bypassing downstream pipeline elements.
+
+The sample showing how to work with auxiliary streams is available in the `examples/auxiliary_streams <https://github.com/insight-platform/Savant/tree/develop/samples/auxiliary_streams>`__ directory. The sample shows how to convert a video stream to multiple resolutions and send them to the pipeline sink.
+
+.. note::
+
+    Auxiliary streams deliver metadata provided by the user.
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,5 +1,4 @@
-.. Savant documentation master file,
-   should at least contain the root `toctree` directive.
+.. Savant documentation master file, should at least contain the root `toctree` directive.
 
 Welcome To Savant Documentation
 ===================================
@@ -198,6 +197,7 @@ Savant supports processing parallelization; it helps to utilize the available re
    advanced_topics/10_client_sdk
    advanced_topics/11_memory_representation_function.rst
    advanced_topics/12_torch_hub.rst
+   advanced_topics/13_auxiliary_video_streams.rst
 
 .. toctree::
    :maxdepth: 0

diff --git a/docs/source/savant_101/12_video_processing.rst b/docs/source/savant_101/12_video_processing.rst
@@ -456,7 +456,8 @@ PNG Сodec
 
    PNG compression level. Range: ``0`` - ``9``. The default value is ``6``.
 
-Example:
+Codec Configuration Examples
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
   .. code-block:: yaml
 

diff --git a/samples/age_gender_recognition/docker-compose.l4t.yml b/samples/age_gender_recognition/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/age_gender_recognition/docker-compose.x86.yml b/samples/age_gender_recognition/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -38,7 +37,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -64,7 +63,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
 volumes:
   zmq_sockets:
diff --git a/samples/animegan/docker-compose.x86.yml b/samples/animegan/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   source:
@@ -37,7 +36,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   video-sink:
     image: ghcr.io/insight-platform/savant-adapters-gstreamer:latest

diff --git a/samples/area_object_counting/docker-compose.l4t.yml b/samples/area_object_counting/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/area_object_counting/docker-compose.x86.yml b/samples/area_object_counting/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -38,7 +37,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -63,7 +62,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
 volumes:
   zmq_sockets:
diff --git a/samples/auxiliary_streams/docker-compose.l4t.yml b/samples/auxiliary_streams/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/auxiliary_streams/docker-compose.x86.yml b/samples/auxiliary_streams/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -33,7 +32,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -58,7 +57,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
 volumes:
   zmq_sockets:
diff --git a/samples/buffer_adapter/docker-compose.l4t.yml b/samples/buffer_adapter/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/buffer_adapter/docker-compose.x86.yml b/samples/buffer_adapter/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -59,7 +58,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -85,7 +84,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   prometheus:
     image: prom/prometheus:v2.48.0

diff --git a/samples/conditional_video_processing/docker-compose.l4t.yml b/samples/conditional_video_processing/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -67,7 +66,7 @@ services:
     ports:
       - "2379:2379"
     healthcheck:
-      test: ["CMD", "/opt/bitnami/scripts/etcd/healthcheck.sh"]
+      test: [ "CMD", "/opt/bitnami/scripts/etcd/healthcheck.sh" ]
       interval: 5s
       timeout: 5s
       retries: 3

diff --git a/samples/conditional_video_processing/docker-compose.x86.yml b/samples/conditional_video_processing/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -41,7 +40,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -67,7 +66,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   etcd:
     container_name: etcd
@@ -79,7 +78,7 @@ services:
     ports:
       - "2379:2379"
     healthcheck:
-      test: ["CMD", "/opt/bitnami/scripts/etcd/healthcheck.sh"]
+      test: [ "CMD", "/opt/bitnami/scripts/etcd/healthcheck.sh" ]
       interval: 5s
       timeout: 5s
       retries: 3

diff --git a/samples/face_reid/docker-compose.l4t.yml b/samples/face_reid/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   index-builder-client:

diff --git a/samples/face_reid/docker-compose.x86.yml b/samples/face_reid/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   index-builder-client:
@@ -39,7 +38,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
     profiles:
       - index
 
@@ -85,7 +84,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
     profiles:
       - demo
 
@@ -113,7 +112,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
     profiles:
       - demo
 

diff --git a/samples/fisheye_line_crossing/docker-compose.l4t.yml b/samples/fisheye_line_crossing/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/fisheye_line_crossing/docker-compose.x86.yml b/samples/fisheye_line_crossing/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -40,7 +39,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -65,7 +64,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   graphite:
     image: graphiteapp/graphite-statsd

diff --git a/samples/intersection_traffic_meter/docker-compose.l4t.yml b/samples/intersection_traffic_meter/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/intersection_traffic_meter/docker-compose.x86.yml b/samples/intersection_traffic_meter/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -39,7 +38,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -64,7 +63,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   graphite:
     image: graphiteapp/graphite-statsd

diff --git a/samples/kafka_redis_adapter/docker-compose-no-keydb.l4t.yml b/samples/kafka_redis_adapter/docker-compose-no-keydb.l4t.yml
@@ -1,5 +1,3 @@
-version: "3.3"
-
 services:
   kafka:
     image: bitnami/kafka:3.5.1

diff --git a/samples/kafka_redis_adapter/docker-compose-no-keydb.x86.yml b/samples/kafka_redis_adapter/docker-compose-no-keydb.x86.yml
@@ -1,5 +1,3 @@
-version: "3.3"
-
 services:
   kafka:
     image: bitnami/kafka:3.5.1

diff --git a/samples/kafka_redis_adapter/docker-compose.l4t.yml b/samples/kafka_redis_adapter/docker-compose.l4t.yml
@@ -1,5 +1,3 @@
-version: "3.3"
-
 services:
   kafka:
     image: bitnami/kafka:3.5.1

diff --git a/samples/kafka_redis_adapter/docker-compose.x86.yml b/samples/kafka_redis_adapter/docker-compose.x86.yml
@@ -1,5 +1,3 @@
-version: "3.3"
-
 services:
   kafka:
     image: bitnami/kafka:3.5.1

diff --git a/samples/keypoint_detection/docker-compose.l4t.yml b/samples/keypoint_detection/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/keypoint_detection/docker-compose.x86.yml b/samples/keypoint_detection/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:
@@ -38,7 +37,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
   always-on-sink:
     image: ghcr.io/insight-platform/savant-adapters-deepstream:latest
@@ -64,7 +63,7 @@ services:
           devices:
             - driver: nvidia
               count: 1
-              capabilities: [gpu]
+              capabilities: [ gpu ]
 
 volumes:
   zmq_sockets:
diff --git a/samples/kvs/docker-compose.l4t.yml b/samples/kvs/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/kvs/docker-compose.x86.yml b/samples/kvs/docker-compose.x86.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source:

diff --git a/samples/license_plate_recognition/docker-compose.l4t.yml b/samples/license_plate_recognition/docker-compose.l4t.yml
@@ -1,4 +1,3 @@
-version: "3.3"
 services:
 
   video-loop-source: