From 83eea4bec684708171f0b6433636df0873e50dac Mon Sep 17 00:00:00 2001 From: BigDong Date: Thu, 16 Dec 2021 15:27:20 +0800 Subject: [PATCH] [Fix] fix link (#6796) * [Fix] fix lint --- README.md | 18 +++++++++--------- README_zh-CN.md | 16 ++++++++-------- docs/en/changelog.md | 2 +- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index abd0e4f2dc8..09231c7603d 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,13 @@ This project is released under the [Apache 2.0 license](LICENSE). - Add abstract and sketch of the papers in readmes - Fix some weight initialization bugs -Please refer to [changelog.md](docs/changelog.md) for details and release history. +Please refer to [changelog.md](docs/en/changelog.md) for details and release history. -For compatibility changes between different versions of MMDetection, please refer to [compatibility.md](docs/compatibility.md). +For compatibility changes between different versions of MMDetection, please refer to [compatibility.md](docs/en/compatibility.md). ## Benchmark and model zoo -Results and models are available in the [model zoo](docs/model_zoo.md). +Results and models are available in the [model zoo](docs/en/model_zoo.md).
@@ -151,19 +151,19 @@ Results and models are available in the [model zoo](docs/model_zoo.md). - [x] [QueryInst (ICCV'2021)](configs/queryinst/README.md)
-Some other methods are also supported in [projects using MMDetection](./docs/projects.md). +Some other methods are also supported in [projects using MMDetection](./docs/en/projects.md). ## Installation -Please refer to [get_started.md](docs/get_started.md) for installation. +Please refer to [get_started.md](docs/en/get_started.md) for installation. ## Getting Started -Please see [get_started.md](docs/get_started.md) for the basic usage of MMDetection. -We provide [colab tutorial](demo/MMDet_Tutorial.ipynb), and full guidance for quick run [with existing dataset](docs/1_exist_data_model.md) and [with new dataset](docs/2_new_data_model.md) for beginners. -There are also tutorials for [finetuning models](docs/tutorials/finetune.md), [adding new dataset](docs/tutorials/customize_dataset.md), [designing data pipeline](docs/tutorials/data_pipeline.md), [customizing models](docs/tutorials/customize_models.md), [customizing runtime settings](docs/tutorials/customize_runtime.md) and [useful tools](docs/useful_tools.md). +Please see [get_started.md](docs/en/get_started.md) for the basic usage of MMDetection. +We provide [colab tutorial](demo/MMDet_Tutorial.ipynb), and full guidance for quick run [with existing dataset](docs/en/1_exist_data_model.md) and [with new dataset](docs/en/2_new_data_model.md) for beginners. +There are also tutorials for [finetuning models](docs/en/tutorials/finetune.md), [adding new dataset](docs/en/tutorials/customize_dataset.md), [designing data pipeline](docs/en/tutorials/data_pipeline.md), [customizing models](docs/en/tutorials/customize_models.md), [customizing runtime settings](docs/en/tutorials/customize_runtime.md) and [useful tools](docs/en/useful_tools.md). -Please refer to [FAQ](docs/faq.md) for frequently asked questions. +Please refer to [FAQ](docs/en/faq.md) for frequently asked questions. ## Contributing diff --git a/README_zh-CN.md b/README_zh-CN.md index 9162b9964a5..846b4f4a93d 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -66,11 +66,11 @@ MMDetection 是一个基于 PyTorch 的目标检测开源工具箱。它是 [Ope 如果想了解更多版本更新细节和历史信息，请阅读[更新日志](docs/changelog.md)。 -如果想了解 MMDetection 不同版本之间的兼容性, 请参考[兼容性说明文档](docs/compatibility.md)。 +如果想了解 MMDetection 不同版本之间的兼容性, 请参考[兼容性说明文档](docs/zh_cn/compatibility.md)。 ## 基准测试和模型库 -测试结果和模型可以在[模型库](docs/model_zoo.md)中找到。 +测试结果和模型可以在[模型库](docs/zh_cn/model_zoo.md)中找到。
已支持的骨干网络： @@ -148,20 +148,20 @@ MMDetection 是一个基于 PyTorch 的目标检测开源工具箱。它是 [Ope - [x] [QueryInst (ICCV'2021)](configs/queryinst/README.md)
-我们在[基于 MMDetection 的项目](./docs/projects.md)中列举了一些其他的支持的算法。 +我们在[基于 MMDetection 的项目](./docs/zh_cn/projects.md)中列举了一些其他的支持的算法。 ## 安装 -请参考[快速入门文档](docs/get_started.md)进行安装。 +请参考[快速入门文档](docs/zh_cn/get_started.md)进行安装。 ## 快速入门 -请参考[快速入门文档](docs/get_started.md)学习 MMDetection 的基本使用。 -我们提供了 [colab 教程](demo/MMDet_Tutorial.ipynb)，也为新手提供了完整的运行教程，分别针对[已有数据集](docs/1_exist_data_model.md)和[新数据集](docs/2_new_data_model.md) 完整的使用指南 +请参考[快速入门文档](docs/zh_cn/get_started.md)学习 MMDetection 的基本使用。 +我们提供了 [colab 教程](demo/MMDet_Tutorial.ipynb)，也为新手提供了完整的运行教程，分别针对[已有数据集](docs/zh_cn/1_exist_data_model.md)和[新数据集](docs/zh_cn/2_new_data_model.md) 完整的使用指南 -我们也提供了一些进阶教程，内容覆盖了 [finetune 模型](docs/tutorials/finetune.md)，[增加新数据集支持](docs/tutorials/customize_dataset.md)，[设计新的数据预处理流程](docs/tutorials/data_pipeline.md)，[增加自定义模型](docs/tutorials/customize_models.md)，[增加自定义的运行时配置](docs/tutorials/customize_runtime.md)，[常用工具和脚本](docs/useful_tools.md)。 +我们也提供了一些进阶教程，内容覆盖了 [finetune 模型](docs/zh_cn/tutorials/finetune.md)，[增加新数据集支持](docs/zh_cn/tutorials/customize_dataset.md)，[设计新的数据预处理流程](docs/zh_cn/tutorials/data_pipeline.md)，[增加自定义模型](docs/zh_cn/tutorials/customize_models.md)，[增加自定义的运行时配置](docs/zh_cn/tutorials/customize_runtime.md)，[常用工具和脚本](docs/zh_cn/useful_tools.md)。 -如果遇到问题，请参考 [常见问题解答](docs_zh-CN/faq.md)。 +如果遇到问题，请参考 [常见问题解答](docs/zh_cn/faq.md)。 ## 贡献指南 diff --git a/docs/en/changelog.md b/docs/en/changelog.md index 896884cda65..7a6d81dd637 100644 --- a/docs/en/changelog.md +++ b/docs/en/changelog.md @@ -101,7 +101,7 @@ Thanks @FloydHsiu, @RangiLyu, @ZwwWayne, @AndreaPi, @st9007a, @hachreak, @BIGWan #### Documents -- Chinese version of [Corruption Benchmarking](docs/robustness_benchmarking.mddocs/robustness_benchmarking.md) (#6375) +- Chinese version of [Corruption Benchmarking](robustness_benchmarking.md) (#6375) - Fix config path in docs (#6396) - Update GRoIE readme (#6401)