README_EN.md

English | 简体中文

A High-Efficient Development Toolkit for Image Segmentation based on PaddlePaddle.

News

• [2022-11-30] 🔥 PaddleSeg v2.7 is released! More details in Release Notes.
• Release PP-MattingV2, a real-time human matting model with SOTA performance. Compared to previous models, the mean error is reduced by 17.91%, the inference speed is accelerated by 44.6% on GPU.
• Release MedicalSegV2, a superior 3D medical image segmentation solution, including an intelligent annotation toolkit called EISeg-Med3D, several state-of-the-art models and an optimized nnUNet-D with high performance.
• Release RTFormer, a real-time semantic segmentation model accepted by NeurIPS 2022. RTFormer combines the advantages of CNN and Transformer modules, and it achieves SOTA trade-off between performance and efficiency on several datasets.
• [2022-07-20] PaddleSeg v2.6 released a real-time human segmentation SOTA solution PP-HumanSegV2, a stable-version semi-automatic segmentation annotation EISeg v1.0, a pseudo label pre-training method PSSL and the source code of PP-MattingV1.
• [2022-04-20] PaddleSeg v2.5 released a real-time semantic segmentation model PP-LiteSeg, a trimap-free image matting model PP-MattingV1, and an easy-to-use solution for 3D medical image segmentation MedicalSegV1.
• [2022-01-20] We release PaddleSeg v2.4 with EISeg v0.4, and PP-HumanSegV1 including open-sourced dataset PP-HumanSeg14K.

Introduction

PaddleSeg is an end-to-end high-efficent development toolkit for image segmentation based on PaddlePaddle, which helps both developers and researchers in the whole process of designing segmentation models, training models, optimizing performance and inference speed, and deploying models. A lot of well-trained models and various real-world applications in both industry and academia help users conveniently build hands-on experiences in image segmentation.

Features

• High-Performance Model: Following the state of the art segmentation methods and use the high-performance backbone, we provide 40+ models and 140+ high-quality pre-training models, which are better than other open-source implementations.

• High Efficiency: PaddleSeg provides multi-process asynchronous I/O, multi-card parallel training, evaluation, and other acceleration strategies, combined with the memory optimization function of the PaddlePaddle, which can greatly reduce the training overhead of the segmentation model, all this allowing developers to lower cost and more efficiently train image segmentation model.

• Modular Design: We desigin PaddleSeg with the modular design philosophy. Therefore, based on actual application scenarios, developers can assemble diversified training configurations with data enhancement strategies, segmentation models, backbone networks, loss functions and other different components to meet different performance and accuracy requirements.

• Complete Flow: PaddleSeg support image labeling, model designing, model training, model compression and model deployment. With the help of PaddleSeg, developers can easily finish all taskes.

Community

• If you have any questions, suggestions and feature requests, please create an issues in GitHub Issues.
• Welcome to scan the following QR code and join paddleseg wechat group to communicate with us.

Overview

Models	Components		Special Cases
Semantic Segmentation PP-LiteSeg DeepLabV3P OCRNet MobileSeg ANN Att U-Net BiSeNetV1 BiSeNetV2 CCNet DANet DDRNet DecoupledSeg DeepLabV3 DMNet DNLNet EMANet ENCNet ENet ESPNetV1 ESPNetV2 FastFCN Fast-SCNN GCNet GINet GloRe GSCNN HarDNet HRNet-FCN HRNet-Contrast ISANet PFPNNet PointRend PotraitNet PP-HumanSeg-Lite PSPNet PSSL SegFormer SegMenter SegNet SETR SFNet STDCSeg U2Net UNet UNet++ UNet3+ UperNet RTFormer UHRNet TopFormer MscaleOCRNet-PSA Interactive Segmentation EISeg RITM EdgeFlow Image Matting PP-MattingV2 PP-MattingV1 DIM MODNet PP-HumanMatting Panoptic Segmentation Panoptic-DeepLab	Backbones HRNet ResNet STDCNet MobileNetV2 MobileNetV3 ShuffleNetV2 GhostNet LiteHRNet XCeption VIT MixVIT Swin Transformer Losses Binary CE Loss Bootstrapped CE Loss Cross Entropy Loss Relax Boundary Loss Detail Aggregate Loss Dice Loss Edge Attention Loss Focal Loss MultiClassFocal Loss GSCNN Dual Task Loss KL Loss L1 Loss Lovasz Loss MSE Loss OHEM CE Loss Pixel Contrast CE Loss Point CE Loss RMI Loss Connectivity Loss Metrics mIoU Accuracy Kappa Dice AUC_ROC	Datasets ADE20K Cityscapes COCO Stuff Pascal VOC EG1800 Pascal Context SUPERVISELY OPTIC DISC SEG CHASE_DB1 HRF DRIVE STARE PP-HumanSeg14K PSSL Data Augmentation Flipping Resize ResizeByLong ResizeByShort LimitLong ResizeRangeScaling ResizeStepScaling Normalize Padding PaddingByAspectRatio RandomPaddingCrop RandomCenterCrop ScalePadding RandomNoise RandomBlur RandomRotation RandomScaleAspect RandomDistort RandomAffine	Model Selection Tool PaddleSMRT Human Segmentation PP-HumanSegV1 PP-HumanSegV2 MedicalSeg VNet UNETR nnFormer nnUNet-D TransUNet SwinUNet Cityscapes SOTA Model HMSA CVPR Champion Model MLA Transformer Domain Adaptation PixMatch

Industrial Segmentation Models

High Accuracy Semantic Segmentation Models

These models have good performance and costly inference time, so they are designed for GPU and Jetson devices.

Model	Backbone	Cityscapes mIoU(%)	V100 TRT Inference Speed(FPS)	Config File
FCN	HRNet_W18	78.97	24.43	yml
FCN	HRNet_W48	80.70	10.16	yml
DeepLabV3	ResNet50_OS8	79.90	4.56	yml
DeepLabV3	ResNet101_OS8	80.85	3.2	yml
DeepLabV3	ResNet50_OS8	80.36	6.58	yml
DeepLabV3	ResNet101_OS8	81.10	3.94	yml
OCRNet 🌟	HRNet_w18	80.67	13.26	yml
OCRNet	HRNet_w48	82.15	6.17	yml
CCNet	ResNet101_OS8	80.95	3.24	yml

Note that:

• Test the inference speed on Nvidia GPU V100: use PaddleInference Python API, enable TensorRT, the data type is FP32, the dimension of input is 1x3x1024x2048.

Lightweight Semantic Segmentation Models

The segmentation accuracy and inference speed of these models are medium. They can be deployed on GPU, X86 CPU and ARM CPU.

Model	Backbone	Cityscapes mIoU(%)	V100 TRT Inference Speed(FPS)	Snapdragon 855 Inference Speed(FPS)	Config File
PP-LiteSeg 🌟	STDC1	77.04	69.82	17.22	yml
PP-LiteSeg 🌟	STDC2	79.04	54.53	11.75	yml
BiSeNetV1	-	75.19	14.67	1.53	yml
BiSeNetV2	-	73.19	61.83	13.67	yml
STDCSeg	STDC1	74.74	62.24	14.51	yml
STDCSeg	STDC2	77.60	51.15	10.95	yml
DDRNet_23	-	79.85	42.64	7.68	yml
HarDNet	-	79.03	30.3	5.44	yml
SFNet	ResNet18_OS8	78.72	10.72	-	yml

Note that:

• Test the inference speed on Nvidia GPU V100: use PaddleInference Python API, enable TensorRT, the data type is FP32, the dimension of input is 1x3x1024x2048.
• Test the inference speed on Snapdragon 855: use PaddleLite CPP API, 1 thread, the dimension of input is 1x3x256x256.

Super Lightweight Semantic Segmentation Models

These super lightweight semantic segmentation models are designed for X86 CPU and ARM CPU.

Model	Backbone	Cityscapes mIoU(%)	V100 TRT Inference Speed(FPS)	Snapdragon 855 Inference Speed(FPS)	Config File
MobileSeg	MobileNetV2	73.94	67.57	27.01	yml
MobileSeg 🌟	MobileNetV3	73.47	67.39	32.90	yml
MobileSeg	Lite_HRNet_18	70.75	10.5	13.05	yml
MobileSeg	ShuffleNetV2_x1_0	69.46	37.09	39.61	yml
MobileSeg	GhostNet_x1_0	71.88	35.58	38.74	yml

Note that:

• Test the inference speed on Nvidia GPU V100: use PaddleInference Python API, enable TensorRT, the data type is FP32, the dimension of input is 1x3x1024x2048.
• Test the inference speed on Snapdragon 855: use PaddleLite CPP API, 1 thread, the dimension of input is 1x3x256x256.

Tutorials

Introductory Tutorials

• Installation
• Quick Start
• A 20 minutes Blitz to Learn PaddleSeg
• Model Zoo

Basic Tutorials

• Data Preparation

  • Prepare Public Dataset
  • Prepare Customized Dataset
  • Label Data with EISeg

• Config Preparation

• Model Training

• Model Evaluation

• Model Prediction

• Model Export

  • Export Inference Model
  • Export ONNX Model

• Model Deploy

  • Paddle Inference (Python)
  • Paddle Inference (C++)
  • Paddle Lite
  • Paddle Serving
  • Paddle JS
  • Benchmark

Advanced Tutorials

• Training Tricks

• Model Compression

  • Quantization
  • Distillation
  • Prune

• FAQ

Welcome to Contribute

• API Documention

• Advanced Development

  • Detailed Configuration File
  • Create Your Own Model

• Pull Request

  • PR Tutorial
  • PR Style

Special Features

• Interactive Segmentation
• Image Matting
• PP-HumanSeg
• 3D Medical Segmentation
• Cityscapes SOTA
• Panoptic Segmentation
• CVPR Champion Solution
• Domain Adaptation

Industrial Tutorial Examples

• Using PP-HumanSegV2 for Human Segmentation
• Using PP-HumanSegV1 for Human Segmentation
• Using PP-LiteSeg for Road Segmentation
• Using PaddleSeg for Mini-dataset Spine Segmentation
• Using PaddleSeg for Lane Segmentation
• PaddleSeg in APIs
• Learn Paddleseg in 10 Mins

License

PaddleSeg is released under the Apache 2.0 license.

Acknowledgement

• Thanks jm12138 for contributing U²-Net.
• Thanks zjhellofss (Fu Shenshen) for contributing Attention U-Net, and Dice Loss.
• Thanks liuguoyu666, geoyee for contributing U-Net++ and U-Net3+.
• Thanks yazheng0307 (LIU Zheng) for contributing quick-start document.
• Thanks CuberrChen for contributing STDC(rethink BiSeNet), PointRend and DetailAggregateLoss.
• Thanks stuartchen1949 for contributing SegNet.
• Thanks justld (Lang Du) for contributing UPerNet, DDRNet, CCNet, ESPNetV2, DMNet, ENCNet, HRNet_W48_Contrast, FastFCN, BiSeNetV1, SECrossEntropyLoss and PixelContrastCrossEntropyLoss.
• Thanks Herman-Hu-saber (Hu Huiming) for contributing ESPNetV2.
• Thanks zhangjin12138 for contributing RandomCenterCrop.
• Thanks simuler for contributing ESPNetV1.
• Thanks ETTR123(Zhang Kai) for contributing ENet, PFPNNet.

Citation

If you find our project useful in your research, please consider citing:

@misc{liu2021paddleseg,
      title={PaddleSeg: A High-Efficient Development Toolkit for Image Segmentation},
      author={Yi Liu and Lutao Chu and Guowei Chen and Zewu Wu and Zeyu Chen and Baohua Lai and Yuying Hao},
      year={2021},
      eprint={2101.06175},
      archivePrefix={arXiv},
      primaryClass={cs.CV}
}

@misc{paddleseg2019,
    title={PaddleSeg, End-to-end image segmentation kit based on PaddlePaddle},
    author={PaddlePaddle Contributors},
    howpublished = {\url{https://github.com/PaddlePaddle/PaddleSeg}},
    year={2019}
}