[DLstreamer] Fix docs. (open-edge-platform#852)

nszczygl9 · web-flow · commit b2cefa2decad · 2025-08-25T15:38:14.000+02:00
diff --git a/libraries/dl-streamer/docs/source/get_started/install/install_guide_ubuntu.md b/libraries/dl-streamer/docs/source/get_started/install/install_guide_ubuntu.md
@@ -83,17 +83,19 @@ drivers. For more details see [prerequisites](#prerequisites).
 - **In Ubuntu 22**
 
   ```bash
-  sudo -E wget -O- https://apt.repos.intel.com/edgeai/dlstreamer/GPG-PUB-KEY-INTEL-DLS.gpg | sudo tee /usr/share/  keyrings/dls-archive-keyring.gpg > /dev/null
-  echo "deb [signed-by=/usr/share/keyrings/dls-archive-keyring.gpg] https://apt.repos.intel.com/edgeai/dlstreamer/  ubuntu22 ubuntu22 main" | sudo tee /etc/apt/sources.list.d/intel-dlstreamer.list
-  sudo bash -c 'echo "deb [signed-by=/usr/share/keyrings/oneapi-archive-keyring.gpg] https://apt.repos.intel.com/  openvino/2025 ubuntu22 main" | sudo tee /etc/apt/sources.list.d/intel-openvino-2025.list'
+  sudo -E wget -O- https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB | gpg --dearmor | sudo tee /usr/share/keyrings/oneapi-archive-keyring.gpg > /dev/null
+  sudo -E wget -O- https://apt.repos.intel.com/edgeai/dlstreamer/GPG-PUB-KEY-INTEL-DLS.gpg | sudo tee /usr/share/keyrings/dls-archive-keyring.gpg > /dev/null
+  echo "deb [signed-by=/usr/share/keyrings/dls-archive-keyring.gpg] https://apt.repos.intel.com/edgeai/dlstreamer/ubuntu22 ubuntu22 main" | sudo tee /etc/apt/sources.list.d/intel-dlstreamer.list
+  sudo bash -c 'echo "deb [signed-by=/usr/share/keyrings/oneapi-archive-keyring.gpg] https://apt.repos.intel.com/openvino/2025 ubuntu22 main" | sudo tee /etc/apt/sources.list.d/intel-openvino-2025.list'
   ```
 
 - **Ubuntu 24**
 
   ```bash
-  sudo -E wget -O- https://apt.repos.intel.com/edgeai/dlstreamer/GPG-PUB-KEY-INTEL-DLS.gpg | sudo tee /usr/share/  keyrings/dls-archive-keyring.gpg > /dev/null
-  echo "deb [signed-by=/usr/share/keyrings/dls-archive-keyring.gpg] https://apt.repos.intel.com/edgeai/dlstreamer/  ubuntu24 ubuntu24 main" | sudo tee /etc/apt/sources.list.d/intel-dlstreamer.list
-  sudo bash -c 'echo "deb [signed-by=/usr/share/keyrings/oneapi-archive-keyring.gpg] https://apt.repos.intel.com/  openvino/2025 ubuntu24 main" | sudo tee /etc/apt/sources.list.d/intel-openvino-2025.list'
+  sudo -E wget -O- https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB | gpg --dearmor | sudo tee /usr/share/keyrings/oneapi-archive-keyring.gpg > /dev/null
+  sudo -E wget -O- https://apt.repos.intel.com/edgeai/dlstreamer/GPG-PUB-KEY-INTEL-DLS.gpg | sudo tee /usr/share/keyrings/dls-archive-keyring.gpg > /dev/null
+  echo "deb [signed-by=/usr/share/keyrings/dls-archive-keyring.gpg] https://apt.repos.intel.com/edgeai/dlstreamer/ubuntu24 ubuntu24 main" | sudo tee /etc/apt/sources.list.d/intel-dlstreamer.list
+  sudo bash -c 'echo "deb [signed-by=/usr/share/keyrings/oneapi-archive-keyring.gpg] https://apt.repos.intel.com/openvino/2025 ubuntu24 main" | sudo tee /etc/apt/sources.list.d/intel-openvino-2025.list'
   ```
 
   > **NOTE:** If you have OpenVINO™ installed in a version different from 2025.2.0,
@@ -125,7 +127,7 @@ To see the full list of installed components check the
 The Python packages required to run Intel® DL Streamer python elements
 or samples are not installed by default. You can install them using
 commands from
-[Advanced Install Guide Compilation / Install Python dependencies](https://dlstreamer.github.io/dev_guide/advanced_install/advanced_install_guide_compilation.html#step-6-install-python-dependencies)
+[Advanced Install Guide Compilation / Install Python dependencies](../../dev_guide/advanced_install/advanced_install_guide_compilation.html#step-6-install-python-dependencies)
 
 ### [Optional] Step 5: Post installation steps
 
@@ -171,40 +173,40 @@ following command:
 
   ```bash
   export LIBVA_DRIVER_NAME=iHD
-  export GST_PLUGIN_PATH=/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:/opt/intel/  dlstreamer/streamer/lib/
-  export LD_LIBRARY_PATH=/opt/intel/dlstreamer/gstreamer/lib:/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/lib/  gstreamer-1.0:/sr/lib:/opt/intel/dlstreamer/lib:/usr/local/lib/gstreamer-1.0:/usr/local/lib
+  export GST_PLUGIN_PATH=/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:/opt/intel/dlstreamer/streamer/lib/
+  export LD_LIBRARY_PATH=/opt/intel/dlstreamer/gstreamer/lib:/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/lib/gstreamer-1.0:/sr/lib:/opt/intel/dlstreamer/lib:/usr/local/lib/gstreamer-1.0:/usr/local/lib
   export LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri
   export GST_VA_ALL_DRIVERS=1
   export PATH=/opt/intel/dlstreamer/gstreamer/bin:/opt/intel/dlstreamer/bin:$PATH
   export GST_PLUGIN_FEATURE_RANK=${GST_PLUGIN_FEATURE_RANK},ximagesink:MAX
-  export GI_TYPELIB_PATH=/opt/intel/dlstreamer/gstreamer/lib/girepository-1.0:/usr/lib/x86_64-linux-gnu/girepository-1.  0
+  export GI_TYPELIB_PATH=/opt/intel/dlstreamer/gstreamer/lib/girepository-1.0:/usr/lib/x86_64-linux-gnu/girepository-1.0
   ```
 
 - **Ubuntu 22**
 
   ```bash
 
   export LIBVA_DRIVER_NAME=iHD
-  export GST_PLUGIN_PATH=/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:/opt/intel/  dlstreamer/streamer/lib/
-  export LD_LIBRARY_PATH=/opt/intel/dlstreamer/gstreamer/lib:/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/lib/  gstreamer-1.0:/sr/lib:/opt/intel/dlstreamer/lib:/usr/local/lib/gstreamer-1.0:/usr/local/lib:/opt/opencv:/opt/rdkafka
+  export GST_PLUGIN_PATH=/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:/opt/intel/dlstreamer/streamer/lib/
+  export LD_LIBRARY_PATH=/opt/intel/dlstreamer/gstreamer/lib:/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/lib/gstreamer-1.0:/sr/lib:/opt/intel/dlstreamer/lib:/usr/local/lib/gstreamer-1.0:/usr/local/lib:/opt/opencv:/opt/rdkafka
   export LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri
   export GST_VA_ALL_DRIVERS=1
   export PATH=/opt/intel/dlstreamer/gstreamer/bin:/opt/intel/dlstreamer/bin:$PATH
   export GST_PLUGIN_FEATURE_RANK=${GST_PLUGIN_FEATURE_RANK},ximagesink:MAX
-  export GI_TYPELIB_PATH=/opt/intel/dlstreamer/gstreamer/lib/girepository-1.0:/usr/lib/x86_64-linux-gnu/girepository-1.  0
+  export GI_TYPELIB_PATH=/opt/intel/dlstreamer/gstreamer/lib/girepository-1.0:/usr/lib/x86_64-linux-gnu/girepository-1.0
   ```
 
 - **Fedora 41**
 
   ```bash
   export LIBVA_DRIVER_NAME=iHD
-  export GST_PLUGIN_PATH=/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:/opt/intel/  dlstreamer/gstreamer/lib/
-  export LD_LIBRARY_PATH=/opt/intel/dlstreamer/gstreamer/lib:/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/lib/  gstreamer-1.0:/usr/lib:/opt/intel/dlstreamer/lib:/usr/local/lib/gstreamer-1.0:/usr/local/lib:/opt/opencv:/opt/  rdkafka:/opt/ffmpeg
+  export GST_PLUGIN_PATH=/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/gstreamer/lib/gstreamer-1.0:/opt/intel/dlstreamer/gstreamer/lib/
+  export LD_LIBRARY_PATH=/opt/intel/dlstreamer/gstreamer/lib:/opt/intel/dlstreamer/lib:/opt/intel/dlstreamer/lib/gstreamer-1.0:/usr/lib:/opt/intel/dlstreamer/lib:/usr/local/lib/gstreamer-1.0:/usr/local/lib:/opt/opencv:/opt/rdkafka:/opt/ffmpeg
   export LIBVA_DRIVERS_PATH=/usr/lib64/dri-nonfree
   export GST_VA_ALL_DRIVERS=1
   export PATH=/opt/intel/dlstreamer/gstreamer/bin:/opt/intel/dlstreamer/bin:$PATH
   export GST_PLUGIN_FEATURE_RANK=${GST_PLUGIN_FEATURE_RANK},ximagesink:MAX
-  export GI_TYPELIB_PATH=/opt/intel/dlstreamer/gstreamer/lib/girepository-1.0:/usr/lib/x86_64-linux-gnu/girepository-1.  0
+  export GI_TYPELIB_PATH=/opt/intel/dlstreamer/gstreamer/lib/girepository-1.0:/usr/lib/x86_64-linux-gnu/girepository-1.0
   ```
 
   or run:
diff --git a/libraries/dl-streamer/samples/gstreamer/benchmark/README.md b/libraries/dl-streamer/samples/gstreamer/benchmark/README.md
@@ -27,17 +27,17 @@ or use any other media/video file.
 
 Benchmark video decode and inference on single model (using gvainference element):
 ```sh
-./benchmark_one_model.sh VIDEO_FILE [MODEL_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [SINK_ELEMENT]
+./benchmark_one_model.sh VIDEO_FILE [MODEL_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [INFERENCE_ELEMENT] [SINK_ELEMENT]
 ```
 
 Benchmark video decode and inference on two models (object detection and object classification models) using gvadetect and gvaclassify elements:
 ```sh
-./benchmark_two_models.sh VIDEO_FILE [MODEL1_PATH] [MODEL2_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [SINK_ELEMENT]
+./benchmark_two_models.sh VIDEO_FILE [MODEL1_PATH] [MODEL2_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [INFERENCE1_ELEMENT] [INFERENCE2_ELEMENT] [SINK_ELEMENT]
 ```
 
-The sample `benchmark_one_model.sh` takes one to eight command-line parameters (last seven are optional):
-1. [INPUT_VIDEO] to specify input video file
-2. [MODEL] to specify model in OpenVINO™ toolkit IR format. Default is `face-detection-adas-0001` model in `INT8` precision.
+The sample `benchmark_one_model.sh` takes one to eight command-line parameters (last eight are optional):
+1. [VIDEO_FILE] to specify a path to input video file
+2. [MODEL_PATH] to specify a path to model in OpenVINO™ toolkit IR format. Default is `face-detection-adas-0001` model in `INT8` precision.
 3. [DECODE_DEVICE] to specify device for video decode, could be
     * CPU (Default)
     * GPU
@@ -48,8 +48,9 @@ The sample `benchmark_one_model.sh` takes one to eight command-line parameters (
     * ...
 5. [NUMBER_STREAMS] number of simultaneous streams to benchmark
 6. [NUMBER_PROCESSES] number of processes. If multiple processes, streams distributed equally across processes
-7. [DECODE_ELEMENT] element (or pipeline of elements in gst-launch format) for demuxing and video decoding. Default is 'decodebin3'
-8. [SINK_ELEMENT] sink element (or pipeline of elements in gst-launch format), default is `fakesink async=false`
+7. [DECODE_ELEMENT] element (or pipeline of elements in gst-launch format) for demuxing and video decoding. Default is `decodebin3`
+8. [INFERENCE_ELEMENT] DL Streamer pipeline element to perform the inference, default is `gvainference`
+9. [SINK_ELEMENT] sink element (or pipeline of elements in gst-launch format), default is `fakesink async=false`
 
 The sample `benchmark_one_model.sh` has similar parameters with additional parameter for second model.
 
diff --git a/libraries/dl-streamer/samples/gstreamer/benchmark/benchmark_one_model.sh b/libraries/dl-streamer/samples/gstreamer/benchmark/benchmark_one_model.sh
@@ -8,9 +8,9 @@
 set -e
 
 if [ -z "${MODELS_PATH:-}" ]; then
-  echo "Error: MODELS_PATH is not set." >&2 
+  echo "Error: MODELS_PATH is not set." >&2
   exit 1
-else 
+else
   echo "MODELS_PATH: $MODELS_PATH"
 fi
 
@@ -27,12 +27,12 @@ SINK_ELEMENT=${9:-"fakesink async=false"}
 # check if model exists in local directory
 if [ ! -f $MODEL_PATH ]; then
   echo "Model not found: ${MODEL_PATH}"
-  exit 
+  exit
 fi
 
 if [ -z "${1}" ]; then
   echo "ERROR set path to video"
-  echo "Usage : ./benchmark_one_model.sh VIDEO_FILE [MODEL_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [SINK_ELEMENT]"
+  echo "Usage : ./benchmark_one_model.sh VIDEO_FILE [MODEL_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [INFERENCE_ELEMENT] [SINK_ELEMENT]"
   echo "You can download video with"
   echo "\"curl https://raw.githubusercontent.com/intel-iot-devkit/sample-videos/master/head-pose-face-detection-female-and-male.mp4 --output /path/to/your/video/head-pose-face-detection-female-and-male.mp4\""
   echo "and run sample ./benchmark.sh /path/to/your/video/head-pose-face-detection-female-and-male.mp4"
diff --git a/libraries/dl-streamer/samples/gstreamer/benchmark/benchmark_two_models.sh b/libraries/dl-streamer/samples/gstreamer/benchmark/benchmark_two_models.sh
@@ -8,9 +8,9 @@
 set -e
 
 if [ -z "${MODELS_PATH:-}" ]; then
-  echo "Error: MODELS_PATH is not set." >&2 
+  echo "Error: MODELS_PATH is not set." >&2
   exit 1
-else 
+else
   echo "MODELS_PATH: $MODELS_PATH"
 fi
 
@@ -29,7 +29,7 @@ SINK_ELEMENT=${11:-"fakesink async=false"}
 # check if model exists in local directory
 if [ ! -f $MODEL1_PATH ]; then
   echo "Model not found: ${MODEL1_PATH}"
-  exit 
+  exit
 fi
 
 # check if model exists in local directory
@@ -40,7 +40,7 @@ fi
 
 if [ -z "${1}" ]; then
   echo "ERROR set path to video"
-  echo "Usage : ./benchmark_two_models.sh VIDEO_FILE [MODEL1_PATH] [MODEL2_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [SINK_ELEMENT]"
+  echo "Usage : ./benchmark_two_models.sh VIDEO_FILE [MODEL1_PATH] [MODEL2_PATH] [DECODE_DEVICE] [INFERENCE_DEVICE] [NUMBER_STREAMS] [NUMBER_PROCESSES] [DECODE_ELEMENT] [INFERENCE1_ELEMENT] [INFERENCE2_ELEMENT] [SINK_ELEMENT]"
   echo "You can download video with"
   echo "\"curl https://raw.githubusercontent.com/intel-iot-devkit/sample-videos/master/head-pose-face-detection-female-and-male.mp4 --output /path/to/your/video/head-pose-face-detection-female-and-male.mp4\""
   echo "and run sample ./benchmark.sh /path/to/your/video/head-pose-face-detection-female-and-male.mp4"
