Python
Fast, modular reference implementation and easy training of Semantic Segmentation algorithms in PyTorch.

TorchSeg

This project aims at providing a fast, modular reference implementation for semantic segmentation models using PyTorch.

Highlights

• Modular Design: easily construct a customized semantic segmentation models by combining different components.
• Distributed Training: >60% faster than the multi-thread parallel method(nn.DataParallel), we use the multi-processing parallel method.
• Multi-GPU training and inference: support different manners of inference.
• Provides pre-trained models and implement different semantic segmentation models.

Prerequisites

• PyTorch 1.0
  • pip3 install torch torchvision
• Easydict
  • pip3 install easydict
• Apex
• Ninja
  • sudo apt-get install ninja-build
• tqdm
  • pip3 install tqdm

Model Zoo

Supported Model

• FCN
• DFN
• BiSeNet
• PSPNet

Performance and Benchmarks

SS:Single Scale MSF:Multi-scale + Flip

PASCAL VOC 2012

80.6¹: this result reported in paper is further finetuned on train dataset.

Cityscapes

Non-real-time Methods

BiSeNet(ours)¹: because we didn't pre-train the Xception39 model on ImageNet in PyTorch, we train this experiment from scratch. We will release the pre-trained Xception39 model in PyTorch and the corresponding experiment.

Real-time Methods

ADE

To Do

• release all trained models
• offer comprehensive documents
• support more semantic segmentation models
  • Deeplab v3 / Deeplab v3+
  • DenseASPP
  • PSANet
  • EncNet
  • OCNet

Training

1. create the config file of dataset:train.txt, val.txt, test.txt
   file structure：(split with tab)

   path-of-the-image   path-of-the-groundtruth
   

2. modify the config.py according to your requirements
3. train a network:

Distributed Training

We use the official torch.distributed.launch in order to launch multi-gpu training. This utility function from PyTorch spawns as many Python processes as the number of GPUs we want to use, and each Python process will only use a single GPU.

For each experiment, you can just run this script:

export NGPUS=8
python -m torch.distributed.launch --nproc_per_node=$NGPUS train.py

Non-distributed Training

The above performance are all conducted based on the non-distributed training. For each experiment, you can just run this script:

python train.py -d 0-7

the argument of d means the GPU you want to use.

Inference

In the evaluator, we have implemented the multi-gpu inference base on the multi-process. In the inference phase, the function will spawns as many Python processes as the number of GPUs we want to use, and each Python process will handle a subset of the whole evaluation dataset on a single GPU.

1. evaluate a trained network on the validation set:

   python3 eval.py

2. input arguments:

   usage: -e epoch_idx -d device_idx [--verbose ] 
   [--show_image] [--save_path Pred_Save_Path]

Disclaimer

This project is under active development. So things that are currently working might break in a future release. However, feel free to open issue if you get stuck anywhere.

Citation

The following are BibTeX references. The BibTeX entry requires the url LaTeX package.

Please consider citing this project in your publications if it helps your research.

@misc{torchseg2019,
  author =       {Yu, Changqian},
  title =        {TorchSeg},
  howpublished = {\url{https://github.com/ycszen/TorchSeg}},
  year =         {2019}
}

Please consider citing the DFN in your publications if it helps your research.

@article{yu2018dfn,
  title={Learning a Discriminative Feature Network for Semantic Segmentation},
  author={Yu, Changqian and Wang, Jingbo and Peng, Chao and Gao, Changxin and Yu, Gang and Sang, Nong},
  journal={arXiv preprint arXiv:1804.09337},
  year={2018}
}

Please consider citing the BiSeNet in your publications if it helps your research.

@inproceedings{yu2018bisenet,
  title={Bisenet: Bilateral segmentation network for real-time semantic segmentation},
  author={Yu, Changqian and Wang, Jingbo and Peng, Chao and Gao, Changxin and Yu, Gang and Sang, Nong},
  booktitle={European Conference on Computer Vision},
  pages={334--349},
  year={2018},
  organization={Springer}
}

Why this name, Furnace?

Furnace means the Alchemical Furnace. We all are the Alchemist, so I hope everyone can have a good alchemical furnace to practice the Alchemy. Hope you can be a excellent alchemist.