[Fix] fix the config name style description (open-mmlab#1414)

mob5566 · Apr 13, 2022 · ccecfe4 · ccecfe4
1 parent ef106a1
commit ccecfe4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/en/tutorials/config.md b/docs/en/tutorials/config.md
@@ -24,7 +24,7 @@ Please refer to [mmcv](https://mmcv.readthedocs.io/en/latest/understand_mmcv/con
 We follow the below style to name config files. Contributors are advised to follow the same style.
 
 ```
-{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{schedule}_{dataset}
+{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{iterations}_{dataset}
 ```
 
 `{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
 - `{backbone}`: backbone type like `r50` (ResNet-50), `x101` (ResNeXt-101).
 - `[misc]`: miscellaneous setting/plugins of model, e.g. `dconv`, `gcb`, `attention`, `mstrain`.
 - `[gpu x batch_per_gpu]`: GPUs and samples per GPU, `8x2` is used by default.
-- `{schedule}`: training schedule, `20ki` means 20k iterations.
+- `{iterations}`: number of training iterations like `160k`.
 - `{dataset}`: dataset like `cityscapes`, `voc12aug`, `ade`.
 
 ## An Example of PSPNet

diff --git a/docs/zh_cn/tutorials/config.md b/docs/zh_cn/tutorials/config.md
@@ -21,7 +21,7 @@
 我们按照下面的风格去命名配置文件，社区贡献者被建议使用同样的风格。
 
 ```
-{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{schedule}_{dataset}
+{model}_{backbone}_[misc]_[gpu x batch_per_gpu]_{resolution}_{iterations}_{dataset}
 ```
 
 `{xxx}` 是被要求的文件 `[yyy]` 是可选的。
@@ -30,7 +30,7 @@
 - `{backbone}`: 主干网络种类，例如 `r50` (ResNet-50)， `x101` (ResNeXt-101)
 - `[misc]`: 模型中各式各样的设置/插件，例如 `dconv`， `gcb`， `attention`， `mstrain`
 - `[gpu x batch_per_gpu]`: GPU数目 和每个 GPU 的样本数， 默认为 `8x2`
-- `{schedule}`: 训练方案， `20ki` 意思是 20k 迭代轮数
+- `{iterations}`: 训练迭代轮数，如`160k`
 - `{dataset}`: 数据集，如 `cityscapes`， `voc12aug`， `ade`
 
 ## PSPNet 的一个例子