[Docs] Use docs link of other projects and add MMCV docs. (#511)

* [Docs] Use docs link of other projects and add MMCV docs.

* Fix misused "document", and it should be "documentation"

* Fix uppercase

* Rename `Projects` to `Docs`.
pull/513/head
Ma Zerun 2021-11-03 10:42:45 +08:00 committed by GitHub
parent d1473e4a7f
commit 82713c9ba4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 42 additions and 30 deletions

View File

@ -109,47 +109,52 @@ html_theme_options = {
}, },
{ {
'name': 'name':
'Projects', 'Docs',
'children': [ 'children': [
{
'name': 'MMCV',
'url': 'https://mmcv.readthedocs.io/en/latest/',
},
{ {
'name': 'MMAction2', 'name': 'MMAction2',
'url': 'https://github.com/open-mmlab/mmaction2', 'url': 'https://mmaction2.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMClassification', 'name': 'MMClassification',
'url': 'https://github.com/open-mmlab/mmclassification', 'url':
'https://mmclassification.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMDetection', 'name': 'MMDetection',
'url': 'https://github.com/open-mmlab/mmdetection', 'url': 'https://mmdetection.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMDetection3D', 'name': 'MMDetection3D',
'url': 'https://github.com/open-mmlab/mmdetection3d', 'url': 'https://mmdetection3d.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMEditing', 'name': 'MMEditing',
'url': 'https://github.com/open-mmlab/mmediting', 'url': 'https://mmediting.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMGeneration', 'name': 'MMGeneration',
'url': 'https://github.com/open-mmlab/mmgeneration', 'url': 'https://mmgeneration.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMOCR', 'name': 'MMOCR',
'url': 'https://github.com/open-mmlab/mmocr', 'url': 'https://mmocr.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMPose', 'name': 'MMPose',
'url': 'https://github.com/open-mmlab/mmpose', 'url': 'https://mmpose.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMSegmentation', 'name': 'MMSegmentation',
'url': 'https://github.com/open-mmlab/mmsegmentation', 'url': 'https://mmsegmentation.readthedocs.io/en/latest/',
}, },
{ {
'name': 'MMTracking', 'name': 'MMTracking',
'url': 'https://github.com/open-mmlab/mmtracking', 'url': 'https://mmtracking.readthedocs.io/en/latest/',
}, },
] ]
}, },

View File

@ -1,7 +1,7 @@
Welcome to MMClassification's documentation! Welcome to MMClassification's documentation!
============================================ ============================================
You can switch between Chinese and English documents in the lower-left corner of the layout. You can switch between Chinese and English documentation in the lower-left corner of the layout.
您可以在页面左下角切换中英文文档。 您可以在页面左下角切换中英文文档。

View File

@ -118,11 +118,11 @@ The four parts are explained separately below, and the above-mentioned ResNet50
### model ### model
The parameter `"model"` is a python dictionary in the configuration file, which mainly includes information such as network structure and loss function: The parameter `"model"` is a python dictionary in the configuration file, which mainly includes information such as network structure and loss function:
- `type` Classifier name, MMCls supports `ImageClassifier`, refer to [API document](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.classifiers). - `type` Classifier name, MMCls supports `ImageClassifier`, refer to [API documentation](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.classifiers).
- `backbone` Backbone configs, refer to [API document](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.backbones) for available options. - `backbone` Backbone configs, refer to [API documentation](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.backbones) for available options.
- `neck` Neck network name, MMCls supports `GlobalAveragePooling`, please refer to [API document](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.necks). - `neck` Neck network name, MMCls supports `GlobalAveragePooling`, please refer to [API documentation](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.necks).
- `head`: Head network name, MMCls supports single-label and multi-label classification head networks, available options refer to [API document](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.heads). - `head`: Head network name, MMCls supports single-label and multi-label classification head networks, available options refer to [API documentation](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.heads).
- `loss`: Loss function type, supports `CrossEntropyLoss`, [`LabelSmoothLoss`](https://github.com/open-mmlab/mmclassification/blob/master/configs/_base_/models/resnet50_label_smooth.py) etc., For available options, refer to [API Document](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.losses). - `loss`: Loss function type, supports `CrossEntropyLoss`, [`LabelSmoothLoss`](https://github.com/open-mmlab/mmclassification/blob/master/configs/_base_/models/resnet50_label_smooth.py) etc., For available options, refer to [API documentation](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.models.losses).
- `train_cfg` Training augment config, MMCls supports [`mixup`](https://github.com/open-mmlab/mmclassification/blob/master/configs/_base_/models/resnet50_mixup.py), [`cutmix`](https://github.com/open-mmlab/mmclassification/blob/master/configs/_base_/models/resnet50_cutmix.py) and other augments. - `train_cfg` Training augment config, MMCls supports [`mixup`](https://github.com/open-mmlab/mmclassification/blob/master/configs/_base_/models/resnet50_mixup.py), [`cutmix`](https://github.com/open-mmlab/mmclassification/blob/master/configs/_base_/models/resnet50_cutmix.py) and other augments.
@ -157,7 +157,7 @@ The parameter `"data"` is a python dictionary in the configuration file, which m
- `train val test` : config to construct dataset - `train val test` : config to construct dataset
- `type`: Dataset name, MMCls supports `ImageNet`, `Cifar` etc., refer to [API documentation](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.datasets) - `type`: Dataset name, MMCls supports `ImageNet`, `Cifar` etc., refer to [API documentation](https://mmclassification.readthedocs.io/en/latest/api.html#module-mmcls.datasets)
- `data_prefix` : Dataset root directory - `data_prefix` : Dataset root directory
- `pipeline` : Data processing pipeline, refer to related tutorial documents [CUSTOM DATA PIPELINES](https://mmclassification.readthedocs.io/en/latest/tutorials/data_pipeline.html) - `pipeline` : Data processing pipeline, refer to related tutorial [CUSTOM DATA PIPELINES](https://mmclassification.readthedocs.io/en/latest/tutorials/data_pipeline.html)
The parameter `evaluation` is also a dictionary, which is the configuration information of `evaluation hook`, mainly including evaluation interval, evaluation index, etc.. The parameter `evaluation` is also a dictionary, which is the configuration information of `evaluation hook`, mainly including evaluation interval, evaluation index, etc..

View File

@ -109,47 +109,54 @@ html_theme_options = {
}, },
{ {
'name': 'name':
'算法库', '文档',
'children': [ 'children': [
{
'name': 'MMCV',
'url': 'https://mmcv.readthedocs.io/zh_CN/latest/',
},
{ {
'name': 'MMAction2', 'name': 'MMAction2',
'url': 'https://github.com/open-mmlab/mmaction2', 'url': 'https://mmaction2.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMClassification', 'name': 'MMClassification',
'url': 'https://github.com/open-mmlab/mmclassification', 'url':
'https://mmclassification.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMDetection', 'name': 'MMDetection',
'url': 'https://github.com/open-mmlab/mmdetection', 'url': 'https://mmdetection.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMDetection3D', 'name': 'MMDetection3D',
'url': 'https://github.com/open-mmlab/mmdetection3d', 'url':
'https://mmdetection3d.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMEditing', 'name': 'MMEditing',
'url': 'https://github.com/open-mmlab/mmediting', 'url': 'https://mmediting.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMGeneration', 'name': 'MMGeneration',
'url': 'https://github.com/open-mmlab/mmgeneration', 'url': 'https://mmgeneration.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMOCR', 'name': 'MMOCR',
'url': 'https://github.com/open-mmlab/mmocr', 'url': 'https://mmocr.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMPose', 'name': 'MMPose',
'url': 'https://github.com/open-mmlab/mmpose', 'url': 'https://mmpose.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMSegmentation', 'name': 'MMSegmentation',
'url': 'https://github.com/open-mmlab/mmsegmentation', 'url':
'https://mmsegmentation.readthedocs.io/zh_CN/latest/',
}, },
{ {
'name': 'MMTracking', 'name': 'MMTracking',
'url': 'https://github.com/open-mmlab/mmtracking', 'url': 'https://mmtracking.readthedocs.io/zh_CN/latest/',
}, },
] ]
}, },

View File

@ -1,7 +1,7 @@
欢迎来到 MMClassification 中文教程! 欢迎来到 MMClassification 中文教程!
========================================== ==========================================
You can switch between Chinese and English documents in the lower-left corner of the layout. You can switch between Chinese and English documentation in the lower-left corner of the layout.
您可以在页面左下角切换中英文文档。 您可以在页面左下角切换中英文文档。