Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tutuorial of config #487

Merged
merged 17 commits into from
Oct 26, 2021
Merged
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ You can switch between Chinese and English documents in the lower-left corner of
:maxdepth: 1
:caption: Tutorials

tutorials/config.md
tutorials/finetune.md
tutorials/new_dataset.md
tutorials/data_pipeline.md
Expand Down
380 changes: 380 additions & 0 deletions docs/tutorials/config.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/tutorials/data_pipeline.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tutorial 3: Custom Data Pipelines
# Tutorial 4: Custom Data Pipelines

## Design of Data pipelines

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/finetune.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tutorial 1: Fine-tune Models
# Tutorial 2: Fine-tune Models

Classification models pre-trained on the ImageNet dataset have been demonstrated to be effective for other datasets and other downstream tasks.
This tutorial provides instructions for users to use the models provided in the [Model Zoo](../model_zoo.md) for other datasets to obtain better performance.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/new_dataset.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tutorial 2: Adding New Dataset
# Tutorial 3: Adding New Dataset

## Customize datasets by reorganizing data

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/new_modules.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tutorial 4: Adding New Modules
# Tutorial 5: Adding New Modules

## Develop new components

Expand Down
5 changes: 5 additions & 0 deletions docs_zh-CN/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ backbones
.. automodule:: mmcls.models.backbones
:members:

heads
^^^^^^^^^^
.. automodule:: mmcls.models.heads
:members:

necks
^^^^^^
.. automodule:: mmcls.models.necks
Expand Down
1 change: 1 addition & 0 deletions docs_zh-CN/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ You can switch between Chinese and English documents in the lower-left corner of
:maxdepth: 1
:caption: 教程

tutorials/config.md
tutorials/finetune.md
tutorials/new_dataset.md
tutorials/data_pipeline.md
Expand Down
381 changes: 381 additions & 0 deletions docs_zh-CN/tutorials/config.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs_zh-CN/tutorials/data_pipeline.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 教程 3:如何设计数据处理流程
# 教程 4:如何设计数据处理流程

## 设计数据流水线

Expand Down
2 changes: 1 addition & 1 deletion docs_zh-CN/tutorials/finetune.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 教程 1:如何微调模型
# 教程 2:如何微调模型

已经证明,在 ImageNet 数据集上预先训练的分类模型对于其他数据集和其他下游任务有很好的效果。

Expand Down
2 changes: 1 addition & 1 deletion docs_zh-CN/tutorials/new_dataset.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 教程 2:如何添加新数据集
# 教程 3:如何添加新数据集

## 通过重新组织数据来自定义数据集

Expand Down
2 changes: 1 addition & 1 deletion docs_zh-CN/tutorials/new_modules.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 教程 4:如何增加新模块
# 教程 5:如何增加新模块

## 开发新组件

Expand Down