Add benchmarks

docs/PPYOLOE.md

@@ -107,13 +107,19 @@ parse-bbox-func-name=NvDsInferParseYoloE
 
 **NOTE**: If you use the **legacy** model, you should edit the `config_infer_primary_ppyoloe.txt` file.
 
+**NOTE**: The **PP-YOLOE+ and PP-YOLOE legacy** do not resize the input with padding. To get better accuracy, use
+
+```
+maintain-aspect-ratio=0
+```
+
 **NOTE**: The **PP-YOLOE+** uses zero mean normalization on the image preprocess. It is important to change the `net-scale-factor` according to the trained values.
 
 ```
 net-scale-factor=0.0039215697906911373
 ```
 
-**NOTE**: The **PP-YOLOE (legacy)** uses normalization on the image preprocess. It is important to change the `net-scale-factor` and `offsets` according to the trained values.
+**NOTE**: The **PP-YOLOE legacy** uses normalization on the image preprocess. It is important to change the `net-scale-factor` and `offsets` according to the trained values.
 
 Default: `mean = 0.485, 0.456, 0.406` and `std = 0.229, 0.224, 0.225`
 
@@ -143,4 +149,6 @@ config-file=config_infer_primary_ppyoloe_plus.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.

docs/YOLONAS.md

@@ -1,4 +1,4 @@
-# YOLONAS usage
+# YOLO-NAS usage
 
 **NOTE**: The yaml file is not required.
 
@@ -149,6 +149,13 @@ parse-bbox-func-name=NvDsInferParseYoloE
 ...
 ```
 
+**NOTE**: The **YOLO-NAS** resizes the input with left/top padding. To get better accuracy, use
+
+```
+maintain-aspect-ratio=1
+symmetric-padding=0
+```
+
 ##
 
 ### Edit the deepstream_app_config file
@@ -168,4 +175,6 @@ config-file=config_infer_primary_yolonas.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.

docs/YOLOR.md

@@ -146,6 +146,13 @@ parse-bbox-func-name=NvDsInferParseYolo
 ...
 ```
 
+**NOTE**: The **YOLOR** resizes the input with center padding. To get better accuracy, use
+
+```
+maintain-aspect-ratio=1
+symmetric-padding=1
+```
+
 ##
 
 ### Edit the deepstream_app_config file
@@ -165,4 +172,6 @@ config-file=config_infer_primary_yolor.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.

docs/YOLOX.md

@@ -32,7 +32,7 @@ Copy the `export_yolox.py` file from `DeepStream-Yolo/utils` directory to the `Y
 
 #### 3. Download the model
 
-Download the `pth` file from [YOLOX](https://github.com/Megvii-BaseDetection/YOLOX/releases/) releases (example for YOLOX-s standard)
+Download the `pth` file from [YOLOX](https://github.com/Megvii-BaseDetection/YOLOX/releases/) releases (example for YOLOX-s)
 
 ```
 wget https://github.com/Megvii-BaseDetection/YOLOX/releases/download/0.1.1rc0/yolox_s.pth
@@ -42,7 +42,7 @@ wget https://github.com/Megvii-BaseDetection/YOLOX/releases/download/0.1.1rc0/yo
 
 #### 4. Convert model
 
-Generate the ONNX model file (example for YOLOX-s standard)
+Generate the ONNX model file (example for YOLOX-s)
 
 ```
 python3 export_yolox.py -w yolox_s.pth -c exps/default/yolox_s.py --simplify
@@ -98,7 +98,7 @@ Open the `DeepStream-Yolo` folder and compile the lib
 
 ### Edit the config_infer_primary_yolox file
 
-Edit the `config_infer_primary_yolox.txt` file according to your model (example for YOLOX-s standard with 80 classes)
+Edit the `config_infer_primary_yolox.txt` file according to your model (example for YOLOX-s with 80 classes)
 
 ```
 [property]
@@ -114,10 +114,17 @@ parse-bbox-func-name=NvDsInferParseYolo
 
 **NOTE**: If you use the **legacy** model, you should edit the `config_infer_primary_yolox_legacy.txt` file.
 
-**NOTE**: The **YOLOX standard** uses no normalization on the image preprocess. It is important to change the `net-scale-factor` according to the trained values.
+**NOTE**: The **YOLOX and YOLOX legacy** resize the input with left/top padding. To get better accuracy, use
 
 ```
-net-scale-factor=0
+maintain-aspect-ratio=1
+symmetric-padding=0
+```
+
+**NOTE**: The **YOLOX** uses no normalization on the image preprocess. It is important to change the `net-scale-factor` according to the trained values.
+
+```
+net-scale-factor=1
 ```
 
 **NOTE**: The **YOLOX legacy** uses normalization on the image preprocess. It is important to change the `net-scale-factor` and `offsets` according to the trained values.
@@ -150,4 +157,6 @@ config-file=config_infer_primary_yolox.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.

docs/YOLOv5.md

@@ -138,6 +138,13 @@ parse-bbox-func-name=NvDsInferParseYolo
 ...
 ```
 
+**NOTE**: The **YOLOv5** resizes the input with center padding. To get better accuracy, use
+
+```
+maintain-aspect-ratio=1
+symmetric-padding=1
+```
+
 ##
 
 ### Edit the deepstream_app_config file
@@ -157,4 +164,6 @@ config-file=config_infer_primary_yoloV5.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.

docs/YOLOv6.md

@@ -136,6 +136,13 @@ parse-bbox-func-name=NvDsInferParseYolo
 ...
 ```
 
+**NOTE**: The **YOLOv6** resizes the input with center padding. To get better accuracy, use
+
+```
+maintain-aspect-ratio=1
+symmetric-padding=1
+```
+
 ##
 
 ### Edit the deepstream_app_config file
@@ -155,4 +162,6 @@ config-file=config_infer_primary_yoloV6.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.

docs/YOLOv7.md

@@ -140,6 +140,13 @@ parse-bbox-func-name=NvDsInferParseYolo
 ...
 ```
 
+**NOTE**: The **YOLOv7** resizes the input with center padding. To get better accuracy, use
+
+```
+maintain-aspect-ratio=1
+symmetric-padding=1
+```
+
 ##
 
 ### Edit the deepstream_app_config file
@@ -159,4 +166,6 @@ config-file=config_infer_primary_yoloV7.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.

docs/YOLOv8.md

@@ -131,6 +131,13 @@ parse-bbox-func-name=NvDsInferParseYolo
 ...
 ```
 
+**NOTE**: The **YOLOv8** resizes the input with center padding. To get better accuracy, use
+
+```
+maintain-aspect-ratio=1
+symmetric-padding=1
+```
+
 ##
 
 ### Edit the deepstream_app_config file
@@ -150,4 +157,6 @@ config-file=config_infer_primary_yoloV8.txt
 deepstream-app -c deepstream_app_config.txt
 ```
 
+**NOTE**: The TensorRT engine file may take a very long time to generate (sometimes more than 10 minutes).
+
 **NOTE**: For more information about custom models configuration (`batch-size`, `network-mode`, etc), please check the [`docs/customModels.md`](customModels.md) file.