Skip to content

Commit

Permalink
Update readme of 1.0.0rc0 (#603)
Browse files Browse the repository at this point in the history
* update

* Update README_zh-CN.md
  • Loading branch information
zytx121 authored and RangiLyu committed Nov 7, 2022
1 parent 3466768 commit 766185e
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 25 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,6 @@ Please see [Overview](https://mmrotate.readthedocs.io/en/1.x/overview.html) for
For detailed user guides and advanced guides, please refer to our [documentation](https://mmrotate.readthedocs.io/en/1.x/):

- User Guides

<details>

- [Train & Test](https://mmrotate.readthedocs.io/en/1.x/user_guides/index.html#train-test)
- [Learn about Configs](https://mmrotate.readthedocs.io/en/1.x/user_guides/config.html)
- [Inference with existing models](https://mmrotate.readthedocs.io/en/1.x/user_guides/inference.html)
Expand All @@ -103,22 +100,14 @@ For detailed user guides and advanced guides, please refer to our [documentation
- [Train predefined models on standard datasets](https://mmrotate.readthedocs.io/en/1.x/user_guides/train_test.html)
- [Test Results Submission](https://mmrotate.readthedocs.io/en/1.x/user_guides/test_results_submission.html)
- [Useful Tools](https://mmrotate.readthedocs.io/en/1.x/user_guides/index.html#useful-tools)

</details>

- Advanced Guides

<details>

- [Basic Concepts](https://mmrotate.readthedocs.io/en/1.x/advanced_guides/index.html#basic-concepts)
- [Component Customization](https://mmrotate.readthedocs.io/en/1.x/advanced_guides/index.html#component-customization)
- [How to](https://mmrotate.readthedocs.io/en/1.x/advanced_guides/index.html#how-to)

</details>

We also provide [colab tutorial](demo/MMRotate_Tutorial.ipynb).
We also provide colab tutorial [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](demo/MMRotate_Tutorial.ipynb).

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

## Model Zoo

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

- 用户指南

<details>

- [训练 & 测试](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/index.html#train-test)
- [学习配置文件](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/config.html)
- [使用已有模型在标准数据集上进行推理](https://mmrotate.readthedocs.io/en/1.x/user_guides/inference.html)
Expand All @@ -99,20 +96,14 @@ https://user-images.githubusercontent.com/10410257/154433305-416d129b-60c8-44c7-
- [在标准数据集上训练预定义的模型](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/train_test.html#train)
- [提交测试结果](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/test_results_submission.html)
- [实用工具](https://mmrotate.readthedocs.io/zh_CN/1.x/user_guides/index.html#useful-tools)

</details>

- 进阶指南

<details>

- [基础概念](https://mmrotate.readthedocs.io/zh_CN/1.x/advanced_guides/index.html#basic-concepts)
- [组件定制](https://mmrotate.readthedocs.io/zh_CN/1.x/advanced_guides/index.html#component-customization)
- [How to](https://mmrotate.readthedocs.io/zh_CN/1.x/advanced_guides/index.html#how-to)

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

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

## 模型库

Expand Down
1 change: 1 addition & 0 deletions docs/en/migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Migration
2 changes: 1 addition & 1 deletion docs/zh_cn/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Welcome to MMRotate's documentation!

.. toctree::
:maxdepth: 1
:caption: 迁移版本
:caption: 迁移指南

migration.md

Expand Down
1 change: 1 addition & 0 deletions docs/zh_cn/migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Migration

0 comments on commit 766185e

Please sign in to comment.