diff --git a/README.md b/README.md
index 9937d7ba196..00d92d32bc4 100644
--- a/README.md
+++ b/README.md
@@ -44,11 +44,11 @@ Highlights of this version:
- Support **ImageNet21k** dataset.
- Add a **pipeline visualization** tool. Try it with the [tutorials](https://mmclassification.readthedocs.io/en/latest/tools/visualization.html#pipeline-visualization)!
-Please refer to [changelog.md](docs/changelog.md) for more details and other release history.
+Please refer to [changelog.md](docs/en/changelog.md) for more details and other release history.
## 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).
Supported backbones:
@@ -74,21 +74,21 @@ Supported backbones:
## Installation
-Please refer to [install.md](docs/install.md) for installation and dataset preparation.
+Please refer to [install.md](docs/en/install.md) for installation and dataset preparation.
## Getting Started
-Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMClassification. There are also tutorials:
+Please see [getting_started.md](docs/en/getting_started.md) for the basic usage of MMClassification. There are also tutorials:
-- [learn about configs](docs/tutorials/config.md)
-- [finetuning models](docs/tutorials/finetune.md)
-- [adding new dataset](docs/tutorials/new_dataset.md)
-- [designing data pipeline](docs/tutorials/data_pipeline.md)
-- [adding new modules](docs/tutorials/new_modules.md)
-- [customizing schedule](docs/tutorials/schedule.md)
-- [customizing runtime settings](docs/tutorials/runtime.md)
+- [learn about configs](docs/en/tutorials/config.md)
+- [finetuning models](docs/en/tutorials/finetune.md)
+- [adding new dataset](docs/en/tutorials/new_dataset.md)
+- [designing data pipeline](docs/en/tutorials/data_pipeline.md)
+- [adding new modules](docs/en/tutorials/new_modules.md)
+- [customizing schedule](docs/en/tutorials/schedule.md)
+- [customizing runtime settings](docs/en/tutorials/runtime.md)
-Colab tutorials are also provided. To learn about MMClassification Python API, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_python.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_python.ipynb) on Colab.
-To learn about MMClassification shell tools, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_tools.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/tutorials/MMClassification_tools.ipynb) on Colab.
+Colab tutorials are also provided. To learn about MMClassification Python API, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_python.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_python.ipynb) on Colab.
+To learn about MMClassification shell tools, you may preview the notebook [here](https://github.com/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_tools.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/en/tutorials/MMClassification_tools.ipynb) on Colab.
## Citation
@@ -106,7 +106,7 @@ If you find this project useful in your research, please consider cite:
## Contributing
We appreciate all contributions to improve MMClassification.
-Please refer to [CONTRUBUTING.md](docs/community/CONTRIBUTING.md) for the contributing guideline.
+Please refer to [CONTRUBUTING.md](docs/en/community/CONTRIBUTING.md) for the contributing guideline.
## Acknowledgement
diff --git a/README_zh-CN.md b/README_zh-CN.md
index 3c32d0fea9c..c90bcb3f34c 100644
--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -43,11 +43,11 @@ MMClassification 是一款基于 PyTorch 的开源图像分类工具箱,是 [O
- 支持了 **ImageNet21k** 数据集
- 添加了一个**可视化数据预处理**的工具,可以参考[教程](https://mmclassification.readthedocs.io/zh_CN/latest/tools/visualization.html#id2)使用
-发布历史和更新细节请参考 [更新日志](docs/changelog.md)
+发布历史和更新细节请参考 [更新日志](docs/en/changelog.md)
## 基准测试及模型库
-相关结果和模型可在 [model zoo](docs/model_zoo.md) 中获得
+相关结果和模型可在 [model zoo](docs/en/model_zoo.md) 中获得
支持的主干网络:
@@ -73,25 +73,25 @@ MMClassification 是一款基于 PyTorch 的开源图像分类工具箱,是 [O
## 安装
-请参考 [安装指南](docs_zh-CN/install.md) 进行安装
+请参考 [安装指南](docs/zh_CN/install.md) 进行安装
## 基础教程
-请参考 [基础教程](docs_zh-CN/getting_started.md) 来了解 MMClassification 的基本使用。MMClassification 也提供了其他更详细的教程:
+请参考 [基础教程](docs/zh_CN/getting_started.md) 来了解 MMClassification 的基本使用。MMClassification 也提供了其他更详细的教程:
-- [如何编写配置文件](docs_zh-CN/tutorials/config.md)
-- [如何微调模型](docs_zh-CN/tutorials/finetune.md)
-- [如何增加新数据集](docs_zh-CN/tutorials/new_dataset.md)
-- [如何设计数据处理流程](/docs_zh-CN/tutorials/data_pipeline.md)
-- [如何增加新模块](docs_zh-CN/tutorials/new_modules.md)
-- [如何自定义优化策略](tutorials/schedule.md)
-- [如何自定义运行参数](tutorials/runtime.md)
+- [如何编写配置文件](docs/zh_CN/tutorials/config.md)
+- [如何微调模型](docs/zh_CN/tutorials/finetune.md)
+- [如何增加新数据集](docs/zh_CN/tutorials/new_dataset.md)
+- [如何设计数据处理流程](/docs/zh_CN/tutorials/data_pipeline.md)
+- [如何增加新模块](docs/zh_CN/tutorials/new_modules.md)
+- [如何自定义优化策略](docs/zh_CN/tutorials/schedule.md)
+- [如何自定义运行参数](docs/zh_CN/tutorials/runtime.md)
-MMClassification 也提供了相应的中文 Colab 教程。了解 MMClassification Python API,可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_python_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_python_cn.ipynb)。了解 MMClassification 命令行工具,可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_tools_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs_zh-CN/tutorials/MMClassification_tools_cn.ipynb)。
+MMClassification 也提供了相应的中文 Colab 教程。了解 MMClassification Python API,可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_python_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_python_cn.ipynb)。了解 MMClassification 命令行工具,可以查看 [这里](https://github.com/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_tools_cn.ipynb) 或者直接在 Colab 上 [运行](https://colab.research.google.com/github/open-mmlab/mmclassification/blob/master/docs/zh_CN/tutorials/MMClassification_tools_cn.ipynb)。
## 参与贡献
-我们非常欢迎任何有助于提升 MMClassification 的贡献,请参考 [贡献指南](docs_zh-CN/community/CONTRIBUTING.md) 来了解如何参与贡献。
+我们非常欢迎任何有助于提升 MMClassification 的贡献,请参考 [贡献指南](docs/zh_CN/community/CONTRIBUTING.md) 来了解如何参与贡献。
## 致谢
@@ -121,7 +121,7 @@ MMClassification 是一款由不同学校和公司共同贡献的开源项目。
扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab),加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=GJP18SjI)
我们会在 OpenMMLab 社区为大家
diff --git a/docs/Makefile b/docs/en/Makefile
similarity index 100%
rename from docs/Makefile
rename to docs/en/Makefile
diff --git a/docs/_static/css/readthedocs.css b/docs/en/_static/css/readthedocs.css
similarity index 100%
rename from docs/_static/css/readthedocs.css
rename to docs/en/_static/css/readthedocs.css
diff --git a/docs/_static/image/mmcls-logo.png b/docs/en/_static/image/mmcls-logo.png
similarity index 100%
rename from docs/_static/image/mmcls-logo.png
rename to docs/en/_static/image/mmcls-logo.png
diff --git a/docs/_static/image/tools/analysis/analyze_log.jpg b/docs/en/_static/image/tools/analysis/analyze_log.jpg
similarity index 100%
rename from docs/_static/image/tools/analysis/analyze_log.jpg
rename to docs/en/_static/image/tools/analysis/analyze_log.jpg
diff --git a/docs/_static/image/tools/visualization/lr_schedule1.png b/docs/en/_static/image/tools/visualization/lr_schedule1.png
similarity index 100%
rename from docs/_static/image/tools/visualization/lr_schedule1.png
rename to docs/en/_static/image/tools/visualization/lr_schedule1.png
diff --git a/docs/_static/image/tools/visualization/lr_schedule2.png b/docs/en/_static/image/tools/visualization/lr_schedule2.png
similarity index 100%
rename from docs/_static/image/tools/visualization/lr_schedule2.png
rename to docs/en/_static/image/tools/visualization/lr_schedule2.png
diff --git a/docs/_static/image/tools/visualization/pipeline-concat.jpg b/docs/en/_static/image/tools/visualization/pipeline-concat.jpg
similarity index 100%
rename from docs/_static/image/tools/visualization/pipeline-concat.jpg
rename to docs/en/_static/image/tools/visualization/pipeline-concat.jpg
diff --git a/docs/_static/image/tools/visualization/pipeline-original.jpg b/docs/en/_static/image/tools/visualization/pipeline-original.jpg
similarity index 100%
rename from docs/_static/image/tools/visualization/pipeline-original.jpg
rename to docs/en/_static/image/tools/visualization/pipeline-original.jpg
diff --git a/docs/_static/image/tools/visualization/pipeline-pipeline.jpg b/docs/en/_static/image/tools/visualization/pipeline-pipeline.jpg
similarity index 100%
rename from docs/_static/image/tools/visualization/pipeline-pipeline.jpg
rename to docs/en/_static/image/tools/visualization/pipeline-pipeline.jpg
diff --git a/docs/_static/js/custom.js b/docs/en/_static/js/custom.js
similarity index 100%
rename from docs/_static/js/custom.js
rename to docs/en/_static/js/custom.js
diff --git a/docs/api.rst b/docs/en/api.rst
similarity index 100%
rename from docs/api.rst
rename to docs/en/api.rst
diff --git a/docs/changelog.md b/docs/en/changelog.md
similarity index 100%
rename from docs/changelog.md
rename to docs/en/changelog.md
diff --git a/docs/community/CONTRIBUTING.md b/docs/en/community/CONTRIBUTING.md
similarity index 100%
rename from docs/community/CONTRIBUTING.md
rename to docs/en/community/CONTRIBUTING.md
diff --git a/docs/conf.py b/docs/en/conf.py
similarity index 69%
rename from docs/conf.py
rename to docs/en/conf.py
index a25b8cf4c82..1fe7701f564 100644
--- a/docs/conf.py
+++ b/docs/en/conf.py
@@ -17,7 +17,7 @@
import pytorch_sphinx_theme
from sphinx.builders.html import StandaloneHTMLBuilder
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../../'))
# -- Project information -----------------------------------------------------
@@ -26,7 +26,7 @@
author = 'MMClassification Authors'
# The full version, including alpha/beta/rc tags
-version_file = '../mmcls/version.py'
+version_file = '../../mmcls/version.py'
def get_version():
@@ -116,96 +116,10 @@ def get_version():
},
]
},
- {
- 'name':
- 'Docs',
- 'children': [
- {
- 'name': 'MMCV',
- 'url': 'https://mmcv.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MIM',
- 'url': 'https://openmim.readthedocs.io/en/latest/'
- },
- {
- 'name': 'MMAction2',
- 'url': 'https://mmaction2.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMClassification',
- 'url':
- 'https://mmclassification.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMDetection',
- 'url': 'https://mmdetection.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMDetection3D',
- 'url': 'https://mmdetection3d.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMEditing',
- 'url': 'https://mmediting.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMGeneration',
- 'url': 'https://mmgeneration.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMOCR',
- 'url': 'https://mmocr.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMPose',
- 'url': 'https://mmpose.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMSegmentation',
- 'url': 'https://mmsegmentation.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMTracking',
- 'url': 'https://mmtracking.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMFlow',
- 'url': 'https://mmflow.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMFewShot',
- 'url': 'https://mmfewshot.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMHuman3d',
- 'url': 'https://mmhuman3d.readthedocs.io/en/latest/',
- },
- ]
- },
- {
- 'name':
- 'OpenMMLab',
- 'children': [
- {
- 'name': 'Homepage',
- 'url': 'https://openmmlab.com/'
- },
- {
- 'name': 'GitHub',
- 'url': 'https://github.com/open-mmlab/'
- },
- {
- 'name': 'Twitter',
- 'url': 'https://twitter.com/OpenMMLab'
- },
- {
- 'name': 'Zhihu',
- 'url': 'https://zhihu.com/people/openmmlab'
- },
- ]
- },
- ]
+ ],
+ # Specify the language of shared menu
+ 'menu_lang':
+ 'en'
}
# Add any paths that contain custom static files (such as style sheets) here,
diff --git a/docs/getting_started.md b/docs/en/getting_started.md
similarity index 100%
rename from docs/getting_started.md
rename to docs/en/getting_started.md
diff --git a/docs/index.rst b/docs/en/index.rst
similarity index 100%
rename from docs/index.rst
rename to docs/en/index.rst
diff --git a/docs/install.md b/docs/en/install.md
similarity index 100%
rename from docs/install.md
rename to docs/en/install.md
diff --git a/docs/model_zoo.md b/docs/en/model_zoo.md
similarity index 100%
rename from docs/model_zoo.md
rename to docs/en/model_zoo.md
diff --git a/docs/stat.py b/docs/en/stat.py
similarity index 97%
rename from docs/stat.py
rename to docs/en/stat.py
index feee2fe0aad..7d47b07f8f5 100755
--- a/docs/stat.py
+++ b/docs/en/stat.py
@@ -12,7 +12,7 @@
papers_root = Path('papers')
papers_root.mkdir(exist_ok=True)
-files = [Path(f) for f in sorted(glob.glob('../configs/*/README.md'))]
+files = [Path(f) for f in sorted(glob.glob('../../configs/*/README.md'))]
stats = []
titles = []
diff --git a/docs/tools/analysis.md b/docs/en/tools/analysis.md
similarity index 100%
rename from docs/tools/analysis.md
rename to docs/en/tools/analysis.md
diff --git a/docs/tools/miscellaneous.md b/docs/en/tools/miscellaneous.md
similarity index 100%
rename from docs/tools/miscellaneous.md
rename to docs/en/tools/miscellaneous.md
diff --git a/docs/tools/model_serving.md b/docs/en/tools/model_serving.md
similarity index 100%
rename from docs/tools/model_serving.md
rename to docs/en/tools/model_serving.md
diff --git a/docs/tools/onnx2tensorrt.md b/docs/en/tools/onnx2tensorrt.md
similarity index 100%
rename from docs/tools/onnx2tensorrt.md
rename to docs/en/tools/onnx2tensorrt.md
diff --git a/docs/tools/pytorch2onnx.md b/docs/en/tools/pytorch2onnx.md
similarity index 100%
rename from docs/tools/pytorch2onnx.md
rename to docs/en/tools/pytorch2onnx.md
diff --git a/docs/tools/pytorch2torchscript.md b/docs/en/tools/pytorch2torchscript.md
similarity index 100%
rename from docs/tools/pytorch2torchscript.md
rename to docs/en/tools/pytorch2torchscript.md
diff --git a/docs/tools/visualization.md b/docs/en/tools/visualization.md
similarity index 100%
rename from docs/tools/visualization.md
rename to docs/en/tools/visualization.md
diff --git a/docs/tutorials/MMClassification_python.ipynb b/docs/en/tutorials/MMClassification_python.ipynb
similarity index 100%
rename from docs/tutorials/MMClassification_python.ipynb
rename to docs/en/tutorials/MMClassification_python.ipynb
diff --git a/docs/tutorials/MMClassification_tools.ipynb b/docs/en/tutorials/MMClassification_tools.ipynb
similarity index 100%
rename from docs/tutorials/MMClassification_tools.ipynb
rename to docs/en/tutorials/MMClassification_tools.ipynb
diff --git a/docs/tutorials/config.md b/docs/en/tutorials/config.md
similarity index 100%
rename from docs/tutorials/config.md
rename to docs/en/tutorials/config.md
diff --git a/docs/tutorials/data_pipeline.md b/docs/en/tutorials/data_pipeline.md
similarity index 100%
rename from docs/tutorials/data_pipeline.md
rename to docs/en/tutorials/data_pipeline.md
diff --git a/docs/tutorials/finetune.md b/docs/en/tutorials/finetune.md
similarity index 100%
rename from docs/tutorials/finetune.md
rename to docs/en/tutorials/finetune.md
diff --git a/docs/tutorials/new_dataset.md b/docs/en/tutorials/new_dataset.md
similarity index 100%
rename from docs/tutorials/new_dataset.md
rename to docs/en/tutorials/new_dataset.md
diff --git a/docs/tutorials/new_modules.md b/docs/en/tutorials/new_modules.md
similarity index 100%
rename from docs/tutorials/new_modules.md
rename to docs/en/tutorials/new_modules.md
diff --git a/docs/tutorials/runtime.md b/docs/en/tutorials/runtime.md
similarity index 100%
rename from docs/tutorials/runtime.md
rename to docs/en/tutorials/runtime.md
diff --git a/docs/tutorials/schedule.md b/docs/en/tutorials/schedule.md
similarity index 100%
rename from docs/tutorials/schedule.md
rename to docs/en/tutorials/schedule.md
diff --git a/docs_zh-CN/Makefile b/docs/zh_CN/Makefile
similarity index 100%
rename from docs_zh-CN/Makefile
rename to docs/zh_CN/Makefile
diff --git a/docs_zh-CN/_static/css/readthedocs.css b/docs/zh_CN/_static/css/readthedocs.css
similarity index 100%
rename from docs_zh-CN/_static/css/readthedocs.css
rename to docs/zh_CN/_static/css/readthedocs.css
diff --git a/docs_zh-CN/_static/image/mmcls-logo.png b/docs/zh_CN/_static/image/mmcls-logo.png
similarity index 100%
rename from docs_zh-CN/_static/image/mmcls-logo.png
rename to docs/zh_CN/_static/image/mmcls-logo.png
diff --git a/docs_zh-CN/_static/image/tools/analysis/analyze_log.jpg b/docs/zh_CN/_static/image/tools/analysis/analyze_log.jpg
similarity index 100%
rename from docs_zh-CN/_static/image/tools/analysis/analyze_log.jpg
rename to docs/zh_CN/_static/image/tools/analysis/analyze_log.jpg
diff --git a/docs_zh-CN/_static/image/tools/visualization/lr_schedule1.png b/docs/zh_CN/_static/image/tools/visualization/lr_schedule1.png
similarity index 100%
rename from docs_zh-CN/_static/image/tools/visualization/lr_schedule1.png
rename to docs/zh_CN/_static/image/tools/visualization/lr_schedule1.png
diff --git a/docs_zh-CN/_static/image/tools/visualization/lr_schedule2.png b/docs/zh_CN/_static/image/tools/visualization/lr_schedule2.png
similarity index 100%
rename from docs_zh-CN/_static/image/tools/visualization/lr_schedule2.png
rename to docs/zh_CN/_static/image/tools/visualization/lr_schedule2.png
diff --git a/docs_zh-CN/_static/image/tools/visualization/pipeline-concat.jpg b/docs/zh_CN/_static/image/tools/visualization/pipeline-concat.jpg
similarity index 100%
rename from docs_zh-CN/_static/image/tools/visualization/pipeline-concat.jpg
rename to docs/zh_CN/_static/image/tools/visualization/pipeline-concat.jpg
diff --git a/docs_zh-CN/_static/image/tools/visualization/pipeline-original.jpg b/docs/zh_CN/_static/image/tools/visualization/pipeline-original.jpg
similarity index 100%
rename from docs_zh-CN/_static/image/tools/visualization/pipeline-original.jpg
rename to docs/zh_CN/_static/image/tools/visualization/pipeline-original.jpg
diff --git a/docs_zh-CN/_static/image/tools/visualization/pipeline-pipeline.jpg b/docs/zh_CN/_static/image/tools/visualization/pipeline-pipeline.jpg
similarity index 100%
rename from docs_zh-CN/_static/image/tools/visualization/pipeline-pipeline.jpg
rename to docs/zh_CN/_static/image/tools/visualization/pipeline-pipeline.jpg
diff --git a/docs_zh-CN/api.rst b/docs/zh_CN/api.rst
similarity index 100%
rename from docs_zh-CN/api.rst
rename to docs/zh_CN/api.rst
diff --git a/docs_zh-CN/community/CONTRIBUTING.md b/docs/zh_CN/community/CONTRIBUTING.md
similarity index 100%
rename from docs_zh-CN/community/CONTRIBUTING.md
rename to docs/zh_CN/community/CONTRIBUTING.md
diff --git a/docs_zh-CN/conf.py b/docs/zh_CN/conf.py
similarity index 66%
rename from docs_zh-CN/conf.py
rename to docs/zh_CN/conf.py
index 14b4217f049..9e3e7051560 100644
--- a/docs_zh-CN/conf.py
+++ b/docs/zh_CN/conf.py
@@ -17,7 +17,7 @@
import pytorch_sphinx_theme
from sphinx.builders.html import StandaloneHTMLBuilder
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
@@ -26,7 +26,7 @@
author = 'MMClassification Authors'
# The full version, including alpha/beta/rc tags
-version_file = '../mmcls/version.py'
+version_file = '../../mmcls/version.py'
def get_version():
@@ -116,98 +116,10 @@ def get_version():
},
]
},
- {
- 'name':
- '文档',
- 'children': [
- {
- 'name': 'MMCV',
- 'url': 'https://mmcv.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MIM',
- 'url': 'https://openmim.readthedocs.io/en/latest/'
- },
- {
- 'name': 'MMAction2',
- 'url': 'https://mmaction2.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMClassification',
- 'url':
- 'https://mmclassification.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMDetection',
- 'url': 'https://mmdetection.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMDetection3D',
- 'url':
- 'https://mmdetection3d.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMEditing',
- 'url': 'https://mmediting.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMGeneration',
- 'url': 'https://mmgeneration.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMOCR',
- 'url': 'https://mmocr.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMPose',
- 'url': 'https://mmpose.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMSegmentation',
- 'url':
- 'https://mmsegmentation.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMTracking',
- 'url': 'https://mmtracking.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMFlow',
- 'url': 'https://mmflow.readthedocs.io/en/latest/',
- },
- {
- 'name': 'MMFewShot',
- 'url': 'https://mmfewshot.readthedocs.io/zh_CN/latest/',
- },
- {
- 'name': 'MMHuman3d',
- 'url': 'https://mmhuman3d.readthedocs.io/en/latest/',
- },
- ]
- },
- {
- 'name':
- 'OpenMMLab',
- 'children': [
- {
- 'name': '官网',
- 'url': 'https://openmmlab.com/'
- },
- {
- 'name': 'GitHub',
- 'url': 'https://github.com/open-mmlab/'
- },
- {
- 'name': '推特',
- 'url': 'https://twitter.com/OpenMMLab'
- },
- {
- 'name': '知乎',
- 'url': 'https://zhihu.com/people/openmmlab'
- },
- ]
- },
- ]
+ ],
+ # Specify the language of shared menu
+ 'menu_lang':
+ 'cn',
}
# Add any paths that contain custom static files (such as style sheets) here,
diff --git a/docs_zh-CN/getting_started.md b/docs/zh_CN/getting_started.md
similarity index 100%
rename from docs_zh-CN/getting_started.md
rename to docs/zh_CN/getting_started.md
diff --git a/docs/imgs/qq_group_qrcode.jpg b/docs/zh_CN/imgs/qq_group_qrcode.jpg
similarity index 100%
rename from docs/imgs/qq_group_qrcode.jpg
rename to docs/zh_CN/imgs/qq_group_qrcode.jpg
diff --git a/docs/imgs/zhihu_qrcode.jpg b/docs/zh_CN/imgs/zhihu_qrcode.jpg
similarity index 100%
rename from docs/imgs/zhihu_qrcode.jpg
rename to docs/zh_CN/imgs/zhihu_qrcode.jpg
diff --git a/docs_zh-CN/index.rst b/docs/zh_CN/index.rst
similarity index 100%
rename from docs_zh-CN/index.rst
rename to docs/zh_CN/index.rst
diff --git a/docs_zh-CN/install.md b/docs/zh_CN/install.md
similarity index 100%
rename from docs_zh-CN/install.md
rename to docs/zh_CN/install.md
diff --git a/docs/zh_CN/model_zoo.md b/docs/zh_CN/model_zoo.md
new file mode 120000
index 00000000000..013a9acc839
--- /dev/null
+++ b/docs/zh_CN/model_zoo.md
@@ -0,0 +1 @@
+../en/model_zoo.md
\ No newline at end of file
diff --git a/docs_zh-CN/stat.py b/docs/zh_CN/stat.py
similarity index 97%
rename from docs_zh-CN/stat.py
rename to docs/zh_CN/stat.py
index 8968cbed73e..079a241542d 100755
--- a/docs_zh-CN/stat.py
+++ b/docs/zh_CN/stat.py
@@ -12,7 +12,7 @@
papers_root = Path('papers')
papers_root.mkdir(exist_ok=True)
-files = [Path(f) for f in sorted(glob.glob('../configs/*/README.md'))]
+files = [Path(f) for f in sorted(glob.glob('../../configs/*/README.md'))]
stats = []
titles = []
diff --git a/docs_zh-CN/tools/analysis.md b/docs/zh_CN/tools/analysis.md
similarity index 100%
rename from docs_zh-CN/tools/analysis.md
rename to docs/zh_CN/tools/analysis.md
diff --git a/docs_zh-CN/tools/miscellaneous.md b/docs/zh_CN/tools/miscellaneous.md
similarity index 100%
rename from docs_zh-CN/tools/miscellaneous.md
rename to docs/zh_CN/tools/miscellaneous.md
diff --git a/docs_zh-CN/tools/model_serving.md b/docs/zh_CN/tools/model_serving.md
similarity index 100%
rename from docs_zh-CN/tools/model_serving.md
rename to docs/zh_CN/tools/model_serving.md
diff --git a/docs_zh-CN/tools/onnx2tensorrt.md b/docs/zh_CN/tools/onnx2tensorrt.md
similarity index 100%
rename from docs_zh-CN/tools/onnx2tensorrt.md
rename to docs/zh_CN/tools/onnx2tensorrt.md
diff --git a/docs_zh-CN/tools/pytorch2onnx.md b/docs/zh_CN/tools/pytorch2onnx.md
similarity index 100%
rename from docs_zh-CN/tools/pytorch2onnx.md
rename to docs/zh_CN/tools/pytorch2onnx.md
diff --git a/docs_zh-CN/tools/pytorch2torchscript.md b/docs/zh_CN/tools/pytorch2torchscript.md
similarity index 100%
rename from docs_zh-CN/tools/pytorch2torchscript.md
rename to docs/zh_CN/tools/pytorch2torchscript.md
diff --git a/docs_zh-CN/tools/visualization.md b/docs/zh_CN/tools/visualization.md
similarity index 100%
rename from docs_zh-CN/tools/visualization.md
rename to docs/zh_CN/tools/visualization.md
diff --git a/docs_zh-CN/tutorials/MMClassification_python_cn.ipynb b/docs/zh_CN/tutorials/MMClassification_python_cn.ipynb
similarity index 100%
rename from docs_zh-CN/tutorials/MMClassification_python_cn.ipynb
rename to docs/zh_CN/tutorials/MMClassification_python_cn.ipynb
diff --git a/docs_zh-CN/tutorials/MMClassification_tools_cn.ipynb b/docs/zh_CN/tutorials/MMClassification_tools_cn.ipynb
similarity index 100%
rename from docs_zh-CN/tutorials/MMClassification_tools_cn.ipynb
rename to docs/zh_CN/tutorials/MMClassification_tools_cn.ipynb
diff --git a/docs_zh-CN/tutorials/config.md b/docs/zh_CN/tutorials/config.md
similarity index 100%
rename from docs_zh-CN/tutorials/config.md
rename to docs/zh_CN/tutorials/config.md
diff --git a/docs_zh-CN/tutorials/data_pipeline.md b/docs/zh_CN/tutorials/data_pipeline.md
similarity index 100%
rename from docs_zh-CN/tutorials/data_pipeline.md
rename to docs/zh_CN/tutorials/data_pipeline.md
diff --git a/docs_zh-CN/tutorials/finetune.md b/docs/zh_CN/tutorials/finetune.md
similarity index 100%
rename from docs_zh-CN/tutorials/finetune.md
rename to docs/zh_CN/tutorials/finetune.md
diff --git a/docs_zh-CN/tutorials/new_dataset.md b/docs/zh_CN/tutorials/new_dataset.md
similarity index 100%
rename from docs_zh-CN/tutorials/new_dataset.md
rename to docs/zh_CN/tutorials/new_dataset.md
diff --git a/docs_zh-CN/tutorials/new_modules.md b/docs/zh_CN/tutorials/new_modules.md
similarity index 100%
rename from docs_zh-CN/tutorials/new_modules.md
rename to docs/zh_CN/tutorials/new_modules.md
diff --git a/docs_zh-CN/tutorials/runtime.md b/docs/zh_CN/tutorials/runtime.md
similarity index 100%
rename from docs_zh-CN/tutorials/runtime.md
rename to docs/zh_CN/tutorials/runtime.md
diff --git a/docs_zh-CN/tutorials/schedule.md b/docs/zh_CN/tutorials/schedule.md
similarity index 100%
rename from docs_zh-CN/tutorials/schedule.md
rename to docs/zh_CN/tutorials/schedule.md
diff --git a/docs_zh-CN/model_zoo.md b/docs_zh-CN/model_zoo.md
deleted file mode 120000
index 50553976607..00000000000
--- a/docs_zh-CN/model_zoo.md
+++ /dev/null
@@ -1 +0,0 @@
-../docs/model_zoo.md
\ No newline at end of file