Skip to content

Commit

Permalink
serve readme (#18)
Browse files Browse the repository at this point in the history 
* Update README.md

* Update README.md

* correct model links

* Update README.md

* Update README.md

* add gif

* Update README.md

* Update README.md
  • Loading branch information
@cxnt
cxnt authored Feb 15, 2022
1 parent 5a43cb1 commit 728a9c5
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 50 deletions.
79 changes: 69 additions & 10 deletions serve/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@

<div align="center" markdown>
<img src="https://i.imgur.com/wQEmCI5.jpg"/>
<img src="https://i.imgur.com/UbiaKsm.jpg"/>

# Serve MMSegmentation

<p align="center">
<a href="#Overview">Overview</a> •
<a href="#How-To-Run">How To Run</a> •
<a href="#How-To-Use">How To Use</a> •
<a href="#Common-apps">Common Apps</a> •
<a href="#Related-apps">Related Apps</a> •
<a href="#Acknowledgment">Acknowledgment</a>
</p>

Expand All @@ -26,31 +26,90 @@
Serve MMSegmentation model as Supervisely Application. MMSegmentation is an open source semantic segmentation toolbox based on PyTorch. Learn more about MMSegmentation and available models [here](https://github.com/open-mmlab/mmsegmentation).

Application key points:
- Select from 7 architectures and 40 pretrained models to serve
- Deployed on GPU or CPU
- Serve custom and MMSegmentation models
- Deployed on GPU

## Available models

Supported backbones:

- [x] ResNet (CVPR'2016)
- [x] ResNeXt (CVPR'2017)
- [x] [HRNet (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/hrnet)
- [x] [ResNeSt (ArXiv'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/resnest)
- [x] [MobileNetV2 (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/mobilenet_v2)
- [x] [MobileNetV3 (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/mobilenet_v3)
- [x] [Vision Transformer (ICLR'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/vit)
- [x] [Swin Transformer (ICCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/swin)
- [x] [Twins (NeurIPS'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/twins)

Supported methods:

- [x] [FCN (CVPR'2015/TPAMI'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fcn)
- [x] [ERFNet (T-ITS'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/erfnet)
- [x] [UNet (MICCAI'2016/Nat. Methods'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/unet)
- [x] [PSPNet (CVPR'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/pspnet)
- [x] [DeepLabV3 (ArXiv'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/deeplabv3)
- [x] [BiSeNetV1 (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/bisenetv1)
- [x] [PSANet (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/psanet)
- [x] [DeepLabV3+ (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/deeplabv3plus)
- [x] [UPerNet (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/upernet)
- [x] [ICNet (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/icnet)
- [x] [NonLocal Net (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/nonlocal_net)
- [x] [EncNet (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/encnet)
- [x] [Semantic FPN (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/sem_fpn)
- [x] [DANet (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/danet)
- [x] [APCNet (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/apcnet)
- [x] [EMANet (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/emanet)
- [x] [CCNet (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/ccnet)
- [x] [DMNet (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/dmnet)
- [x] [ANN (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/ann)
- [x] [GCNet (ICCVW'2019/TPAMI'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/gcnet)
- [x] [FastFCN (ArXiv'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fastfcn)
- [x] [Fast-SCNN (ArXiv'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fastscnn)
- [x] [ISANet (ArXiv'2019/IJCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/isanet)
- [x] [OCRNet (ECCV'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/ocrnet)
- [x] [DNLNet (ECCV'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/dnlnet)
- [x] [PointRend (CVPR'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/point_rend)
- [x] [CGNet (TIP'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/cgnet)
- [x] [BiSeNetV2 (IJCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/bisenetv2)
- [x] [STDC (CVPR'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/stdc)
- [x] [SETR (CVPR'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/setr)
- [x] [DPT (ArXiv'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/dpt)
- [x] [Segmenter (ICCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/segmenter)
- [x] [SegFormer (NeurIPS'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/segformer)


# How to Run

### 1. Add [Serve MMSegmentation](https://ecosystem.supervise.ly/apps/supervisely-ecosystem/mmsegmentation/serve) to your team
### 1. Add [Serve MMSegmentation](https://ecosystem.supervise.ly/apps/supervisely-ecosystem/mmsegmentation/serve) app to your team from Ecosystem
<img data-key="sly-module-link" data-module-slug="supervisely-ecosystem/mmsegmentation/serve" src="https://i.imgur.com/e1SsMJh.png" width="350px" style='padding-bottom: 10px'/>

### 2. Run the application from Plugins & Apps page
<img src="https://i.imgur.com/1uAKeeE.png" width="80%" style='padding-top: 10px'>

# How to Use

### 1. Select architecture, pretrained model, deploying device and press the **Serve** button
<img src="https://i.imgur.com/yEmmskW.png" width="80%">
## Pretrained models

### 1. Select architecture, pretrained model and press the **Serve** button

<img src="https://i.imgur.com/yEmmskW.png" style="width: 100%"/>


### 2. Wait for the model to deploy
<img src="https://i.imgur.com/FZeg5gT.png" width="80%">
<img src="https://i.imgur.com/FZeg5gT.png" width="100%">


## Custom models

### Model and directory structure must be acquired via [Train MMSegmentation](https://ecosystem.supervise.ly/apps/supervisely-ecosystem/mmsegmentation/train) app or manually created with the same directory structure

<img src="https://github.com/supervisely-ecosystem/mmsegmentation/releases/download/v0.0.1/custom_weights_guide-min.gif" style="width: 100%"/>

# Common apps
# Related apps

You can use served model in next Supervisely Applications ⬇️


- [Train MMSegmentation](https://ecosystem.supervise.ly/apps/supervisely-ecosystem/mmsegmentation/train) - app allows to play with different inference options, monitor metrics charts in real time, and save training artifacts to Team Files.

Expand Down
80 changes: 40 additions & 40 deletions train/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,49 +43,49 @@ Supported backbones:

- [x] ResNet (CVPR'2016)
- [x] ResNeXt (CVPR'2017)
- [x] [HRNet (CVPR'2019)](configs/hrnet)
- [x] [ResNeSt (ArXiv'2020)](configs/resnest)
- [x] [MobileNetV2 (CVPR'2018)](configs/mobilenet_v2)
- [x] [MobileNetV3 (ICCV'2019)](configs/mobilenet_v3)
- [x] [Vision Transformer (ICLR'2021)](configs/vit)
- [x] [Swin Transformer (ICCV'2021)](configs/swin)
- [x] [Twins (NeurIPS'2021)](configs/twins)
- [x] [HRNet (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/hrnet)
- [x] [ResNeSt (ArXiv'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/resnest)
- [x] [MobileNetV2 (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/mobilenet_v2)
- [x] [MobileNetV3 (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/mobilenet_v3)
- [x] [Vision Transformer (ICLR'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/vit)
- [x] [Swin Transformer (ICCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/swin)
- [x] [Twins (NeurIPS'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/twins)

Supported methods:

- [x] [FCN (CVPR'2015/TPAMI'2017)](configs/fcn)
- [x] [ERFNet (T-ITS'2017)](configs/erfnet)
- [x] [UNet (MICCAI'2016/Nat. Methods'2019)](configs/unet)
- [x] [PSPNet (CVPR'2017)](configs/pspnet)
- [x] [DeepLabV3 (ArXiv'2017)](configs/deeplabv3)
- [x] [BiSeNetV1 (ECCV'2018)](configs/bisenetv1)
- [x] [PSANet (ECCV'2018)](configs/psanet)
- [x] [DeepLabV3+ (CVPR'2018)](configs/deeplabv3plus)
- [x] [UPerNet (ECCV'2018)](configs/upernet)
- [x] [ICNet (ECCV'2018)](configs/icnet)
- [x] [NonLocal Net (CVPR'2018)](configs/nonlocal_net)
- [x] [EncNet (CVPR'2018)](configs/encnet)
- [x] [Semantic FPN (CVPR'2019)](configs/sem_fpn)
- [x] [DANet (CVPR'2019)](configs/danet)
- [x] [APCNet (CVPR'2019)](configs/apcnet)
- [x] [EMANet (ICCV'2019)](configs/emanet)
- [x] [CCNet (ICCV'2019)](configs/ccnet)
- [x] [DMNet (ICCV'2019)](configs/dmnet)
- [x] [ANN (ICCV'2019)](configs/ann)
- [x] [GCNet (ICCVW'2019/TPAMI'2020)](configs/gcnet)
- [x] [FastFCN (ArXiv'2019)](configs/fastfcn)
- [x] [Fast-SCNN (ArXiv'2019)](configs/fastscnn)
- [x] [ISANet (ArXiv'2019/IJCV'2021)](configs/isanet)
- [x] [OCRNet (ECCV'2020)](configs/ocrnet)
- [x] [DNLNet (ECCV'2020)](configs/dnlnet)
- [x] [PointRend (CVPR'2020)](configs/point_rend)
- [x] [CGNet (TIP'2020)](configs/cgnet)
- [x] [BiSeNetV2 (IJCV'2021)](configs/bisenetv2)
- [x] [STDC (CVPR'2021)](configs/stdc)
- [x] [SETR (CVPR'2021)](configs/setr)
- [x] [DPT (ArXiv'2021)](configs/dpt)
- [x] [Segmenter (ICCV'2021)](configs/segmenter)
- [x] [SegFormer (NeurIPS'2021)](configs/segformer)
- [x] [FCN (CVPR'2015/TPAMI'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fcn)
- [x] [ERFNet (T-ITS'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/erfnet)
- [x] [UNet (MICCAI'2016/Nat. Methods'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/unet)
- [x] [PSPNet (CVPR'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/pspnet)
- [x] [DeepLabV3 (ArXiv'2017)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/deeplabv3)
- [x] [BiSeNetV1 (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/bisenetv1)
- [x] [PSANet (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/psanet)
- [x] [DeepLabV3+ (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/deeplabv3plus)
- [x] [UPerNet (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/upernet)
- [x] [ICNet (ECCV'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/icnet)
- [x] [NonLocal Net (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/nonlocal_net)
- [x] [EncNet (CVPR'2018)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/encnet)
- [x] [Semantic FPN (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/sem_fpn)
- [x] [DANet (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/danet)
- [x] [APCNet (CVPR'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/apcnet)
- [x] [EMANet (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/emanet)
- [x] [CCNet (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/ccnet)
- [x] [DMNet (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/dmnet)
- [x] [ANN (ICCV'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/ann)
- [x] [GCNet (ICCVW'2019/TPAMI'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/gcnet)
- [x] [FastFCN (ArXiv'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fastfcn)
- [x] [Fast-SCNN (ArXiv'2019)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fastscnn)
- [x] [ISANet (ArXiv'2019/IJCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/isanet)
- [x] [OCRNet (ECCV'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/ocrnet)
- [x] [DNLNet (ECCV'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/dnlnet)
- [x] [PointRend (CVPR'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/point_rend)
- [x] [CGNet (TIP'2020)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/cgnet)
- [x] [BiSeNetV2 (IJCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/bisenetv2)
- [x] [STDC (CVPR'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/stdc)
- [x] [SETR (CVPR'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/setr)
- [x] [DPT (ArXiv'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/dpt)
- [x] [Segmenter (ICCV'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/segmenter)
- [x] [SegFormer (NeurIPS'2021)](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/segformer)


# How to Run
Expand Down

0 comments on commit 728a9c5

Please sign in to comment.