[Docs] update readthedocs rst and menu button (#572)
* update the version switcher menu * update rst * update * updatepull/582/head
Yixiao Fang
YuanLiuuuuuu
parent
7980414026
commit
1835af3a91
|
|
@ -70,6 +70,11 @@ memories
|
|||
.. automodule:: mmselfsup.models.memories
|
||||
:members:
|
||||
|
||||
target_generators
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.models.target_generators
|
||||
:members:
|
||||
|
||||
utils
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.models.utils
|
||||
|
|
|
|||
|
|
@ -77,8 +77,47 @@ html_theme_options = {
|
|||
'name': 'GitHub',
|
||||
'url': 'https://github.com/open-mmlab/mmselfsup'
|
||||
},
|
||||
{
|
||||
'name':
|
||||
'Upstream',
|
||||
'children': [
|
||||
{
|
||||
'name':
|
||||
'MMEngine',
|
||||
'url':
|
||||
'https://github.com/open-mmlab/mmengine',
|
||||
'description':
|
||||
'Foundational library for training deep '
|
||||
'learning models'
|
||||
},
|
||||
{
|
||||
'name': 'MMCV',
|
||||
'url': 'https://github.com/open-mmlab/mmcv',
|
||||
'description': 'Foundational library for computer vision'
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
'name':
|
||||
'Version',
|
||||
'children': [
|
||||
{
|
||||
'name': 'MMSelfSup 0.x',
|
||||
'url': 'https://mmselfsup.readthedocs.io/zh_CN/latest/',
|
||||
'description': 'Main branch docs'
|
||||
},
|
||||
{
|
||||
'name': 'MMSelfSup 1.x',
|
||||
'url': 'https://mmselfsup.readthedocs.io/zh_CN/dev-1.x/',
|
||||
'description': '1.x branch docs'
|
||||
},
|
||||
],
|
||||
'active':
|
||||
True,
|
||||
},
|
||||
],
|
||||
'menu_lang': 'en'
|
||||
'menu_lang':
|
||||
'en'
|
||||
}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
## <a href='https://mmselfsup.readthedocs.io/en/latest/'>English</a>
|
||||
## <a href='https://mmselfsup.readthedocs.io/en/dev-1.x/'>English</a>
|
||||
|
||||
## <a href='https://mmselfsup.readthedocs.io/zh_CN/latest/'>简体中文</a>
|
||||
## <a href='https://mmselfsup.readthedocs.io/zh_CN/dev-1.x/'>简体中文</a>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Basic Concepts
|
||||
基础概念
|
||||
***************
|
||||
|
||||
.. toctree::
|
||||
|
|
@ -13,7 +13,7 @@ Basic Concepts
|
|||
engine.md
|
||||
conventions.md
|
||||
|
||||
Component Customization
|
||||
组件模块自定义
|
||||
************************
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
|
|
@ -1,33 +1,14 @@
|
|||
mmselfsup.apis
|
||||
---------------
|
||||
.. automodule:: mmselfsup.apis
|
||||
:members:
|
||||
|
||||
mmselfsup.core
|
||||
---------------
|
||||
|
||||
hooks
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.core.hooks
|
||||
:members:
|
||||
|
||||
optimizer
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.core.optimizer
|
||||
:members:
|
||||
|
||||
|
||||
mmselfsup.datasets
|
||||
---------------------
|
||||
---------------
|
||||
|
||||
data_sources
|
||||
^^^^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.datasets.data_sources
|
||||
datasets
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.datasets
|
||||
:members:
|
||||
|
||||
pipelines
|
||||
transforms
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.datasets.pipelines
|
||||
.. automodule:: mmselfsup.datasets.transforms
|
||||
:members:
|
||||
|
||||
samplers
|
||||
|
|
@ -35,12 +16,26 @@ samplers
|
|||
.. automodule:: mmselfsup.datasets.samplers
|
||||
:members:
|
||||
|
||||
datasets
|
||||
mmselfsup.engine
|
||||
--------------
|
||||
|
||||
hooks
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.datasets
|
||||
.. automodule:: mmselfsup.engine.hooks
|
||||
:members:
|
||||
|
||||
optimizers
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.engine.optimizers
|
||||
:members:
|
||||
|
||||
mmselfsup.evaluation
|
||||
-----------------
|
||||
|
||||
functional
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.evaluation.functional
|
||||
:members:
|
||||
|
||||
mmselfsup.models
|
||||
-----------------
|
||||
|
|
@ -55,19 +50,29 @@ backbones
|
|||
.. automodule:: mmselfsup.models.backbones
|
||||
:members:
|
||||
|
||||
necks
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.models.necks
|
||||
:members:
|
||||
|
||||
heads
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.models.heads
|
||||
:members:
|
||||
|
||||
losses
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.models.losses
|
||||
:members:
|
||||
|
||||
memories
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.models.memories
|
||||
:members:
|
||||
|
||||
necks
|
||||
target_generators
|
||||
^^^^^^^^^^
|
||||
.. automodule:: mmselfsup.models.necks
|
||||
.. automodule:: mmselfsup.models.target_generators
|
||||
:members:
|
||||
|
||||
utils
|
||||
|
|
@ -75,6 +80,15 @@ utils
|
|||
.. automodule:: mmselfsup.models.utils
|
||||
:members:
|
||||
|
||||
mmselfsup.structures
|
||||
---------------
|
||||
.. automodule:: mmselfsup.structures
|
||||
:members:
|
||||
|
||||
mmselfsup.visualization
|
||||
---------------
|
||||
.. automodule:: mmselfsup.visualization
|
||||
:members:
|
||||
|
||||
mmselfsup.utils
|
||||
---------------
|
||||
|
|
|
|||
|
|
@ -77,8 +77,43 @@ html_theme_options = {
|
|||
'name': 'GitHub',
|
||||
'url': 'https://github.com/open-mmlab/mmselfsup'
|
||||
},
|
||||
{
|
||||
'name':
|
||||
'上游库',
|
||||
'children': [
|
||||
{
|
||||
'name': 'MMEngine',
|
||||
'url': 'https://github.com/open-mmlab/mmengine',
|
||||
'description': '深度学习模型训练基础库'
|
||||
},
|
||||
{
|
||||
'name': 'MMCV',
|
||||
'url': 'https://github.com/open-mmlab/mmcv',
|
||||
'description': '基础视觉库'
|
||||
},
|
||||
]
|
||||
},
|
||||
{
|
||||
'name':
|
||||
'版本',
|
||||
'children': [
|
||||
{
|
||||
'name': 'MMSelfSup 0.x',
|
||||
'url': 'https://mmselfsup.readthedocs.io/zh_CN/latest/',
|
||||
'description': 'Main 分支文档'
|
||||
},
|
||||
{
|
||||
'name': 'MMSelfSup 1.x',
|
||||
'url': 'https://mmselfsup.readthedocs.io/zh_CN/dev-1.x/',
|
||||
'description': '1.x 分支文档'
|
||||
},
|
||||
],
|
||||
'active':
|
||||
True,
|
||||
},
|
||||
],
|
||||
'menu_lang': 'cn',
|
||||
'menu_lang':
|
||||
'cn',
|
||||
}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
|
|
|
|||
|
|
@ -3,77 +3,63 @@
|
|||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to MMSelfSup's documentation!
|
||||
欢迎来到 MMSelfSup 中文文档!
|
||||
=====================================
|
||||
|
||||
中文文档在持续翻译中，敬请期待，同时我们也鼓励社区开发者们参与到翻译中来
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 开始你的第一步
|
||||
:caption: 新手入门
|
||||
|
||||
install.md
|
||||
prepare_data.md
|
||||
overview.md
|
||||
get_started.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: 用户指南
|
||||
|
||||
user_guides/index.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: 进阶指引
|
||||
|
||||
advanced_guides/index.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 模型库
|
||||
|
||||
model_zoo.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 分类教程
|
||||
:caption: 迁移文档
|
||||
|
||||
tutorials/0_config.md
|
||||
tutorials/1_new_dataset.md
|
||||
tutorials/2_data_pipeline.md
|
||||
tutorials/3_new_module.md
|
||||
tutorials/4_schedule.md
|
||||
tutorials/5_runtime.md
|
||||
tutorials/6_benchmarks.md
|
||||
migration.md
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 算法模型
|
||||
|
||||
algorithms/byol.md
|
||||
algorithms/deep.md
|
||||
algorithms/dense.md
|
||||
algorithms/moco.md
|
||||
algorithms/npid.md
|
||||
algorithms/odc.md
|
||||
algorithms/rl.md
|
||||
algorithms/rp.md
|
||||
algorithms/simclr.md
|
||||
algorithms/ss.md
|
||||
algorithms/swav.md
|
||||
algorithms/mocov3.md
|
||||
algorithms/mae.md
|
||||
algorithms/simmim.md
|
||||
algorithms/barlowtwins.md
|
||||
algorithms/cae.md
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 说明
|
||||
|
||||
changelog.md
|
||||
compatibility.md
|
||||
|
||||
|
||||
.. toctree::
|
||||
:caption: 语言切换
|
||||
|
||||
switch_language.md
|
||||
|
||||
.. toctree::
|
||||
:caption: 接口文档
|
||||
:caption: API 文档
|
||||
|
||||
api.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 记录
|
||||
|
||||
notes/contribution_guide.md
|
||||
notes/changelog.md
|
||||
notes/faq.md
|
||||
|
||||
.. toctree::
|
||||
:caption: 切换语言
|
||||
|
||||
Indices and tables
|
||||
switch_language.md
|
||||
|
||||
导引
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
## <a href='https://mmselfsup.readthedocs.io/en/latest/'>English</a>
|
||||
## <a href='https://mmselfsup.readthedocs.io/en/dev-1.x/'>English</a>
|
||||
|
||||
## <a href='https://mmselfsup.readthedocs.io/zh_CN/latest/'>简体中文</a>
|
||||
## <a href='https://mmselfsup.readthedocs.io/zh_CN/dev-1.x/'>简体中文</a>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,6 @@
|
|||
- [教程一: 了解配置文件](#教程一-了解配置文件)
|
||||
# 教程 1: 了解配置文件
|
||||
|
||||
- [教程 1: 了解配置文件](#教程-1-了解配置文件)
|
||||
- [配置文件命名规则](#配置文件命名规则)
|
||||
- [算法信息](#算法信息)
|
||||
- [模块信息](#模块信息)
|
||||
|
|
@ -13,8 +15,6 @@
|
|||
- [通过脚本参数修改配置](#通过脚本参数修改配置)
|
||||
- [导入用户定义模块](#导入用户定义模块)
|
||||
|
||||
# 教程一: 了解配置文件
|
||||
|
||||
MMSelfSup 主要是在 python 文件中来设置各种各样的配置。我们配置文件系统的设计融合了模块化和可继承的设计理念，可以让用户轻松方便地完成各种实验配置。所有的配置文件全部位于 `configs` 目录下。如果您想查看配置文件的全貌，您可以使用以下命令 `python tools/misc/print_config.py`。
|
||||
|
||||
## 配置文件命名规则
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Pretrain
|
||||
预训练
|
||||
**************
|
||||
|
||||
.. toctree::
|
||||
|
|
@ -9,7 +9,7 @@ Pretrain
|
|||
3_pretrain.md
|
||||
4_pretrain_custom_dataset.md
|
||||
|
||||
Downstream Tasks
|
||||
下游任务
|
||||
**************
|
||||
|
||||
.. toctree::
|
||||
|
|
@ -19,7 +19,7 @@ Downstream Tasks
|
|||
detection.md
|
||||
segmentation.md
|
||||
|
||||
Useful Tools
|
||||
便捷工具
|
||||
************
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
Loading…
Reference in New Issue