Skip to content

Commit 01e35aa

Browse files
authored
[Fix] fix the config name style description (open-mmlab#1414)
1 parent 0d51115 commit 01e35aa

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/en/tutorials/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Please refer to [mmcv](https://mmcv.readthedocs.io/en/latest/understand_mmcv/con
2424
We follow the below style to name config files. Contributors are advised to follow the same style.
2525

2626
```
27-
{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{schedule}_{dataset}
27+
{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{iterations}_{dataset}
2828
```
2929

3030
`{xxx}` is required field and `[yyy]` is optional.
@@ -33,7 +33,7 @@ We follow the below style to name config files. Contributors are advised to foll
3333
- `{backbone}`: backbone type like `r50` (ResNet-50), `x101` (ResNeXt-101).
3434
- `[misc]`: miscellaneous setting/plugins of model, e.g. `dconv`, `gcb`, `attention`, `mstrain`.
3535
- `[gpu x batch_per_gpu]`: GPUs and samples per GPU, `8x2` is used by default.
36-
- `{schedule}`: training schedule, `20ki` means 20k iterations.
36+
- `{iterations}`: number of training iterations like `160k`.
3737
- `{dataset}`: dataset like `cityscapes`, `voc12aug`, `ade`.
3838

3939
## An Example of PSPNet

docs/zh_cn/tutorials/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
我们按照下面的风格去命名配置文件,社区贡献者被建议使用同样的风格。
2222

2323
```
24-
{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{schedule}_{dataset}
24+
{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{iterations}_{dataset}
2525
```
2626

2727
`{xxx}` 是被要求的文件 `[yyy]` 是可选的。
@@ -30,7 +30,7 @@
3030
- `{backbone}`: 主干网络种类,例如 `r50` (ResNet-50), `x101` (ResNeXt-101)
3131
- `[misc]`: 模型中各式各样的设置/插件,例如 `dconv``gcb``attention``mstrain`
3232
- `[gpu x batch_per_gpu]`: GPU数目 和每个 GPU 的样本数, 默认为 `8x2`
33-
- `{schedule}`: 训练方案, `20ki` 意思是 20k 迭代轮数
33+
- `{iterations}`: 训练迭代轮数,如`160k`
3434
- `{dataset}`: 数据集,如 `cityscapes``voc12aug``ade`
3535

3636
## PSPNet 的一个例子

0 commit comments

Comments
 (0)