[简体中文](object_detection.md) | English # Tutorial on Developing Object Detection Modules ## I. Overview The object detection module is a crucial component in computer vision systems, responsible for locating and marking regions containing specific objects in images or videos. The performance of this module directly impacts the accuracy and efficiency of the entire computer vision system. The object detection module typically outputs bounding boxes for the target regions, which are then passed as input to the object recognition module for further processing. ## II. List of Supported Models
👉Details of Model List
Model mAP(%) GPU Inference Time (ms) CPU Inference Time (ms) Model Size (M) Description
Cascade-FasterRCNN-ResNet50-FPN 41.1 - - 245.4 M Cascade-FasterRCNN is an improved version of the Faster R-CNN object detection model. By coupling multiple detectors and optimizing detection results using different IoU thresholds, it addresses the mismatch problem between training and prediction stages, enhancing the accuracy of object detection.
Cascade-FasterRCNN-ResNet50-vd-SSLDv2-FPN 45.0 - - 246.2 M
CenterNet-DLA-34 37.6 - - 75.4 M CenterNet is an anchor-free object detection model that treats the keypoints of the object to be detected as a single point—the center point of its bounding box, and performs regression through these keypoints.
CenterNet-ResNet50 38.9 - - 319.7 M
DETR-R50 42.3 59.2132 5334.52 159.3 M DETR is a transformer-based object detection model proposed by Facebook. It achieves end-to-end object detection without the need for predefined anchor boxes or NMS post-processing strategies.
FasterRCNN-ResNet34-FPN 37.8 - - 137.5 M Faster R-CNN is a typical two-stage object detection model that first generates region proposals and then performs classification and regression on these proposals. Compared to its predecessors R-CNN and Fast R-CNN, Faster R-CNN's main improvement lies in the region proposal aspect, using a Region Proposal Network (RPN) to provide region proposals instead of traditional selective search. RPN is a Convolutional Neural Network (CNN) that shares convolutional features with the detection network, reducing the computational overhead of region proposals.
FasterRCNN-ResNet50-FPN 38.4 - - 148.1 M
FasterRCNN-ResNet50-vd-FPN 39.5 - - 148.1 M
FasterRCNN-ResNet50-vd-SSLDv2-FPN 41.4 - - 148.1 M
FasterRCNN-ResNet50 36.7 - - 120.2 M
FasterRCNN-ResNet101-FPN 41.4 - - 216.3 M
FasterRCNN-ResNet101 39.0 - - 188.1 M
FasterRCNN-ResNeXt101-vd-FPN 43.4 - - 360.6 M
FasterRCNN-Swin-Tiny-FPN 42.6 - - 159.8 M
FCOS-ResNet50 39.6 103.367 3424.91 124.2 M FCOS is an anchor-free object detection model that performs dense predictions. It uses the backbone of RetinaNet and directly regresses the width and height of the target object on the feature map, predicting the object's category and centerness (the degree of offset of pixels on the feature map from the object's center), which is eventually used as a weight to adjust the object score.
PicoDet-L 42.6 16.6715 169.904 20.9 M PP-PicoDet is a lightweight object detection algorithm designed for full-size and wide-aspect-ratio targets, with a focus on mobile device computation. Compared to traditional object detection algorithms, PP-PicoDet boasts smaller model sizes and lower computational complexity, achieving higher speeds and lower latency while maintaining detection accuracy.
PicoDet-M 37.5 16.2311 71.7257 16.8 M
PicoDet-S 29.1 14.097 37.6563 4.4 M
PicoDet-XS 26.2 13.8102 48.3139 5.7 M
PP-YOLOE_plus-L 52.9 33.5644 814.825 185.3 M PP-YOLOE_plus is an iteratively optimized and upgraded version of PP-YOLOE, a high-precision cloud-edge integrated model developed by Baidu PaddlePaddle's Vision Team. By leveraging the large-scale Objects365 dataset and optimizing preprocessing, it significantly enhances the end-to-end inference speed of the model.
PP-YOLOE_plus-M 49.8 19.843 449.261 82.3 M
PP-YOLOE_plus-S 43.7 16.8884 223.059 28.3 M
PP-YOLOE_plus-X 54.7 57.8995 1439.93 349.4 M
RT-DETR-H 56.3 114.814 3933.39 435.8 M RT-DETR is the first real-time end-to-end object detector. It features an efficient hybrid encoder that balances model performance and throughput, efficiently processes multi-scale features, and introduces an accelerated and optimized query selection mechanism to dynamize decoder queries. RT-DETR supports flexible end-to-end inference speeds through the use of different decoders.
RT-DETR-L 53.0 34.5252 1454.27 113.7 M
RT-DETR-R18 46.5 19.89 784.824 70.7 M
RT-DETR-R50 53.1 41.9327 1625.95 149.1 M
RT-DETR-X 54.8 61.8042 2246.64 232.9 M
YOLOv3-DarkNet53 39.1 40.1055 883.041 219.7 M YOLOv3 is a real-time end-to-end object detector that utilizes a unique single Convolutional Neural Network (CNN) to frame the object detection problem as a regression task, enabling real-time detection. The model employs multi-scale detection to enhance performance across different object sizes.
YOLOv3-MobileNetV3 31.4 18.6692 267.214 83.8 M
YOLOv3-ResNet50_vd_DCN 40.6 31.6276 856.047 163.0 M
YOLOX-L 50.1 185.691 1250.58 192.5 M Building upon YOLOv3's framework, YOLOX significantly boosts detection performance in complex scenarios by incorporating Decoupled Head, Data Augmentation, Anchor Free, and SimOTA components.
YOLOX-M 46.9 123.324 688.071 90.0 M
YOLOX-N 26.1 79.1665 155.59 3.4 M
YOLOX-S 40.4 184.828 474.446 32.0 M
YOLOX-T 32.9 102.748 212.52 18.1 M
YOLOX-X 51.8 227.361 2067.84 351.5 M
**Note: The precision metrics mentioned are based on the [COCO2017](https://cocodataset.org/#home) validation set mAP(0.5:0.95). All model GPU inference times are measured on an NVIDIA Tesla T4 machine with FP32 precision. CPU inference speeds are based on an Intel(R) Xeon(R) Gold 5117 CPU @ 2.00GHz with 8 threads and FP32 precision.**
## III. Quick Integration > ❗ Before proceeding with quick integration, please install the PaddleX wheel package. For detailed instructions, refer to the [PaddleX Local Installation Guide](../../../installation/installation_en.md). After installing the wheel package, you can perform object detection inference with just a few lines of code. You can easily switch between models within the module and integrate the object detection inference into your projects. Before running the following code, please download the [demo image](https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png) to your local machine. ```python from paddlex import create_model model = create_model("PicoDet-S") output = model.predict("general_object_detection_002.png", batch_size=1) for res in output: res.print(json_format=False) res.save_to_img("./output/") res.save_to_json("./output/res.json") ``` For more information on using PaddleX's single-model inference APIs, refer to the [PaddleX Single Model Python Script Usage Instructions](../../instructions/model_python_API_en.md). ## IV. Custom Development If you seek higher precision from existing models, you can leverage PaddleX's custom development capabilities to develop better object detection models. Before developing object detection models with PaddleX, ensure you have installed the object detection related training plugins. For installation instructions, refer to the [PaddleX Local Installation Guide](../../../installation/installation_en.md). ### 4.1 Data Preparation Before model training, prepare the corresponding dataset for the task module. PaddleX provides a data validation feature for each module, and **only datasets that pass validation can be used for model training**. Additionally, PaddleX provides demo datasets for each module, which you can use to complete subsequent development. If you wish to use a private dataset for model training, refer to the [PaddleX Object Detection Task Module Data Annotation Guide](../../../data_annotations/cv_modules/object_detection_en.md). #### 4.1.1 Download Demo Data You can download the demo dataset to a specified folder using the following command: ```bash wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/det_coco_examples.tar -P ./dataset tar -xf ./dataset/det_coco_examples.tar -C ./dataset/ ``` #### 4.1.2 Data Validation Validate your dataset with a single command: ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=check_dataset \ -o Global.dataset_dir=./dataset/det_coco_examples ``` After executing the above command, PaddleX will validate the dataset and summarize its basic information. If the command runs successfully, it will print `Check dataset passed !` in the log. The validation results file is saved in `./output/check_dataset_result.json`, and related outputs are saved in the `./output/check_dataset` directory in the current directory, including visual examples of sample images and sample distribution histograms.
👉 Details of Validation Results (Click to Expand) The specific content of the validation result file is: ```bash { "done_flag": true, "check_pass": true, "attributes": { "num_classes": 4, "train_samples": 701, "train_sample_paths": [ "check_dataset/demo_img/road839.png", "check_dataset/demo_img/road363.png", "check_dataset/demo_img/road148.png", "check_dataset/demo_img/road237.png", "check_dataset/demo_img/road733.png", "check_dataset/demo_img/road861.png", "check_dataset/demo_img/road762.png", "check_dataset/demo_img/road515.png", "check_dataset/demo_img/road754.png", "check_dataset/demo_img/road173.png" ], "val_samples": 176, "val_sample_paths": [ "check_dataset/demo_img/road218.png", "check_dataset/demo_img/road681.png", "check_dataset/demo_img/road138.png", "check_dataset/demo_img/road544.png", "check_dataset/demo_img/road596.png", "check_dataset/demo_img/road857.png", "check_dataset/demo_img/road203.png", "check_dataset/demo_img/road589.png", "check_dataset/demo_img/road655.png", "check_dataset/demo_img/road245.png" ] }, "analysis": { "histogram": "check_dataset/histogram.png" }, "dataset_path": "./dataset/det_coco_examples", "show_type": "image", "dataset_type": "COCODetDataset" } ``` In the above validation results, `check_pass` being True indicates that the dataset format meets the requirements. Explanations for other indicators are as follows: * `attributes.num_classes`: The number of classes in this dataset is 4; * `attributes.train_samples`: The number of training samples in this dataset is 704; * `attributes.val_samples`: The number of validation samples in this dataset is 176; * `attributes.train_sample_paths`: A list of relative paths to the visualization images of training samples in this dataset; * `attributes.val_sample_paths`: A list of relative paths to the visualization images of validation samples in this dataset; Additionally, the dataset verification also analyzes the distribution of sample numbers across all classes in the dataset and generates a histogram (histogram.png) for visualization: ![](https://raw.githubusercontent.com/cuicheng01/PaddleX_doc_images/main/images/modules/obj_det/01.png)
### 4.1.3 Dataset Format Conversion / Dataset Splitting (Optional) After completing data validation, you can convert the dataset format and re-split the training/validation ratio by **modifying the configuration file** or **appending hyperparameters**.
👉 Details of Format Conversion / Dataset Splitting (Click to Expand) **(1) Dataset Format Conversion** Object detection supports converting datasets in `VOC` and `LabelMe` formats to `COCO` format. Parameters related to dataset validation can be set by modifying the fields under `CheckDataset` in the configuration file. Examples of some parameters in the configuration file are as follows: * `CheckDataset`: * `convert`: * `enable`: Whether to perform dataset format conversion. Object detection supports converting `VOC` and `LabelMe` format datasets to `COCO` format. Default is `False`; * `src_dataset_type`: If dataset format conversion is performed, the source dataset format needs to be set. Default is `null`, with optional values `VOC`, `LabelMe`, `VOCWithUnlabeled`, `LabelMeWithUnlabeled`; For example, if you want to convert a `LabelMe` format dataset to `COCO` format, taking the following `LabelMe` format dataset as an example, you need to modify the configuration as follows: ```bash cd /path/to/paddlex wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/det_labelme_examples.tar -P ./dataset tar -xf ./dataset/det_labelme_examples.tar -C ./dataset/ ``` ```bash ...... CheckDataset: ...... convert: enable: True src_dataset_type: LabelMe ...... ``` Then execute the command: ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=check_dataset \ -o Global.dataset_dir=./dataset/det_labelme_examples ``` Of course, the above parameters also support being set by appending command line arguments. Taking a `LabelMe` format dataset as an example: ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=check_dataset \ -o Global.dataset_dir=./dataset/det_labelme_examples \ -o CheckDataset.convert.enable=True \ -o CheckDataset.convert.src_dataset_type=LabelMe ``` **(2) Dataset Splitting** Parameters for dataset splitting can be set by modifying the fields under `CheckDataset` in the configuration file. Examples of some parameters in the configuration file are as follows: * `CheckDataset`: * `split`: * `enable`: Whether to re-split the dataset. When `True`, dataset splitting is performed. Default is `False`; * `train_percent`: If the dataset is re-split, the percentage of the training set needs to be set. The type is any integer between 0-100, and it needs to ensure that the sum with `val_percent` is 100; * `val_percent`: If the dataset is re-split, the percentage of the validation set needs to be set. The type is any integer between 0-100, and it needs to ensure that the sum with `train_percent` is 100; For example, if you want to re-split the dataset with a 90% training set and a 10% validation set, you need to modify the configuration file as follows: ```bash ...... CheckDataset: ...... split: enable: True train_percent: 90 val_percent: 10 ...... ``` Then execute the command: ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=check_dataset \ -o Global.dataset_dir=./dataset/det_coco_examples ``` After dataset splitting is executed, the original annotation files will be renamed to `xxx.bak` in the original path. The above parameters also support being set by appending command line arguments: ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=check_dataset \ -o Global.dataset_dir=./dataset/det_coco_examples \ -o CheckDataset.split.enable=True \ -o CheckDataset.split.train_percent=90 \ -o CheckDataset.split.val_percent=10 ```
### 4.2 Model Training Model training can be completed with a single command, taking the training of the object detection model PicoDet-S as an example: ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=train \ -o Global.dataset_dir=./dataset/det_coco_examples ``` The following steps are required: * Specify the `.yaml` configuration file path for the model (here it is `PicoDet-S.yaml`) * Set the mode to model training: `-o Global.mode=train` * Specify the path to the training dataset: `-o Global.dataset_dir`. Other related parameters can be set by modifying the `Global` and `Train` fields in the `.yaml` configuration file, or adjusted by appending parameters in the command line. For example, to specify training on the first two GPUs: `-o Global.device=gpu:0,1`; to set the number of training epochs to 10: `-o Train.epochs_iters=10`. For more modifiable parameters and their detailed explanations, refer to the configuration file instructions for the corresponding task module of the model [PaddleX Common Configuration File Parameters](../../instructions/config_parameters_common_en.md).
👉 More Details (Click to Expand) * During model training, PaddleX automatically saves the model weight files, with the default being `output`. If you need to specify a save path, you can set it through the `-o Global.output` field in the configuration file. * PaddleX shields you from the concepts of dynamic graph weights and static graph weights. During model training, both dynamic and static graph weights are produced, and static graph weights are selected by default for model inference. * When training other models, you need to specify the corresponding configuration file. The correspondence between models and configuration files can be found in [PaddleX Model List (CPU/GPU)](../../../support_list/models_list_en.md). After completing the model training, all outputs are saved in the specified output directory (default is `./output/`), typically including: * `train_result.json`: Training result record file, recording whether the training task was completed normally, as well as the output weight metrics, related file paths, etc.; * `train.log`: Training log file, recording changes in model metrics and loss during training; * `config.yaml`: Training configuration file, recording the hyperparameter configuration for this training session; * `.pdparams`, `.pdema`, `.pdopt.pdstate`, `.pdiparams`, `.pdmodel`: Model weight-related files, including network parameters, optimizer, EMA, static graph network parameters, static graph network structure, etc.;
## **4.3 Model Evaluation** After completing model training, you can evaluate the specified model weights file on the validation set to verify the model's accuracy. Using PaddleX for model evaluation can be done with a single command: ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=evaluate \ -o Global.dataset_dir=./dataset/det_coco_examples ``` Similar to model training, the following steps are required: * Specify the `.yaml` configuration file path for the model (here it is `PicoDet-S.yaml`) * Specify the mode as model evaluation: `-o Global.mode=evaluate` * Specify the path to the validation dataset: `-o Global.dataset_dir`. Other related parameters can be set by modifying the `Global` and `Evaluate` fields in the `.yaml` configuration file. For details, refer to [PaddleX Common Model Configuration File Parameter Description](../../instructions/config_parameters_common_en.md).
👉 More Details (Click to Expand) When evaluating the model, you need to specify the model weights file path. Each configuration file has a default weight save path built-in. If you need to change it, simply set it by appending a command line parameter, such as `-o Evaluate.weight_path=./output/best_model/best_model.pdparams`. After completing the model evaluation, an `evaluate_result.json` file will be generated, which records the evaluation results, specifically whether the evaluation task was completed successfully and the model's evaluation metrics, including AP.
### **4.4 Model Inference and Integration** After completing model training and evaluation, you can use the trained model weights for inference predictions or Python integration. #### 4.4.1 Model Inference * To perform inference predictions through the command line, use the following command. Before running the following code, please download the [demo image](https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_object_detection_002.png) to your local machine. ```bash python main.py -c paddlex/configs/object_detection/PicoDet-S.yaml \ -o Global.mode=predict \ -o Predict.model_dir="./output/best_model/inference" \ -o Predict.input="general_object_detection_002.png" ``` Similar to model training and evaluation, the following steps are required: * Specify the `.yaml` configuration file path for the model (here it is `PicoDet-S.yaml`) * Specify the mode as model inference prediction: `-o Global.mode=predict` * Specify the model weights path: `-o Predict.model_dir="./output/best_model/inference"` * Specify the input data path: `-o Predict.input="..."` Other related parameters can be set by modifying the `Global` and `Predict` fields in the `.yaml` configuration file. For details, refer to [PaddleX Common Model Configuration File Parameter Description](../../instructions/config_parameters_common_en.md). #### 4.4.2 Model Integration The model can be directly integrated into the PaddleX pipelines or directly into your own project. 1.**Pipeline Integration** The object detection module can be integrated into the [General Object Detection Pipeline](../../../pipeline_usage/tutorials/cv_pipelines/object_detection_en.md) of PaddleX. Simply replace the model path to update the object detection module of the relevant pipeline. In pipeline integration, you can use high-performance inference and service-oriented deployment to deploy your model. 2.**Module Integration** The weights you produce can be directly integrated into the object detection module. Refer to the Python example code in [Quick Integration](#iii-quick-integration), and simply replace the model with the path to your trained model.