Skip to content

Commit b6a516c

Browse files
Yshuo-Liliyinshuo
andauthored
Readme zh-CN (open-mmlab#262)
* Add README_zh-CN * Add README_zh-CN * Tiny Fix * Tiny Fix Co-authored-by: liyinshuo <[email protected]>
1 parent 2541089 commit b6a516c

File tree

4 files changed

+143
-3
lines changed

4 files changed

+143
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@
44

55
## Introduction
66

7-
[![build](https://github.com/open-mmlab/mmediting/workflows/build/badge.svg)](https://github.com/open-mmlab/mmediting/actions)
8-
[![docs](https://readthedocs.org/projects/mmediting/badge/?version=latest)](https://mmediting.readthedocs.io/en/latest/?badge=latest)
7+
English | [简体中文](/README_zh-CN.md)
8+
9+
[![Documentation](https://readthedocs.org/projects/mmediting/badge/?version=latest)](https://mmediting.readthedocs.io/en/latest/?badge=latest)
10+
[![actions](https://github.com/open-mmlab/mmediting/workflows/build/badge.svg)](https://github.com/open-mmlab/mmediting/actions)
911
[![codecov](https://codecov.io/gh/open-mmlab/mmediting/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmediting)
10-
[![license](https://img.shields.io/github/license/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/blob/master/LICENSE)
12+
[![PyPI](https://badge.fury.io/py/mmedit.svg)](https://pypi.org/project/mmedit/)
13+
[![LICENSE](https://img.shields.io/github/license/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/blob/master/LICENSE)
14+
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/issues)
15+
[![Percentage of issues still open](https://isitmaintained.com/badge/open/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/issues)
16+
1117

1218
MMEditing is an open source image and video editing toolbox based on PyTorch. It is a part of the [OpenMMLab](https://open-mmlab.github.io/) project.
1319

@@ -57,6 +63,22 @@ Please refer to [install.md](docs/install.md) for installation.
5763

5864
Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMEditing.
5965

66+
67+
68+
## Citation
69+
70+
If you find this project useful in your research, please consider cite:
71+
72+
```bibtex
73+
@misc{mmediting2020,
74+
title={OpenMMLab Editing Estimation Toolbox and Benchmark},
75+
author={MMEditing Contributors},
76+
howpublished = {\url{https://github.com/open-mmlab/mmediting}},
77+
year={2020}
78+
}
79+
```
80+
```
81+
6082
## Contributing
6183
6284
We appreciate all contributions to improve MMEditing. Please refer to [CONTRIBUTING.md in MMDetection](https://github.com/open-mmlab/mmdetection/blob/master/.github/CONTRIBUTING.md) for the contributing guideline.

README_zh-CN.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
<div align="center">
2+
<img src="resources/mmediting-logo.png" width="500px"/>
3+
</div>
4+
5+
## Introduction
6+
7+
[English](/README.md) | 简体中文
8+
9+
10+
[![Documentation](https://readthedocs.org/projects/mmediting/badge/?version=latest)](https://mmediting.readthedocs.io/en/latest/?badge=latest)
11+
[![actions](https://github.com/open-mmlab/mmediting/workflows/build/badge.svg)](https://github.com/open-mmlab/mmediting/actions)
12+
[![codecov](https://codecov.io/gh/open-mmlab/mmediting/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmediting)
13+
[![PyPI](https://badge.fury.io/py/mmedit.svg)](https://pypi.org/project/mmedit/)
14+
[![LICENSE](https://img.shields.io/github/license/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/blob/master/LICENSE)
15+
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/issues)
16+
[![Percentage of issues still open](https://isitmaintained.com/badge/open/open-mmlab/mmediting.svg)](https://github.com/open-mmlab/mmediting/issues)
17+
18+
MMEditing 是基于 PyTorch 的图像&视频编辑开源工具箱。是 [OpenMMLab](https://open-mmlab.github.io/) 项目的成员之一。
19+
20+
主分支代码目前支持 **PyTorch 1.3~1.6**
21+
22+
文献资料: https://mmediting.readthedocs.io/en/latest/.
23+
24+
<div align="left">
25+
<img src="resources/mmediting-demo.jpg"/>
26+
</div>
27+
28+
### 主要特性
29+
30+
- **模块化设计**
31+
32+
MMEditing 将编辑框架分解为不同的组件,并且可以通过组合不同的模块轻松地构建自定义的编辑器模型。
33+
34+
- **支持多种编辑任务**
35+
36+
MMEditing 支持*绘画**抠图**超分辨率**生成*等多种主流编辑任务。
37+
38+
- **SOTA**
39+
40+
MMEditing 提供绘画/抠图/超分辨率/生成等任务最先进的算法.
41+
42+
## 许可证
43+
44+
本项目开源自 [Apache 2.0 license](LICENSE)
45+
46+
## 更新记录
47+
48+
v0.6.0 版本已于 2021 年 3 月 31 日发布.
49+
50+
需要注意的是 **MMSR** 已作为 MMEditing 的一部分并入本仓库。
51+
MMEditing 缜密地设计新的框架并将其精心实现,希望能够为您带来更好的体验。
52+
53+
## 基准和模型库
54+
55+
请参考[模型库](https://mmediting.readthedocs.io/en/latest/modelzoo.html)了解详情。
56+
57+
## 安装
58+
59+
请参考[安装指南](docs/install.md)进行安装。
60+
61+
## 开始使用
62+
63+
请参考[使用教程](docs/getting_started.md)获取MMEditing的基本用法。
64+
65+
66+
67+
## 引用
68+
69+
如果您觉得 MMEditing 对您的研究有所帮助,请考虑引用它:
70+
71+
```bibtex
72+
@misc{mmediting2020,
73+
title={OpenMMLab Editing Estimation Toolbox and Benchmark},
74+
author={MMEditing Contributors},
75+
howpublished = {\url{https://github.com/open-mmlab/mmediting}},
76+
year={2020}
77+
}
78+
```
79+
80+
## 参与贡献
81+
82+
感谢您为改善 MMEditing 所做的所有贡献。请参阅 [CONTRIBUTING.md in MMDetection](https://github.com/open-mmlab/mmdetection/blob/master/.github/CONTRIBUTING.md) 以获取贡献准则。
83+
84+
## 致谢
85+
86+
MMEditing 是一款由不同学校和公司共同贡献的开源项目。我们感谢所有为项目提供算法复现和新功能支持的贡献者,以及提供宝贵反馈的用户。 我们希望该工具箱和基准测试可以为社区提供灵活的代码工具,供用户复现现有算法并开发自己的新模型,从而不断为开源社区提供贡献。
87+
88+
## OpenMMLab 的其他项目
89+
90+
- [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库
91+
- [MMClassification](https://github.com/open-mmlab/mmclassification): 图像分类工具箱与测试基准
92+
- [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab 检测工具箱与测试基准
93+
- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab 新一代通用3D目标检测平台
94+
- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): 语义分割工具箱与测试基准
95+
- [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab 新一代视频理解工具箱与测试基准
96+
- [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab 一体化视频目标感知平台
97+
- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱与测试基准
98+
- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab 图像视频编辑工具箱
99+
- [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab 全流程文字检测识别理解工具包
100+
101+
## 欢迎加入 OpenMMLab 社区
102+
103+
扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab),加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=aCvMxdr3)
104+
105+
<div align="center">
106+
<img src="resources/zhihu_qrcode.jpg" height="400" /> <img src="resources/qq_group_qrcode.jpg" height="400" />
107+
</div>
108+
109+
我们会在 OpenMMLab 社区为大家
110+
111+
- 📢 分享 AI 框架的前沿核心技术
112+
- 💻 解读 PyTorch 常用模块源码
113+
- 📰 发布 OpenMMLab 的相关新闻
114+
- 🚀 介绍 OpenMMLab 开发的前沿算法
115+
- 🏃 获取更高效的问题答疑和意见反馈
116+
- 🔥 提供与各行各业开发者充分交流的平台
117+
118+
干货满满 📘,等你来撩 💗,OpenMMLab 社区期待您的加入 👬

resources/qq_group_qrcode.jpg

200 KB
Loading

resources/zhihu_qrcode.jpg

388 KB
Loading

0 commit comments

Comments
 (0)