Skip to content

Commit 8b45843

Browse files
pixeli99Pengxiang Li
and
Pengxiang Li
authored
[Docs] Update readme according to the guideline (#578)
* update readme * update readme * update readme * update change_log Co-authored-by: Pengxiang Li <[email protected]>
1 parent 2542848 commit 8b45843

File tree

2 files changed

+58
-40
lines changed

2 files changed

+58
-40
lines changed

README.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
</sup>
1818
</div>
1919
<div>&nbsp;</div>
20-
</div>
2120

2221
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mmtrack)](https://pypi.org/project/mmtrack/)
2322
[![PyPI](https://img.shields.io/pypi/v/mmtrack)](https://pypi.org/project/mmtrack)
@@ -26,17 +25,27 @@
2625
[![codecov](https://codecov.io/gh/open-mmlab/mmtracking/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmtracking)
2726
[![license](https://img.shields.io/github/license/open-mmlab/mmtracking.svg)](https://github.com/open-mmlab/mmtracking/blob/master/LICENSE)
2827

29-
English | [简体中文](/README_zh-CN.md)
28+
[📘Documentation](https://mmtracking.readthedocs.io/) |
29+
[🛠️Installation](https://mmtracking.readthedocs.io/en/latest/install.html) |
30+
[👀Model Zoo](https://mmtracking.readthedocs.io/en/latest/model_zoo.html) |
31+
[🆕Update News](https://mmtracking.readthedocs.io/en/latest/changelog.html) |
32+
[🤔Reporting Issues](https://github.com/open-mmlab/mmtracking/issues/new/choose)
33+
34+
</div>
35+
36+
<div align="center">
37+
38+
English | [简体中文](README_zh-CN.md)
3039

31-
Documentation: https://mmtracking.readthedocs.io/
40+
</div>
3241

3342
## Introduction
3443

3544
MMTracking is an open source video perception toolbox by PyTorch. It is a part of [OpenMMLab](https://openmmlab.com) project.
3645

3746
The master branch works with **PyTorch1.5+**.
3847

39-
<div align="left">
48+
<div align="center">
4049
<img src="https://user-images.githubusercontent.com/24663779/103343312-c724f480-4ac6-11eb-9c22-b56f1902584e.gif" width="800"/>
4150
</div>
4251

@@ -58,17 +67,25 @@ The master branch works with **PyTorch1.5+**.
5867

5968
**Strong**: We reproduce state-of-the-art models and some of them even outperform the official implementations.
6069

61-
## License
62-
63-
This project is released under the [Apache 2.0 license](LICENSE).
64-
65-
## Changelog
70+
## What's New
6671

6772
Release [QDTrack](configs/mot/qdtrack) pretrained models.
6873

6974
v0.13.0 was released in 29/04/2022.
7075
Please refer to [changelog.md](docs/en/changelog.md) for details and release history.
7176

77+
## Installation
78+
79+
Please refer to [install.md](docs/en/install.md) for install instructions.
80+
81+
## Getting Started
82+
83+
Please see [dataset.md](docs/en/dataset.md) and [quick_run.md](docs/en/quick_run.md) for the basic usage of MMTracking.
84+
85+
A Colab tutorial is provided. You may preview the notebook [here](./demo/MMTracking_Tutorial.ipynb) or directly run it on [Colab](https://colab.research.google.com/github/open-mmlab/mmtracking/blob/master/demo/MMTracking_Tutorial.ipynb).
86+
87+
There are also usage [tutorials](docs/en/tutorials/), such as [learning about configs](docs/en/tutorials/config.md), [an example about detailed description of vid config](docs/en/tutorials/config_vid.md), [an example about detailed description of mot config](docs/en/tutorials/config_mot.md), [an example about detailed description of sot config](docs/en/tutorials/config_sot.md), [customizing dataset](docs/en/tutorials/customize_dataset.md), [customizing data pipeline](docs/en/tutorials/customize_data_pipeline.md), [customizing vid model](docs/en/tutorials/customize_vid_model.md), [customizing mot model](docs/en/tutorials/customize_mot_model.md), [customizing sot model](docs/en/tutorials/customize_sot_model.md), [customizing runtime settings](docs/en/tutorials/customize_runtime.md) and [useful tools](docs/en/useful_tools_scripts.md).
88+
7289
## Benchmark and model zoo
7390

7491
Results and models are available in the [model zoo](docs/en/model_zoo.md).
@@ -131,18 +148,6 @@ Supported Datasets
131148

132149
- [x] [YouTube-VIS](https://youtube-vos.org/dataset/vis/)
133150

134-
## Installation
135-
136-
Please refer to [install.md](docs/en/install.md) for install instructions.
137-
138-
## Getting Started
139-
140-
Please see [dataset.md](docs/en/dataset.md) and [quick_run.md](docs/en/quick_run.md) for the basic usage of MMTracking.
141-
142-
A Colab tutorial is provided. You may preview the notebook [here](./demo/MMTracking_Tutorial.ipynb) or directly run it on [Colab](https://colab.research.google.com/github/open-mmlab/mmtracking/blob/master/demo/MMTracking_Tutorial.ipynb).
143-
144-
There are also usage [tutorials](docs/en/tutorials/), such as [learning about configs](docs/en/tutorials/config.md), [an example about detailed description of vid config](docs/en/tutorials/config_vid.md), [an example about detailed description of mot config](docs/en/tutorials/config_mot.md), [an example about detailed description of sot config](docs/en/tutorials/config_sot.md), [customizing dataset](docs/en/tutorials/customize_dataset.md), [customizing data pipeline](docs/en/tutorials/customize_data_pipeline.md), [customizing vid model](docs/en/tutorials/customize_vid_model.md), [customizing mot model](docs/en/tutorials/customize_mot_model.md), [customizing sot model](docs/en/tutorials/customize_sot_model.md), [customizing runtime settings](docs/en/tutorials/customize_runtime.md) and [useful tools](docs/en/useful_tools_scripts.md).
145-
146151
## Contributing
147152

148153
We appreciate all contributions to improve MMTracking. Please refer to [CONTRIBUTING.md](https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md) for the contributing guideline and [this discussion](https://github.com/open-mmlab/mmtracking/issues/73) for development roadmap.
@@ -167,6 +172,10 @@ If you find this project useful in your research, please consider cite:
167172
}
168173
```
169174

175+
## License
176+
177+
This project is released under the [Apache 2.0 license](LICENSE).
178+
170179
## Projects in OpenMMLab
171180

172181
- [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab foundational library for computer vision.

README_zh-CN.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
</sup>
1818
</div>
1919
<div>&nbsp;</div>
20-
</div>
2120

2221
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mmtrack)](https://pypi.org/project/mmtrack/)
2322
[![PyPI](https://img.shields.io/pypi/v/mmtrack)](https://pypi.org/project/mmtrack)
@@ -26,17 +25,27 @@
2625
[![codecov](https://codecov.io/gh/open-mmlab/mmtracking/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmtracking)
2726
[![license](https://img.shields.io/github/license/open-mmlab/mmtracking.svg)](https://github.com/open-mmlab/mmtracking/blob/master/LICENSE)
2827

28+
[📘Documentation](https://mmtracking.readthedocs.io/zh_CN/latest/) |
29+
[🛠️Installation](https://mmtracking.readthedocs.io/zh_CN/latest/install.html) |
30+
[👀Model Zoo](https://mmtracking.readthedocs.io/zh_CN/latest/model_zoo.html) |
31+
[🆕Update News](https://mmtracking.readthedocs.io/en/latest/changelog.html) |
32+
[🤔Reporting Issues](https://github.com/open-mmlab/mmtracking/issues/new/choose)
33+
34+
</div>
35+
36+
<div align="center">
37+
2938
[English](/README.md) | 简体中文
3039

31-
文档:https://mmtracking.readthedocs.io/
40+
</div>
3241

3342
## 简介
3443

3544
MMTracking是一款基于PyTorch的视频目标感知开源工具箱,是[OpenMMLab](http://openmmlab.org/)项目的一部分。
3645

3746
主分支代码目前支持**PyTorch 1.5以上**的版本。
3847

39-
<div align="left">
48+
<div align="center">
4049
<img src="https://user-images.githubusercontent.com/24663779/103343312-c724f480-4ac6-11eb-9c22-b56f1902584e.gif" width="800"/>
4150
</div>
4251

@@ -58,13 +67,21 @@ MMTracking是一款基于PyTorch的视频目标感知开源工具箱,是[OpenM
5867

5968
**强大**:MMTracking复现了SOTA性能的模型。受益于[MMDetection](https://github.com/open-mmlab/mmdetection)的持续推进,部分实现精度超出官方版本。
6069

61-
## 许可
70+
## 更新
6271

63-
该项目遵循[Apache 2.0 license](/LICENSE)开源协议
72+
v0.13.0版本已于2022年04月29日发布,可通过查阅[更新日志](docs/en/changelog.md)了解更多细节以及发布历史
6473

65-
## 更新记录
74+
## 安装
6675

67-
v0.13.0版本已于2022年04月29日发布,可通过查阅[更新日志](docs/en/changelog.md)了解更多细节以及发布历史。
76+
请参考[安装指南](docs/en/install.md)进行安装。
77+
78+
## 开始使用MMTracking
79+
80+
请参考[数据集](docs/en/dataset.md)[快速开始](docs/en/quick_run.md)了解MMTracking的基本使用。
81+
82+
我们提供了跟踪的Colab教程,您可以在[这里](<(./demo/MMTracking_Tutorial.ipynb)>)预览或者直接在[Colab](https://colab.research.google.com/github/open-mmlab/mmtracking/blob/master/demo/MMTracking_Tutorial.ipynb)上运行。
83+
84+
MMTracking也提供了更详细的[教程](docs/en/tutorials/),比如[配置文件简介](docs/en/tutorials/config.md), [视频目标检测器配置文件详解](docs/en/tutorials/config_vid.md), [多目标跟踪器配置文件详解](docs/en/tutorials/config_mot.md), [单目标跟踪器配置文件详解](docs/en/tutorials/config_sot.md), [自定义数据集](docs/en/tutorials/customize_dataset.md), [自定义数据预处理流程](docs/en/tutorials/customize_data_pipeline.md), [自定义视频目标检测器](docs/en/tutorials/customize_vid_model.md), [自定义多目标跟踪器](docs/en/tutorials/customize_mot_model.md), [自定义单目标跟踪器](docs/en/tutorials/customize_sot_model.md), [自定义训练配置](docs/en/tutorials/customize_runtime.md) 以及 [有用的工具和脚本](docs/en/useful_tools_scripts.md).
6885

6986
## 基准测试与模型库
7087

@@ -128,18 +145,6 @@ v0.13.0版本已于2022年04月29日发布,可通过查阅[更新日志](docs/
128145

129146
- [x] [YouTube-VIS](https://youtube-vos.org/dataset/vis/)
130147

131-
## 安装
132-
133-
请参考[安装指南](docs/en/install.md)进行安装。
134-
135-
## 开始使用MMTracking
136-
137-
请参考[数据集](docs/en/dataset.md)[快速开始](docs/en/quick_run.md)了解MMTracking的基本使用。
138-
139-
我们提供了跟踪的Colab教程,您可以在[这里](<(./demo/MMTracking_Tutorial.ipynb)>)预览或者直接在[Colab](https://colab.research.google.com/github/open-mmlab/mmtracking/blob/master/demo/MMTracking_Tutorial.ipynb)上运行。
140-
141-
MMTracking也提供了更详细的[教程](docs/en/tutorials/),比如[配置文件简介](docs/en/tutorials/config.md), [视频目标检测器配置文件详解](docs/en/tutorials/config_vid.md), [多目标跟踪器配置文件详解](docs/en/tutorials/config_mot.md), [单目标跟踪器配置文件详解](docs/en/tutorials/config_sot.md), [自定义数据集](docs/en/tutorials/customize_dataset.md), [自定义数据预处理流程](docs/en/tutorials/customize_data_pipeline.md), [自定义视频目标检测器](docs/en/tutorials/customize_vid_model.md), [自定义多目标跟踪器](docs/en/tutorials/customize_mot_model.md), [自定义单目标跟踪器](docs/en/tutorials/customize_sot_model.md), [自定义训练配置](docs/en/tutorials/customize_runtime.md) 以及 [有用的工具和脚本](docs/en/useful_tools_scripts.md).
142-
143148
## 参与贡献
144149

145150
我们非常欢迎用户对于MMTracking做出的任何贡献,可以参考[贡献指南](https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md)文件了解更多细节和在这个[讨论](https://github.com/open-mmlab/mmtracking/issues/73)中规划MMTracking的开发计划。
@@ -161,6 +166,10 @@ MMTracking是一款开源项目,我们欢迎任何贡献和反馈。我们希
161166
}
162167
```
163168

169+
## 许可
170+
171+
该项目遵循[Apache 2.0 license](/LICENSE)开源协议。
172+
164173
## OpenMMLab 的其他项目
165174

166175
- [MMCV](https://github.com/open-mmlab/mmcv):OpenMMLab计算机视觉基础库

0 commit comments

Comments
 (0)