Skip to content

Commit 34427f9

Browse files
authored
add readme of chinese version (open-mmlab#383)
1 parent 0448dec commit 34427f9

File tree

2 files changed

+138
-2
lines changed

2 files changed

+138
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@
1313

1414
Documentation: https://mmsegmentation.readthedocs.io/
1515

16+
English | [简体中文](README_zh-CN.md)
17+
1618
## Introduction
1719

1820
MMSegmentation is an open source semantic segmentation toolbox based on PyTorch.
1921
It is a part of the OpenMMLab project.
2022

21-
The master branch works with **PyTorch 1.3 to 1.6**.
23+
The master branch works with **PyTorch 1.3+**.
2224

2325
![demo image](resources/seg_demo.gif)
2426

@@ -105,7 +107,7 @@ If you find this project useful in your research, please consider cite:
105107

106108
```latex
107109
@misc{mmseg2020,
108-
title={MMSegmentation, an Open Source Semantic Segmentation Toolbox},
110+
title={{MMSegmentation}: OpenMMLab Semantic Segmentation Toolbox and Benchmark},
109111
author={MMSegmentation Contributors},
110112
howpublished = {\url{https://github.com/open-mmlab/mmsegmentation}},
111113
year={2020}

README_zh-CN.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<div align="center">
2+
<img src="resources/mmseg-logo.png" width="600"/>
3+
</div>
4+
<br />
5+
6+
[![PyPI](https://img.shields.io/pypi/v/mmsegmentation)](https://pypi.org/project/mmsegmentation)
7+
[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmsegmentation.readthedocs.io/en/latest/)
8+
[![badge](https://github.com/open-mmlab/mmsegmentation/workflows/build/badge.svg)](https://github.com/open-mmlab/mmsegmentation/actions)
9+
[![codecov](https://codecov.io/gh/open-mmlab/mmsegmentation/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmsegmentation)
10+
[![license](https://img.shields.io/github/license/open-mmlab/mmsegmentation.svg)](https://github.com/open-mmlab/mmsegmentation/blob/master/LICENSE)
11+
[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmsegmentation.svg)](https://github.com/open-mmlab/mmsegmentation/issues)
12+
[![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmsegmentation.svg)](https://github.com/open-mmlab/mmsegmentation/issues)
13+
14+
文档: https://mmsegmentation.readthedocs.io/
15+
16+
[English](README.md) | 简体中文
17+
18+
## 简介
19+
20+
MMSegmentation 是一个基于 PyTorch 的语义分割开源工具箱。它是 OpenMMLab 项目的一部分。
21+
22+
主分支代码目前支持 PyTorch 1.3 以上的版本。
23+
24+
![示例图片](resources/seg_demo.gif)
25+
26+
### 主要特性
27+
28+
- **统一的基准平台**
29+
30+
我们将各种各样的语义分割算法集成到了一个统一的工具箱,进行基准测试。
31+
32+
- **模块化设计**
33+
34+
MMSegmentation 将分割框架解耦成不同的模块组件,通过组合不同的模块组件,用户可以便捷地构建自定义的分割模型。
35+
36+
- **丰富的即插即用的算法和模型**
37+
38+
MMSegmentation 支持了众多主流的和最新的检测算法,例如 PSPNet,DeepLabV3,PSANet,DeepLabV3+ 等.
39+
40+
- **速度快**
41+
42+
训练速度比其他语义分割代码库更快或者相当。
43+
44+
## 开源许可证
45+
46+
该项目采用 [Apache 2.0 开源许可证](LICENSE)
47+
48+
## 更新日志
49+
50+
最新的月度版本 v0.11.0 在 2021.02.02 发布。
51+
如果想了解更多版本更新细节和历史信息,请阅读[更新日志](docs/changelog.md)
52+
53+
## 基准测试和模型库
54+
55+
测试结果和模型可以在[模型库](docs/model_zoo.md)中找到。
56+
57+
已支持的骨干网络:
58+
59+
- [x] ResNet
60+
- [x] ResNeXt
61+
- [x] [HRNet](configs/hrnet/README.md)
62+
- [x] [ResNeSt](configs/resnest/README.md)
63+
- [x] [MobileNetV2](configs/mobilenet_v2/README.md)
64+
- [x] [MobileNetV3](configs/mobilenet_v3/README.md)
65+
66+
已支持的算法:
67+
68+
- [x] [FCN](configs/fcn)
69+
- [x] [PSPNet](configs/pspnet)
70+
- [x] [DeepLabV3](configs/deeplabv3)
71+
- [x] [PSANet](configs/psanet)
72+
- [x] [DeepLabV3+](configs/deeplabv3plus)
73+
- [x] [UPerNet](configs/upernet)
74+
- [x] [NonLocal Net](configs/nonlocal_net)
75+
- [x] [EncNet](configs/encnet)
76+
- [x] [CCNet](configs/ccnet)
77+
- [x] [DANet](configs/danet)
78+
- [x] [APCNet](configs/apcnet)
79+
- [x] [GCNet](configs/gcnet)
80+
- [x] [DMNet](configs/dmnet)
81+
- [x] [ANN](configs/ann)
82+
- [x] [OCRNet](configs/ocrnet)
83+
- [x] [Fast-SCNN](configs/fastscnn)
84+
- [x] [Semantic FPN](configs/sem_fpn)
85+
- [x] [PointRend](configs/point_rend)
86+
- [x] [EMANet](configs/emanet)
87+
- [x] [DNLNet](configs/dnlnet)
88+
- [x] [CGNet](configs/cgnet)
89+
- [x] [Mixed Precision (FP16) Training](configs/fp16/README.md)
90+
91+
## 安装
92+
93+
请参考[快速入门文档](docs/get_started.md#installation)进行安装和数据集准备。
94+
95+
## 快速入门
96+
97+
请参考[训练教程](docs/train.md)[测试教程](docs/inference.md)学习 MMSegmentation 的基本使用。
98+
我们也提供了一些进阶教程,内容覆盖了[增加自定义数据集](docs/tutorials/customize_datasets.md)[设计新的数据预处理流程](docs/tutorials/data_pipeline.md)[增加自定义模型](docs/tutorials/customize_models.md)[增加自定义的运行时配置](docs/tutorials/customize_runtime.md)
99+
除此之外,我们也提供了很多实用的[训练技巧说明](docs/tutorials/training_tricks.md)
100+
101+
同时,我们提供了 Colab 教程。你可以在[这里](demo/MMSegmentation_Tutorial.ipynb)浏览教程,或者直接在 Colab 上[运行](https://colab.research.google.com/github/open-mmlab/mmsegmentation/blob/master/demo/MMSegmentation_Tutorial.ipynb)
102+
103+
## 引用
104+
105+
如果你觉得本项目对你的研究工作有所帮助,请参考如下 bibtex 引用 MMSegmentation。
106+
107+
```latex
108+
@misc{mmseg2020,
109+
title={{MMSegmentation}: OpenMMLab Semantic Segmentation Toolbox and Benchmark},
110+
author={MMSegmentation Contributors},
111+
howpublished = {\url{https://github.com/open-mmlab/mmsegmentation}},
112+
year={2020}
113+
}
114+
```
115+
116+
## 贡献指南
117+
118+
我们感谢所有的贡献者为改进和提升 MMSegmentation 所作出的努力。请参考[贡献指南](.github/CONTRIBUTING.md)来了解参与项目贡献的相关指引。
119+
120+
## 致谢
121+
122+
MMSegmentation 是一个由来自不同高校和企业的研发人员共同参与贡献的开源项目。我们感谢所有为项目提供算法复现和新功能支持的贡献者,以及提供宝贵反馈的用户。 我们希望这个工具箱和基准测试可以为社区提供灵活的代码工具,供用户复现已有算法并开发自己的新模型,从而不断为开源社区提供贡献。
123+
124+
## OpenMMLab 的其他项目
125+
126+
- [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库
127+
- [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱
128+
- [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab 目标检测工具箱
129+
- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab 新一代通用 3D 目标检测平台
130+
- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab 语义分割工具箱
131+
- [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab 新一代视频理解工具箱
132+
- [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab 一体化视频目标感知平台
133+
- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱
134+
- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab 图像视频编辑工具箱

0 commit comments

Comments
 (0)