2021-02-22 03:11:28 +08:00
|
|
|
|
<div align="center">
|
|
|
|
|
|
<img src="resources/mmseg-logo.png" width="600"/>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
|
|
[](https://pypi.org/project/mmsegmentation)
|
2021-07-03 23:54:32 +08:00
|
|
|
|
[](https://mmsegmentation.readthedocs.io/zh_CN/latest/)
|
2021-02-22 03:11:28 +08:00
|
|
|
|
[](https://github.com/open-mmlab/mmsegmentation/actions)
|
|
|
|
|
|
[](https://codecov.io/gh/open-mmlab/mmsegmentation)
|
|
|
|
|
|
[](https://github.com/open-mmlab/mmsegmentation/blob/master/LICENSE)
|
|
|
|
|
|
[](https://github.com/open-mmlab/mmsegmentation/issues)
|
|
|
|
|
|
[](https://github.com/open-mmlab/mmsegmentation/issues)
|
|
|
|
|
|
|
2021-07-03 23:54:32 +08:00
|
|
|
|
文档: https://mmsegmentation.readthedocs.io/zh_CN/latest
|
2021-02-22 03:11:28 +08:00
|
|
|
|
|
|
|
|
|
|
[English](README.md) | 简体中文
|
|
|
|
|
|
|
|
|
|
|
|
## 简介
|
|
|
|
|
|
|
|
|
|
|
|
MMSegmentation 是一个基于 PyTorch 的语义分割开源工具箱。它是 OpenMMLab 项目的一部分。
|
|
|
|
|
|
|
|
|
|
|
|
主分支代码目前支持 PyTorch 1.3 以上的版本。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### 主要特性
|
|
|
|
|
|
|
|
|
|
|
|
- **统一的基准平台**
|
|
|
|
|
|
|
|
|
|
|
|
我们将各种各样的语义分割算法集成到了一个统一的工具箱，进行基准测试。
|
|
|
|
|
|
|
|
|
|
|
|
- **模块化设计**
|
|
|
|
|
|
|
|
|
|
|
|
MMSegmentation 将分割框架解耦成不同的模块组件，通过组合不同的模块组件，用户可以便捷地构建自定义的分割模型。
|
|
|
|
|
|
|
|
|
|
|
|
- **丰富的即插即用的算法和模型**
|
|
|
|
|
|
|
|
|
|
|
|
MMSegmentation 支持了众多主流的和最新的检测算法，例如 PSPNet，DeepLabV3，PSANet，DeepLabV3+ 等.
|
|
|
|
|
|
|
|
|
|
|
|
- **速度快**
|
|
|
|
|
|
|
|
|
|
|
|
训练速度比其他语义分割代码库更快或者相当。
|
|
|
|
|
|
|
|
|
|
|
|
## 开源许可证
|
|
|
|
|
|
|
|
|
|
|
|
该项目采用 [Apache 2.0 开源许可证](LICENSE)。
|
|
|
|
|
|
|
|
|
|
|
|
## 更新日志
|
|
|
|
|
|
|
2021-08-04 17:17:39 +08:00
|
|
|
|
最新的月度版本 v0.16.0 在 2021.08.04 发布。
|
2021-02-22 03:11:28 +08:00
|
|
|
|
如果想了解更多版本更新细节和历史信息，请阅读[更新日志](docs/changelog.md)。
|
|
|
|
|
|
|
|
|
|
|
|
## 基准测试和模型库
|
|
|
|
|
|
|
2021-07-03 23:54:32 +08:00
|
|
|
|
测试结果和模型可以在[模型库](docs_zh-CN/model_zoo.md)中找到。
|
2021-02-22 03:11:28 +08:00
|
|
|
|
|
|
|
|
|
|
已支持的骨干网络：
|
|
|
|
|
|
|
2021-04-25 00:58:15 +08:00
|
|
|
|
- [x] ResNet (CVPR'2016)
|
|
|
|
|
|
- [x] ResNeXt (CVPR'2017)
|
2021-07-01 23:41:55 +08:00
|
|
|
|
- [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)
|
2021-08-26 18:35:35 +08:00
|
|
|
|
- [x] [Swin Transformer (ArXiv'2021)](configs/swin)
|
2021-02-22 03:11:28 +08:00
|
|
|
|
|
|
|
|
|
|
已支持的算法：
|
|
|
|
|
|
|
2021-04-25 00:58:15 +08:00
|
|
|
|
- [x] [FCN (CVPR'2015/TPAMI'2017)](configs/fcn)
|
2021-07-01 23:41:55 +08:00
|
|
|
|
- [x] [UNet (MICCAI'2016/Nat. Methods'2019)](configs/unet)
|
2021-04-25 00:58:15 +08:00
|
|
|
|
- [x] [PSPNet (CVPR'2017)](configs/pspnet)
|
2021-07-01 23:41:55 +08:00
|
|
|
|
- [x] [DeepLabV3 (ArXiv'2017)](configs/deeplabv3)
|
|
|
|
|
|
- [x] [Mixed Precision (FP16) Training (ArXiv'2017)](configs/fp16)
|
2021-04-25 00:58:15 +08:00
|
|
|
|
- [x] [PSANet (ECCV'2018)](configs/psanet)
|
|
|
|
|
|
- [x] [DeepLabV3+ (CVPR'2018)](configs/deeplabv3plus)
|
|
|
|
|
|
- [x] [UPerNet (ECCV'2018)](configs/upernet)
|
|
|
|
|
|
- [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] [Fast-SCNN (ArXiv'2019)](configs/fastscnn)
|
|
|
|
|
|
- [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)
|
2021-06-24 13:25:06 +08:00
|
|
|
|
- [x] [SETR (CVPR'2021)](configs/setr)
|
2021-08-26 18:35:35 +08:00
|
|
|
|
- [x] [SegFormer (ArXiv'2021)](configs/segformer)
|
2021-02-22 03:11:28 +08:00
|
|
|
|
|
2021-08-29 02:51:05 +08:00
|
|
|
|
已支持的数据集：
|
|
|
|
|
|
|
|
|
|
|
|
- [x] [Cityscapes](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#cityscapes)
|
|
|
|
|
|
- [x] [PASCAL VOC](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#pascal-voc)
|
|
|
|
|
|
- [x] [ADE20K](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#ade20k)
|
|
|
|
|
|
- [x] [Pascal Context](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#pascal-context)
|
|
|
|
|
|
- [x] [CHASE_DB1](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#chase-db1)
|
|
|
|
|
|
- [x] [DRIVE](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#drive)
|
|
|
|
|
|
- [x] [HRF](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#hrf)
|
|
|
|
|
|
- [x] [STARE](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#stare)
|
|
|
|
|
|
- [x] [Dark Zurich](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#dark-zurich)
|
|
|
|
|
|
- [x] [Nighttime Driving](https://github.com/open-mmlab/mmsegmentation/blob/master/docs/dataset_prepare.md#nighttime-driving)
|
|
|
|
|
|
|
2021-02-22 03:11:28 +08:00
|
|
|
|
## 安装
|
|
|
|
|
|
|
2021-08-29 02:51:05 +08:00
|
|
|
|
请参考[快速入门文档](docs_zh-CN/get_started.md#installation)进行安装，参考[数据集准备](docs_zh-CN/dataset_prepare.md)处理数据。
|
2021-02-22 03:11:28 +08:00
|
|
|
|
|
|
|
|
|
|
## 快速入门
|
|
|
|
|
|
|
2021-07-03 23:54:32 +08:00
|
|
|
|
请参考[训练教程](docs_zh-CN/train.md)和[测试教程](docs_zh-CN/inference.md)学习 MMSegmentation 的基本使用。
|
|
|
|
|
|
我们也提供了一些进阶教程，内容覆盖了[增加自定义数据集](docs_zh-CN/tutorials/customize_datasets.md)，[设计新的数据预处理流程](docs_zh-CN/tutorials/data_pipeline.md)，[增加自定义模型](docs_zh-CN/tutorials/customize_models.md)，[增加自定义的运行时配置](docs_zh-CN/tutorials/customize_runtime.md)。
|
2021-08-26 18:35:35 +08:00
|
|
|
|
除此之外，我们也提供了很多实用的[训练技巧说明](docs_zh-CN/tutorials/training_tricks.md)和模型部署相关的[有用的工具](docs_zh-CN/useful_tools.md)。
|
2021-02-22 03:11:28 +08:00
|
|
|
|
|
|
|
|
|
|
同时，我们提供了 Colab 教程。你可以在[这里](demo/MMSegmentation_Tutorial.ipynb)浏览教程，或者直接在 Colab 上[运行](https://colab.research.google.com/github/open-mmlab/mmsegmentation/blob/master/demo/MMSegmentation_Tutorial.ipynb)。
|
|
|
|
|
|
|
|
|
|
|
|
## 引用
|
|
|
|
|
|
|
|
|
|
|
|
如果你觉得本项目对你的研究工作有所帮助，请参考如下 bibtex 引用 MMSegmentation。
|
|
|
|
|
|
|
|
|
|
|
|
```latex
|
|
|
|
|
|
@misc{mmseg2020,
|
|
|
|
|
|
title={{MMSegmentation}: OpenMMLab Semantic Segmentation Toolbox and Benchmark},
|
|
|
|
|
|
author={MMSegmentation Contributors},
|
|
|
|
|
|
howpublished = {\url{https://github.com/open-mmlab/mmsegmentation}},
|
|
|
|
|
|
year={2020}
|
|
|
|
|
|
}
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 贡献指南
|
|
|
|
|
|
|
|
|
|
|
|
我们感谢所有的贡献者为改进和提升 MMSegmentation 所作出的努力。请参考[贡献指南](.github/CONTRIBUTING.md)来了解参与项目贡献的相关指引。
|
|
|
|
|
|
|
|
|
|
|
|
## 致谢
|
|
|
|
|
|
|
|
|
|
|
|
MMSegmentation 是一个由来自不同高校和企业的研发人员共同参与贡献的开源项目。我们感谢所有为项目提供算法复现和新功能支持的贡献者，以及提供宝贵反馈的用户。 我们希望这个工具箱和基准测试可以为社区提供灵活的代码工具，供用户复现已有算法并开发自己的新模型，从而不断为开源社区提供贡献。
|
|
|
|
|
|
|
|
|
|
|
|
## OpenMMLab 的其他项目
|
|
|
|
|
|
|
|
|
|
|
|
- [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库
|
|
|
|
|
|
- [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱
|
|
|
|
|
|
- [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab 目标检测工具箱
|
|
|
|
|
|
- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab 新一代通用 3D 目标检测平台
|
|
|
|
|
|
- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab 语义分割工具箱
|
|
|
|
|
|
- [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab 新一代视频理解工具箱
|
|
|
|
|
|
- [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab 一体化视频目标感知平台
|
|
|
|
|
|
- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱
|
|
|
|
|
|
- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab 图像视频编辑工具箱
|
2021-04-26 10:15:13 +08:00
|
|
|
|
- [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab 全流程文字检测识别理解工具包
|
|
|
|
|
|
- [MMGeneration](https://github.com/open-mmlab/mmgeneration): OpenMMLab 生成模型工具箱
|
|
|
|
|
|
|
|
|
|
|
|
## 欢迎加入 OpenMMLab 社区
|
|
|
|
|
|
|
2021-08-06 15:18:01 +08:00
|
|
|
|
扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab)，加入 [OpenMMLab 团队](https://jq.qq.com/?_wv=1027&k=aCvMxdr3) 以及 [MMSegmentation](https://jq.qq.com/?_wv=1027&k=ukevz6Ie) 的 QQ 群。
|
2021-04-26 10:15:13 +08:00
|
|
|
|
|
|
|
|
|
|
<div align="center">
|
2021-08-06 15:18:01 +08:00
|
|
|
|
<img src="docs_zh-CN/imgs/zhihu_qrcode.jpg" height="400" /> <img src="docs_zh-CN/imgs/qq_group_qrcode.jpg" height="400" /> <img src="docs_zh-CN/imgs/seggroup_qrcode.jpg" height="400" />
|
2021-04-26 10:15:13 +08:00
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
我们会在 OpenMMLab 社区为大家
|
|
|
|
|
|
|
|
|
|
|
|
- 📢 分享 AI 框架的前沿核心技术
|
|
|
|
|
|
- 💻 解读 PyTorch 常用模块源码
|
|
|
|
|
|
- 📰 发布 OpenMMLab 的相关新闻
|
|
|
|
|
|
- 🚀 介绍 OpenMMLab 开发的前沿算法
|
|
|
|
|
|
- 🏃 获取更高效的问题答疑和意见反馈
|
|
|
|
|
|
- 🔥 提供与各行各业开发者充分交流的平台
|
|
|
|
|
|
|
|
|
|
|
|
干货满满 📘，等你来撩 💗，OpenMMLab 社区期待您的加入 👬
|
