[Docs] Refine some docs (#1455)

* [Docs] Refine some docs

* fix the link to mmcv

docs/en/conf.py

@@ -164,7 +164,7 @@ intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
     'numpy': ('https://numpy.org/doc/stable', None),
     'torch': ('https://pytorch.org/docs/stable/', None),
-    'mmcv': ('https://mmcv.readthedocs.io/en/dev-2.x/', None),
+    'mmcv': ('https://mmcv.readthedocs.io/en/2.x/', None),
     'mmengine': ('https://mmengine.readthedocs.io/en/latest/', None),
     'mmdetection': ('https://mmdetection.readthedocs.io/en/dev-3.x/', None),
 }

docs/en/get_started/quick_run.md

@@ -51,7 +51,7 @@ param_scheduler = [dict(type='ConstantLR', factor=1.0),]
 
 Here, we have rewritten the corresponding parameters in the base configuration directly through the [inheritance](https://mmengine.readthedocs.io/en/latest/tutorials/config.html) mechanism of the configuration. The original fields are distributed in `configs/_base_/schedules/schedule_sgd_1200e.py` and `configs/_base_/textdet_default_runtime.py`. You may check them out if interested.
 
-```{tip}
+```{note}
 For a more detailed description of config, please refer to [here](../user_guides/config.md).
 ```
 
@@ -98,7 +98,7 @@ Depending on the system environment, MMOCR will automatically use the best devic
 
 Without extra configurations, model weights will be saved to `work_dirs/dbnet_resnet18_fpnc_1200e_icdar2015/`, while the logs will be stored in `work_dirs/dbnet_resnet18_fpnc_1200e_icdar2015/TIMESTAMP/`. Next, we just need to wait with some patience for training to finish.
 
-```{tip}
+```{note}
 For advanced usage of training, such as CPU training, multi-GPU training, and cluster training, please refer to [Training and Testing](../user_guides/train_test.md).
 ```
 
@@ -151,7 +151,7 @@ And get the outputs:
 
 The model achieves an hmean of 0.6667 on this dataset.
 
-```{tip}
+```{note}
 For advanced usage of testing, such as CPU testing, multi-GPU testing, and cluster testing, please refer to [Training and Testing](../user_guides/train_test.md).
 ```
 
@@ -169,6 +169,6 @@ The true labels and predicted values are displayed in a tiled fashion in the vis
     <img src="https://user-images.githubusercontent.com/22607038/187423562-6a85e209-4b12-46ee-8a41-5c67b1ba83f9.png"/><br>
 </div>
 
-```{tip}
+```{note}
 For a description of more visualization features, see [here](../user_guides/visualization.md).
 ```

docs/en/index.rst

@@ -26,14 +26,14 @@ You can switch between English and Chinese in the lower-left corner of the layou
    :maxdepth: 2
    :caption: Basic Concepts
 
+   basic_concepts/structures.md
+   basic_concepts/transforms.md
+   basic_concepts/evaluation.md
    basic_concepts/overview.md
    basic_concepts/data_flow.md
    basic_concepts/datasets.md
-   basic_concepts/structures.md
    basic_concepts/models.md
-   basic_concepts/transforms.md
    basic_concepts/visualizers.md
-   basic_concepts/evaluation.md
    basic_concepts/convention.md
    basic_concepts/engine.md
 

docs/zh_cn/conf.py

@@ -161,7 +161,7 @@ intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
     'numpy': ('https://numpy.org/doc/stable', None),
     'torch': ('https://pytorch.org/docs/stable/', None),
-    'mmcv': ('https://mmcv.readthedocs.io/zh_CN/dev-2.x/', None),
+    'mmcv': ('https://mmcv.readthedocs.io/zh_CN/2.x/', None),
     'mmengine': ('https://mmengine.readthedocs.io/zh_CN/latest/', None),
     'mmdetection': ('https://mmdetection.readthedocs.io/zh_CN/dev-3.x/', None),
 }

docs/zh_cn/get_started/quick_run.md

@@ -53,7 +53,7 @@ param_scheduler = [dict(type='ConstantLR', factor=1.0),]
 
 这里，我们通过配置的[继承](https://mmengine.readthedocs.io/zh_CN/latest/tutorials/config.html)机制将基础配置中的相应参数直接进行了改写。原本的字段分布在 `configs/_base_/schedules/schedule_sgd_1200e.py` 和 `configs/_base_/textdet_default_runtime.py` 中，感兴趣的读者可以自行查看。
 
-```{tip}
+```{note}
 关于配置文件更加详尽的说明，请参考[此处](../user_guides/config.md)。
 ```
 
@@ -100,7 +100,7 @@ python tools/train.py configs/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015.
 
 在不指定额外参数时，训练的权重默认会被保存到 `work_dirs/dbnet_resnet18_fpnc_1200e_icdar2015/` 下面，而日志则会保存在`work_dirs/dbnet_resnet18_fpnc_1200e_icdar2015/开始训练的时间戳/`里。接下来，我们只需要耐心等待模型训练完成即可。
 
-```{tip}
+```{note}
 若需要了解训练的高级用法，如 CPU 训练、多卡训练及集群训练等，请查阅[训练与测试](../user_guides/train_test.md)。
 ```
 
@@ -153,7 +153,7 @@ python tools/test.py configs/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015.p
 
 可以发现，模型在这个数据集上能达到的 hmean 为 0.6667，效果还是不错的。
 
-```{tip}
+```{note}
 若需要了解测试的高级用法，如 CPU 测试、多卡测试及集群测试等，请查阅[训练与测试](../user_guides/train_test.md)。
 ```
 
@@ -171,6 +171,6 @@ python tools/test.py configs/textdet/dbnet/dbnet_resnet18_fpnc_1200e_icdar2015.p
     <img src="https://user-images.githubusercontent.com/22607038/187423562-6a85e209-4b12-46ee-8a41-5c67b1ba83f9.png"/><br>
 </div>
 
-```{tip}
+```{note}
 有关更多可视化功能的介绍，请参阅[这里](../user_guides/visualization.md)。
 ```

docs/zh_cn/index.rst

@@ -26,14 +26,14 @@
    :maxdepth: 2
    :caption: 基础概念
 
+   basic_concepts/structures.md
+   basic_concepts/models.md
+   basic_concepts/evaluation.md
    basic_concepts/overview.md
    basic_concepts/data_flow.md
    basic_concepts/datasets.md
-   basic_concepts/structures.md
-   basic_concepts/models.md
    basic_concepts/transforms.md
    basic_concepts/visualizers.md
-   basic_concepts/evaluation.md
    basic_concepts/convention.md
    basic_concepts/engine.md
 

docs/zh_cn/notes/contribution_guide.md

@@ -80,7 +80,7 @@ git checkout -b branchname
   有时你的文件可能会在提交时被 pre-commit hooks 自动修改。这时请重新添加并提交修改后的文件。
   ```
 
-### 4. 推送你的修改到复刻的代码库，并创建一个`拉取请求`
+### 4. 推送你的修改到复刻的代码库，并创建一个拉取请求
 
 - 推送当前分支到远端复刻的代码库
 
@@ -88,12 +88,13 @@ git checkout -b branchname
   git push origin branchname
   ```
 
-- 创建一个`拉取请求`
+- 创建一个拉取请求
+
   ![avatar](https://user-images.githubusercontent.com/22607038/195053564-71bd3cb4-b8d4-4ed9-9075-051e138b7fd4.png)
 
-- 修改`拉取请求`信息模板，描述修改原因和修改内容。还可以在 PR 描述中，手动关联到相关的`议题` (issue),（更多细节，请参考[官方文档](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)）。
+- 修改拉取请求信息模板，描述修改原因和修改内容。还可以在 PR 描述中，手动关联到相关的议题 (issue),（更多细节，请参考[官方文档](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)）。
 
-- 另外，如果你正在往 `dev-1.x` 分支提交代码，你还需要在创建 PR 的界面中将基础分支改为 \`\`dev-1.x`，因为现在默认的基础分支是 `main\`。
+- 另外，如果你正在往 `dev-1.x` 分支提交代码，你还需要在创建 PR 的界面中将基础分支改为 `dev-1.x`，因为现在默认的基础分支是 `main`。
 
   ![avatar](https://user-images.githubusercontent.com/22607038/195045928-f3ceedc8-0162-46a7-ae1a-7e22829fe189.png)
 

docs/zh_cn/user_guides/config.md

@@ -1,4 +1,4 @@
-# 配置文档
+# 配置文件
 
 MMOCR 主要使用 Python 文件作为配置文件。其配置文件系统的设计整合了模块化与继承的思想，方便用户进行各种实验。