2021-10-09 14:10:42 +08:00
## Introduction
2021-06-11 13:26:05 +08:00
2021-10-09 14:10:42 +08:00
English | [简体中文 ](README_zh-CN.md )
MMDeploy is an open-source deep learning model deployment toolset. It is
a part of the [OpenMMLab ](https://openmmlab.com/ ) project.
### Major features
- **OpenMMLab model support**
Models in OpenMMLab can be deployed with this project. Such as MMClassification, MMDetection, etc.
- **Multiple inference engine support**
Models can be export and inference with different backend. Such as ONNX Runtime, TensorRT, etc.
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
- **Model rewrite**
2021-10-09 14:19:12 +08:00
Modules and functions used in models can be rewritten to meet the demond of different backend. It is easy to add new model support.
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
## License
2021-07-10 16:16:11 +08:00
2021-10-09 14:10:42 +08:00
This project is released under the [Apache 2.0 license ](LICENSE ).
2021-07-10 16:16:11 +08:00
2021-10-09 14:10:42 +08:00
## Codebase and Backend support
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
Supported codebase:
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
- [x] MMClassification
- [x] MMDetection
- [x] MMSegmentation
- [x] MMEditing
- [x] MMOCR
Supported backend:
- [x] ONNX Runtime
- [x] TensorRT
- [x] PPL
- [x] ncnn
## Installation
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
Please refer to [build.md ](docs/build.md ) for installation.
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
## Getting Started
2021-08-10 17:04:58 +08:00
2021-10-09 14:10:42 +08:00
Please read [how_to_convert_model.md ](docs/tutorials/how_to_convert_model.md ) for the basic usage of MMDeploy. There are also tutorials for [how to create config ](docs/tutorials/how_to_create_config.md ), [how to support new model ](docs/tutorials/how_to_support_new_model.md ) and [how to test model ](docs/tutorials/how_to_test_model.md ).
2021-08-10 17:04:58 +08:00
2021-10-09 14:10:42 +08:00
Please refer to [FAQ ](docs/faq.md ) for frequently asked questions.
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
## Contributing
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
We appreciate all contributions to improve MMDeploy. Please refer to [CONTRIBUTING.md ](.github/CONTRIBUTING.md ) for the contributing guideline.
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
## Projects in OpenMMLab
2021-07-01 17:32:33 +08:00
2021-10-09 14:10:42 +08:00
- [MMCV ](https://github.com/open-mmlab/mmcv ): OpenMMLab foundational library for computer vision.
- [MIM ](https://github.com/open-mmlab/mim ): MIM Installs OpenMMLab Packages.
- [MMClassification ](https://github.com/open-mmlab/mmclassification ): OpenMMLab image classification toolbox and benchmark.
- [MMDetection ](https://github.com/open-mmlab/mmdetection ): OpenMMLab detection toolbox and benchmark.
- [MMDetection3D ](https://github.com/open-mmlab/mmdetection3d ): OpenMMLab's next-generation platform for general 3D object detection.
- [MMSegmentation ](https://github.com/open-mmlab/mmsegmentation ): OpenMMLab semantic segmentation toolbox and benchmark.
- [MMAction2 ](https://github.com/open-mmlab/mmaction2 ): OpenMMLab's next-generation action understanding toolbox and benchmark.
- [MMTracking ](https://github.com/open-mmlab/mmtracking ): OpenMMLab video perception toolbox and benchmark.
- [MMPose ](https://github.com/open-mmlab/mmpose ): OpenMMLab pose estimation toolbox and benchmark.
- [MMEditing ](https://github.com/open-mmlab/mmediting ): OpenMMLab image and video editing toolbox.
- [MMOCR ](https://github.com/open-mmlab/mmocr ): A Comprehensive Toolbox for Text Detection, Recognition and Understanding.
- [MMGeneration ](https://github.com/open-mmlab/mmgeneration ): OpenMMLab image and video generative models toolbox.
