Skip to content

Commit 3ea47f4

Browse files
authored
[Feature] Add chinese version readme (open-mmlab#4650)
* add chinese version readme * fix the language link
1 parent 3d5b103 commit 3ea47f4

File tree

2 files changed

+169
-1
lines changed

2 files changed

+169
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ Documentation: https://mmdetection.readthedocs.io/
88

99
## Introduction
1010

11+
English | [简体中文](README_zh-CN.md)
12+
1113
MMDetection is an open source object detection toolbox based on PyTorch. It is
1214
a part of the OpenMMLab project developed by [Multimedia Laboratory, CUHK](http://mmlab.ie.cuhk.edu.hk/).
1315

14-
The master branch works with **PyTorch 1.3 to 1.6**.
16+
The master branch works with **PyTorch 1.3+**.
1517
The old v1.x branch works with PyTorch 1.1 to 1.4, but v2.0 is strongly recommended for faster speed, higher performance, better design and more friendly usage.
1618

1719
![demo image](resources/coco_test_12510.jpg)

README_zh-CN.md

+166
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
<div align="center">
2+
<img src="resources/mmdet-logo.png" width="600"/>
3+
</div>
4+
5+
**新闻**: 我们在 [ArXiv](https://arxiv.org/abs/1906.07155) 上公开了技术报告。
6+
7+
文档: https://mmdetection.readthedocs.io/
8+
9+
## 简介
10+
11+
[English](README.md) | 简体中文
12+
13+
MMDetection 是一个基于 PyTorch 的目标检测开源工具箱。它是 OpenMMLab 项目的一部分,这个项目由香港中文大学多媒体实验室和商汤科技联合发起。
14+
15+
主分支代码目前支持 PyTorch 1.3 以上的版本。
16+
17+
v1.x 的历史版本支持 PyTorch 1.1 到 1.4,但是我们强烈建议用户使用新的 2.x 的版本,新的版本速度更快,性能更高,有更优雅的代码设计,对用户使用也更加友好。
18+
19+
![demo image](resources/coco_test_12510.jpg)
20+
21+
### 主要特性
22+
23+
- **模块化设计**
24+
25+
MMDetection 将检测框架解耦成不同的模块组件,通过组合不同的模块组件,用户可以便捷地构建自定义的检测模型
26+
27+
- **丰富的即插即用的算法和模型**
28+
29+
MMDetection 支持了众多主流的和最新的检测算法,例如 Faster R-CNN,Mask R-CNN,RetinaNet 等。
30+
31+
- **速度快**
32+
33+
基本的框和 mask 操作都实现了 GPU 版本,训练速度比其他代码库更快或者相当,包括 [Detectron2](https://github.com/facebookresearch/detectron2), [maskrcnn-benchmark](https://github.com/facebookresearch/maskrcnn-benchmark)[SimpleDet](https://github.com/TuSimple/simpledet)
34+
35+
- **性能高**
36+
37+
MMDetection 这个算法库源自于 COCO 2018 目标检测竞赛的冠军团队 *MMDet* 团队开发的代码,我们在之后持续进行了改进和提升。
38+
39+
除了 MMDetection 之外,我们还开源了计算机视觉基础库 [MMCV](https://github.com/open-mmlab/mmcv),MMCV 是 MMDetection 的主要依赖。
40+
41+
## 开源许可证
42+
43+
该项目采用 [Apache 2.0 开源许可证](LICENSE)
44+
45+
## 更新日志
46+
47+
最新的月度版本 v2.9.0 在 2021.02.01 发布。
48+
如果想了解更多版本更新细节和历史信息,请阅读[更新日志](docs/changelog.md)
49+
[兼容性说明文档](docs/compatibility.md)中我们提供了 1.x 和 2.0 版本的详细比较。
50+
51+
## 基准测试和模型库
52+
53+
测试结果和模型可以在[模型库](docs/model_zoo.md)中找到。
54+
55+
已支持的骨干网络:
56+
57+
- [x] ResNet (CVPR'2016)
58+
- [x] ResNeXt (CVPR'2017)
59+
- [x] VGG (ICLR'2015)
60+
- [x] HRNet (CVPR'2019)
61+
- [x] RegNet (CVPR'2020)
62+
- [x] Res2Net (TPAMI'2020)
63+
- [x] ResNeSt (ArXiv'2020)
64+
65+
已支持的算法:
66+
67+
- [x] [RPN (NeurIPS'2015)](configs/rpn)
68+
- [x] [Fast R-CNN (ICCV'2015)](configs/fast_rcnn)
69+
- [x] [Faster R-CNN (NeurIPS'2015)](configs/faster_rcnn)
70+
- [x] [Mask R-CNN (ICCV'2017)](configs/mask_rcnn)
71+
- [x] [Cascade R-CNN (CVPR'2018)](configs/cascade_rcnn)
72+
- [x] [Cascade Mask R-CNN (CVPR'2018)](configs/cascade_rcnn)
73+
- [x] [SSD (ECCV'2016)](configs/ssd)
74+
- [x] [RetinaNet (ICCV'2017)](configs/retinanet)
75+
- [x] [GHM (AAAI'2019)](configs/ghm)
76+
- [x] [Mask Scoring R-CNN (CVPR'2019)](configs/ms_rcnn)
77+
- [x] [Double-Head R-CNN (CVPR'2020)](configs/double_heads)
78+
- [x] [Hybrid Task Cascade (CVPR'2019)](configs/htc)
79+
- [x] [Libra R-CNN (CVPR'2019)](configs/libra_rcnn)
80+
- [x] [Guided Anchoring (CVPR'2019)](configs/guided_anchoring)
81+
- [x] [FCOS (ICCV'2019)](configs/fcos)
82+
- [x] [RepPoints (ICCV'2019)](configs/reppoints)
83+
- [x] [Foveabox (TIP'2020)](configs/foveabox)
84+
- [x] [FreeAnchor (NeurIPS'2019)](configs/free_anchor)
85+
- [x] [NAS-FPN (CVPR'2019)](configs/nas_fpn)
86+
- [x] [ATSS (CVPR'2020)](configs/atss)
87+
- [x] [FSAF (CVPR'2019)](configs/fsaf)
88+
- [x] [PAFPN (CVPR'2018)](configs/pafpn)
89+
- [x] [Dynamic R-CNN (ECCV'2020)](configs/dynamic_rcnn)
90+
- [x] [PointRend (CVPR'2020)](configs/point_rend)
91+
- [x] [CARAFE (ICCV'2019)](configs/carafe/README.md)
92+
- [x] [DCNv2 (CVPR'2019)](configs/dcn/README.md)
93+
- [x] [Group Normalization (ECCV'2018)](configs/gn/README.md)
94+
- [x] [Weight Standardization (ArXiv'2019)](configs/gn+ws/README.md)
95+
- [x] [OHEM (CVPR'2016)](configs/faster_rcnn/faster_rcnn_r50_fpn_ohem_1x_coco.py)
96+
- [x] [Soft-NMS (ICCV'2017)](configs/faster_rcnn/faster_rcnn_r50_fpn_soft_nms_1x_coco.py)
97+
- [x] [Generalized Attention (ICCV'2019)](configs/empirical_attention/README.md)
98+
- [x] [GCNet (ICCVW'2019)](configs/gcnet/README.md)
99+
- [x] [Mixed Precision (FP16) Training (ArXiv'2017)](configs/fp16/README.md)
100+
- [x] [InstaBoost (ICCV'2019)](configs/instaboost/README.md)
101+
- [x] [GRoIE (ICPR'2020)](configs/groie/README.md)
102+
- [x] [DetectoRS (ArXix'2020)](configs/detectors/README.md)
103+
- [x] [Generalized Focal Loss (NeurIPS'2020)](configs/gfl/README.md)
104+
- [x] [CornerNet (ECCV'2018)](configs/cornernet/README.md)
105+
- [x] [Side-Aware Boundary Localization (ECCV'2020)](configs/sabl/README.md)
106+
- [x] [YOLOv3 (ArXiv'2018)](configs/yolo/README.md)
107+
- [x] [PAA (ECCV'2020)](configs/paa/README.md)
108+
- [x] [YOLACT (ICCV'2019)](configs/yolact/README.md)
109+
- [x] [CentripetalNet (CVPR'2020)](configs/centripetalnet/README.md)
110+
- [x] [VFNet (ArXix'2020)](configs/vfnet/README.md)
111+
- [x] [DETR (ECCV'2020)](configs/detr/README.md)
112+
- [x] [CascadeRPN (NeurIPS'2019)](configs/cascade_rpn/README.md)
113+
- [x] [SCNet (AAAI'2021)](configs/scnet/README.md)
114+
115+
我们在[基于 MMDetection 的项目](./docs/projects.md)中列举了一些其他的支持的算法。
116+
117+
## 安装
118+
119+
请参考[快速入门文档](docs/get_started.md)进行安装。
120+
121+
## 快速入门
122+
123+
请参考[快速入门文档](docs/get_started.md)学习 MMDetection 的基本使用。
124+
我们提供了 [colab 教程](demo/MMDet_Tutorial.ipynb),也为新手提供了完整的运行教程,分别针对[已有数据集](docs/1_exist_data_model.md)[新数据集](docs/2_new_data_model.md) 完整的使用指南
125+
126+
我们也提供了一些进阶教程,内容覆盖了 [finetune 模型](docs/tutorials/finetune.md)[增加新数据集支持](docs/tutorials/new_dataset.md)[设计新的数据预处理流程](docs/tutorials/data_pipeline.md)[增加自定义模型](ocs/tutorials/customize_models.md)[增加自定义的运行时配置](docs/tutorials/customize_runtime.md)[常用工具和脚本](docs/useful_tools.md)
127+
128+
如果遇到问题,请参考 [FAQ 页面](docs/faq.md)
129+
130+
## 贡献指南
131+
132+
我们感谢所有的贡献者为改进和提升 MMDetection 所作出的努力。请参考[贡献指南](.github/CONTRIBUTING.md)来了解参与项目贡献的相关指引。
133+
134+
## 致谢
135+
136+
MMDetection 是一款由来自不同高校和企业的研发人员共同参与贡献的开源项目。我们感谢所有为项目提供算法复现和新功能支持的贡献者,以及提供宝贵反馈的用户。 我们希望这个工具箱和基准测试可以为社区提供灵活的代码工具,供用户复现已有算法并开发自己的新模型,从而不断为开源社区提供贡献。
137+
138+
## 引用
139+
140+
如果你在研究中使用了本项目的代码或者性能基准,请参考如下 bibtex 引用 MMDetection。
141+
142+
```
143+
@article{mmdetection,
144+
title = {{MMDetection}: Open MMLab Detection Toolbox and Benchmark},
145+
author = {Chen, Kai and Wang, Jiaqi and Pang, Jiangmiao and Cao, Yuhang and
146+
Xiong, Yu and Li, Xiaoxiao and Sun, Shuyang and Feng, Wansen and
147+
Liu, Ziwei and Xu, Jiarui and Zhang, Zheng and Cheng, Dazhi and
148+
Zhu, Chenchen and Cheng, Tianheng and Zhao, Qijie and Li, Buyu and
149+
Lu, Xin and Zhu, Rui and Wu, Yue and Dai, Jifeng and Wang, Jingdong
150+
and Shi, Jianping and Ouyang, Wanli and Loy, Chen Change and Lin, Dahua},
151+
journal= {arXiv preprint arXiv:1906.07155},
152+
year={2019}
153+
}
154+
```
155+
156+
## OpenMMLab 的其他项目
157+
158+
- [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库
159+
- [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱
160+
- [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab 目标检测工具箱
161+
- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab 新一代通用 3D 目标检测平台
162+
- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab 语义分割工具箱
163+
- [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab 新一代视频理解工具箱
164+
- [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab 一体化视频目标感知平台
165+
- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱
166+
- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab 图像视频编辑工具箱

0 commit comments

Comments
 (0)