Skip to content

Commit 766185e

Browse files
zytx121RangiLyu
authored andcommitted
Update readme of 1.0.0rc0 (#603)
* update * Update README_zh-CN.md
1 parent 3466768 commit 766185e

File tree

5 files changed

+7
-25
lines changed

5 files changed

+7
-25
lines changed

README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,6 @@ Please see [Overview](https://mmrotate.readthedocs.io/en/1.x/overview.html) for
9292
For detailed user guides and advanced guides, please refer to our [documentation](https://mmrotate.readthedocs.io/en/1.x/):
9393

9494
- User Guides
95-
96-
<details>
97-
9895
- [Train & Test](https://mmrotate.readthedocs.io/en/1.x/user_guides/index.html#train-test)
9996
- [Learn about Configs](https://mmrotate.readthedocs.io/en/1.x/user_guides/config.html)
10097
- [Inference with existing models](https://mmrotate.readthedocs.io/en/1.x/user_guides/inference.html)
@@ -103,22 +100,14 @@ For detailed user guides and advanced guides, please refer to our [documentation
103100
- [Train predefined models on standard datasets](https://mmrotate.readthedocs.io/en/1.x/user_guides/train_test.html)
104101
- [Test Results Submission](https://mmrotate.readthedocs.io/en/1.x/user_guides/test_results_submission.html)
105102
- [Useful Tools](https://mmrotate.readthedocs.io/en/1.x/user_guides/index.html#useful-tools)
106-
107-
</details>
108-
109103
- Advanced Guides
110-
111-
<details>
112-
113104
- [Basic Concepts](https://mmrotate.readthedocs.io/en/1.x/advanced_guides/index.html#basic-concepts)
114105
- [Component Customization](https://mmrotate.readthedocs.io/en/1.x/advanced_guides/index.html#component-customization)
115106
- [How to](https://mmrotate.readthedocs.io/en/1.x/advanced_guides/index.html#how-to)
116107

117-
</details>
118-
119-
We also provide [colab tutorial](demo/MMRotate_Tutorial.ipynb).
108+
We also provide colab tutorial [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](demo/MMRotate_Tutorial.ipynb).
120109

121-
To migrate from MMRotate 0.x, please refer to [migration](https://mmdetection.readthedocs.io/en/1.x/migration.html).
110+
To migrate from MMRotate 0.x, please refer to [migration](https://mmrotate.readthedocs.io/en/1.x/migration.html).
122111

123112
## Model Zoo
124113

README_zh-CN.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,6 @@ https://user-images.githubusercontent.com/10410257/154433305-416d129b-60c8-44c7-
8888
为了帮助用户更进一步了解 MMDetection,我们准备了用户指南和进阶指南,请阅读我们的[文档](https://mmrotate.readthedocs.io/zh_CN/1.x/)
8989

9090
- 用户指南
91-
92-
<details>
93-
9491
- [训练 & 测试](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/index.html#train-test)
9592
- [学习配置文件](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/config.html)
9693
- [使用已有模型在标准数据集上进行推理](https://mmrotate.readthedocs.io/en/1.x/user_guides/inference.html)
@@ -99,20 +96,14 @@ https://user-images.githubusercontent.com/10410257/154433305-416d129b-60c8-44c7-
9996
- [在标准数据集上训练预定义的模型](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/train_test.html#train)
10097
- [提交测试结果](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/test_results_submission.html)
10198
- [实用工具](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/index.html#useful-tools)
102-
103-
</details>
104-
10599
- 进阶指南
106-
107-
<details>
108-
109100
- [基础概念](https://mmrotate.readthedocs.io/zh_CN/1.x/advanced_guides/index.html#basic-concepts)
110101
- [组件定制](https://mmrotate.readthedocs.io/zh_CN/1.x/advanced_guides/index.html#component-customization)
111102
- [How to](https://mmrotate.readthedocs.io/zh_CN/1.x/advanced_guides/index.html#how-to)
112103

113-
</details>
104+
我们提供了旋转检测的 colab 教程 [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](demo/MMRotate_Tutorial.ipynb)
114105

115-
我们提供了 [旋转检测的 colab 教程](demo/MMRotate_Tutorial.ipynb)
106+
若需要将0.x版本的代码迁移至新版,请参考[迁移文档](https://mmrotate.readthedocs.io/zh_CN/1.x/migration.html)
116107

117108
## 模型库
118109

docs/en/migration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Migration

docs/zh_cn/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Welcome to MMRotate's documentation!
2222

2323
.. toctree::
2424
:maxdepth: 1
25-
:caption: 迁移版本
25+
:caption: 迁移指南
2626

2727
migration.md
2828

docs/zh_cn/migration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Migration

0 commit comments

Comments
 (0)