Skip to content

Commit

Permalink
[Docs]Add a support model list. (open-mmlab#333)
Browse files Browse the repository at this point in the history
* add docs about support model

* fix docs

* fix support list

* fix docs

* fix format

* fix how to convert model

* fix en and cn docs about convert model

* fix bash

* fix docs format

* fix readme

* fix benchmark

* fix cn docs link

* rename support models

* rename

* fix docs

* fix cn benchmark

* fix benchmark
  • Loading branch information
VVsssssk committed Dec 24, 2021
1 parent 02e033b commit 15bdafe
Show file tree
Hide file tree
Showing 11 changed files with 158 additions and 87 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Please refer to [FAQ](docs/en/faq.md) for frequently asked questions.

## Benchmark and model zoo

Results and supported model list are available in the [benchmark](docs/en/benchmark.md) and [model list](docs/en/tutorials/how_to_convert_model.md).
Results and supported model list are available in the [benchmark](docs/en/benchmark.md) and [model list](docs/en/supported_models.md).

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ MMDeploy 是一个开源深度学习模型部署工具箱,它是 [OpenMMLab](h

## 基准与模型库

基准和支持的模型列表可以在[基准](docs/zh_cn/benchmark.md)[模型列表](docs/zh_cn/tutorials/how_to_convert_model.md)中获得。
基准和支持的模型列表可以在[基准](docs/zh_cn/benchmark.md)[模型列表](docs/en/supported_models.md)中获得。

## 贡献指南

Expand Down
16 changes: 15 additions & 1 deletion docs/en/benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,20 @@ Users can directly test the performance through [how_to_evaluate_a_model.md](tut
<td align="center">-</td>
<td>$MMDET_DIR/configs/atss/atss_r50_fpn_1x_coco.py</td>
</tr>
<tr>
<td align="center">Cascade R-CNN</td>
<td align="center">Object Detection</td>
<td align="center">COCO2017</td>
<td align="center">box AP</td>
<td align="center">40.4</td>
<td align="center">-</td>
<td align="center">40.4</td>
<td align="center">40.4</td>
<td align="center">-</td>
<td align="center">40.4</td>
<td align="center">-</td>
<td>$MMDET_DIR/configs/cascade_rcnn/cascade_rcnn_r50_caffe_fpn_1x_coco.py</td>
</tr>
<tr>
<td align="center" rowspan="2">Mask R-CNN</td>
<td align="center" rowspan="2">Instance Segmentation</td>
Expand All @@ -878,7 +892,7 @@ Users can directly test the performance through [how_to_evaluate_a_model.md](tut
<td align="center">-</td>
<td align="center">38.0</td>
<td align="center">-</td>
<td align="center" rowspan="2">$MMDET_DIR/configs/mask_rcnn/mask_rcnn_r50_fpn_1x_coco.py</td>
<td rowspan="2">$MMDET_DIR/configs/mask_rcnn/mask_rcnn_r50_fpn_1x_coco.py</td>
</tr>
<tr>
<td align="center">mask AP</td>
Expand Down
10 changes: 5 additions & 5 deletions docs/en/codebases/mmocr.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Please refer to [install.md](https://mmocr.readthedocs.io/en/latest/install.html

### List of MMOCR models supported by MMDeploy

| model | task | OnnxRuntime | TensorRT | NCNN | PPLNN | OpenVINO | model config file(example) |
|-------|:----------------:|:-----------:|:--------:|:----:|:---:|:--------:|---------------------------------------------------------------------------|
| DBNet | text-detection | Y | Y | Y | Y | Y | $PATH_TO_MMOCR/configs/textdet/dbnet/dbnet_r18_fpnc_1200e_icdar2015.py |
| CRNN | text-recognition | Y | Y | Y | Y | N | $PATH_TO_MMOCR/configs/textrecog/crnn/crnn_academic_dataset.py |
| SAR | text-recognition | Y | N | N | N | N | $PATH_TO_MMOCR/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py |
| model | task | OnnxRuntime | TensorRT | NCNN | PPLNN | OpenVINO | model config file(example) |
| :---- | :--------------- | :---------: | :------: | :---: | :---: | :------: | :------------------------------------------------------------------------ |
| DBNet | text-detection | Y | Y | Y | Y | Y | $PATH_TO_MMOCR/configs/textdet/dbnet/dbnet_r18_fpnc_1200e_icdar2015.py |
| CRNN | text-recognition | Y | Y | Y | Y | N | $PATH_TO_MMOCR/configs/textrecog/crnn/crnn_academic_dataset.py |
| SAR | text-recognition | Y | N | N | N | N | $PATH_TO_MMOCR/configs/textrecog/sar/sar_r31_parallel_decoder_academic.py |


### Reminder
Expand Down
14 changes: 7 additions & 7 deletions docs/en/codebases/mmseg.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Please refer to [get_started.md](https://github.com/open-mmlab/mmsegmentation/bl

### List of MMSegmentation models supported by MMDeploy

| model | OnnxRuntime | TensorRT | NCNN | PPLNN | OpenVino | model config file(example) |
|:----------------------------|:-----------:|:--------:|:----:|:-----:|:--------:|:-----------------------------------------------------------------------------------|
| FCN | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/fcn/fcn_r50-d8_512x1024_40k_cityscapes.py |
| PSPNet[*](#static_shape) | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/pspnet/pspnet_r50-d8_512x1024_40k_cityscapes.py |
| DeepLabV3 | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/deeplabv3/deeplabv3_r50-d8_512x1024_40k_cityscapes.py |
| DeepLabV3+ | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/deeplabv3plus/deeplabv3plus_r50-d8_512x1024_40k_cityscapes.py |
| Fast-SCNN[*](#static_shape) | Y | Y | N | Y | Y | ${MMSEG_DIR}/configs/fastscnn/fast_scnn_lr0.12_8x4_160k_cityscapes.py |
| model | OnnxRuntime | TensorRT | NCNN | PPLNN | OpenVino | model config file(example) |
| :-------------------------- | :---------: | :------: | :---: | :---: | :------: | :--------------------------------------------------------------------------------- |
| FCN | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/fcn/fcn_r50-d8_512x1024_40k_cityscapes.py |
| PSPNet[*](#static_shape) | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/pspnet/pspnet_r50-d8_512x1024_40k_cityscapes.py |
| DeepLabV3 | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/deeplabv3/deeplabv3_r50-d8_512x1024_40k_cityscapes.py |
| DeepLabV3+ | Y | Y | Y | Y | Y | ${MMSEG_DIR}/configs/deeplabv3plus/deeplabv3plus_r50-d8_512x1024_40k_cityscapes.py |
| Fast-SCNN[*](#static_shape) | Y | Y | N | Y | Y | ${MMSEG_DIR}/configs/fastscnn/fast_scnn_lr0.12_8x4_160k_cityscapes.py |

### Reminder

Expand Down
1 change: 1 addition & 0 deletions docs/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ You can switch between Chinese and English documents in the lower-left corner of
:caption: Get Started

build.md
supported_models.md
get_started.md

.. toctree::
Expand Down
46 changes: 46 additions & 0 deletions docs/en/support_model.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## List of supported models exportable to other backends

The table below lists the models that are guaranteed to be exportable to other backends.

| Model | Codebase | OnnxRuntime | TensorRT | NCNN | PPLNN | OpenVINO | Model config |
| :------------------------ | :--------------- | :---------: | :------: | :---: | :---: | :------: | :--------------------------------------------------------------------------------------------: |
| RetinaNet | MMDetection | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/retinanet) |
| Faster R-CNN | MMDetection | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/faster_rcnn) |
| YOLOv3 | MMDetection | Y | Y | Y | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/yolo) |
| YOLOX | MMDetection | Y | Y | N | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/yolox) |
| FCOS | MMDetection | Y | Y | Y | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/fcos) |
| FSAF | MMDetection | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/fsaf) |
| Mask R-CNN | MMDetection | Y | Y | N | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/mask_rcnn) |
| SSD[*](#note) | MMDetection | Y | Y | Y | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/ssd) |
| FoveaBox | MMDetection | Y | N | N | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/foveabox) |
| ATSS | MMDetection | Y | Y | N | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/atss) |
| Cascade R-CNN | MMDetection | Y | Y | N | Y | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/cascade_rcnn) |
| Cascade Mask R-CNN | MMDetection | Y | N | N | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/cascade_rcnn) |
| VFNet | MMDetection | N | N | N | N | Y | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/vfnet) |
| ResNet | MMClassification | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmclassification/tree/master/configs/resnet) |
| ResNeXt | MMClassification | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmclassification/tree/master/configs/resnext) |
| SE-ResNet | MMClassification | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmclassification/tree/master/configs/seresnet) |
| MobileNetV2 | MMClassification | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmclassification/tree/master/configs/mobilenet_v2) |
| ShuffleNetV1 | MMClassification | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmclassification/tree/master/configs/shufflenet_v1) |
| ShuffleNetV2 | MMClassification | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmclassification/tree/master/configs/shufflenet_v2) |
| FCN | MMSegmentation | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fcn) |
| PSPNet[*static](#note) | MMSegmentation | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/pspnet) |
| DeepLabV3 | MMSegmentation | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/deeplabv3) |
| DeepLabV3+ | MMSegmentation | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/deeplabv3plus) |
| Fast-SCNN[*static](#note) | MMSegmentation | Y | Y | N | Y | Y | [config](https://github.com/open-mmlab/mmsegmentation/tree/master/configs/fastscnn) |
| SRCNN | MMEditing | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmediting/tree/master/configs/restorers/srcnn) |
| ESRGAN | MMEditing | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmediting/tree/master/configs/restorers/esrgan) |
| SRGAN | MMEditing | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmediting/tree/master/configs/restorers/srresnet_srgan) |
| SRResNet | MMEditing | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmediting/tree/master/configs/restorers/srresnet_srgan) |
| Real-ESRGAN | MMEditing | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmediting/tree/master/configs/restorers/real_esrgan) |
| EDSR | MMEditing | Y | Y | Y | N | Y | [config](https://github.com/open-mmlab/mmediting/tree/master/configs/restorers/edsr) |
| RDN | MMEditing | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmediting/tree/master/configs/restorers/rdn) |
| DBNet | MMOCR | Y | Y | Y | Y | Y | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textdet/dbnet) |
| CRNN | MMOCR | Y | Y | Y | Y | N | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/crnn) |
| SAR | MMOCR | Y | N | N | N | N | [config](https://github.com/open-mmlab/mmocr/tree/main/configs/textrecog/sar) |

### Note

- Tag:
- static: This model only supports conversion with static shape. Please use the deployment config with static field. For instance, for TensorRT, try $MMDEPLOY_DIR/configs/mmseg/segmentation_tensorrt_static-1024x2048.py.
- SSD: When you convert SSD model for TensorRT, you need to use the deployment config: $MMDEPLOY_DIR/configs/mmdet/detection/detection_tensorrt_dynamic-300x300-512x512.py.
Loading

0 comments on commit 15bdafe

Please sign in to comment.