From bcd120d33a9baacc3ce8c9c23332b02bc5cf797f Mon Sep 17 00:00:00 2001 From: AlexZou14 <2435588629@qq.com> Date: Wed, 14 Jul 2021 21:46:26 +0800 Subject: [PATCH 1/4] Add Chinese translation of Config.md. --- docs_zh-CN/config.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs_zh-CN/config.md b/docs_zh-CN/config.md index 0432a9f7dc..3e5c3102a0 100644 --- a/docs_zh-CN/config.md +++ b/docs_zh-CN/config.md @@ -1 +1,18 @@ -# 教程 1: 配置文件 +# 教程 1: 学习配置文件 +我们采用python文件作为我们配置系统，你可以在`$MMEditing/configs`下查看我们提供的配置文件。 +## 配置文件命名风格 +我们按照下面的风格去命名配置文件。社区贡献者被建议使用同样的风格。 +``` +{model}_[model setting]_{backbone}_[refiner]_[norm setting]_[misc]_[gpu x batch_per_gpu]_{schedule}_{dataset} +``` +`{xxx}` 是必填字段，`[yyy]` 是可选的。 + +- `{model}`: 模型种类，例如 `srcnn`, `dim` 等等。 +- `[model setting]`: 特定设置一些模型，例如，输入图像 `resolution` , 训练 `stage name`。 +- `{backbone}`: 主干网络种类，例如 `r50` (ResNet-50)、`x101` (ResNeXt-101)。 +- `{refiner}`: 加工模型种类，例如 `pln` 简单的加工模型 +- `[norm_setting]`: 指定归一化设置，默认为批归一化，其他归一化可以设为: `bn`(批归一化), `gn` (组归一化), `syncbn` (同步批归一化)。 +- `[misc]`: 模型中各式各样的设置/插件，例如 `dconv`, `gcb`, `attention`, `mstrain`。 +- `[gpu x batch_per_gpu]`: GPU数目 和每个 GPU 的样本数， 默认为 `8x2 `。 +- `{schedule}`: 训练方案， `20ki` 意思是 `20k` 迭代轮数。 +- `{dataset}`: 数据集，如 `places`（图像补全）、`comp1k`（抠图）、`div2k`（图像恢复）和 `paired`（图像生成）。 \ No newline at end of file From d4ed2019f756f21327465ab50af6cdf89f7fa0bc Mon Sep 17 00:00:00 2001 From: lizz Date: Wed, 21 Jul 2021 16:47:15 +0800 Subject: [PATCH 2/4] Revise Signed-off-by: lizz --- docs_zh-CN/config.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs_zh-CN/config.md b/docs_zh-CN/config.md index 3e5c3102a0..45ebf6d171 100644 --- a/docs_zh-CN/config.md +++ b/docs_zh-CN/config.md @@ -1,18 +1,21 @@ -# 教程 1: 学习配置文件 -我们采用python文件作为我们配置系统，你可以在`$MMEditing/configs`下查看我们提供的配置文件。 +# 教程 1: 了解配置文件 +mmedit 采用基于 python 文件的配置系统，您可以在 `$MMEditing/configs` 下查看预置的配置文件。 ## 配置文件命名风格 -我们按照下面的风格去命名配置文件。社区贡献者被建议使用同样的风格。 + +配置文件按照下面的风格命名。我们建议社区贡献者使用同样的风格。 + ``` {model}_[model setting]_{backbone}_[refiner]_[norm setting]_[misc]_[gpu x batch_per_gpu]_{schedule}_{dataset} ``` + `{xxx}` 是必填字段，`[yyy]` 是可选的。 - `{model}`: 模型种类，例如 `srcnn`, `dim` 等等。 - `[model setting]`: 特定设置一些模型，例如，输入图像 `resolution` , 训练 `stage name`。 - `{backbone}`: 主干网络种类，例如 `r50` (ResNet-50)、`x101` (ResNeXt-101)。 -- `{refiner}`: 加工模型种类，例如 `pln` 简单的加工模型 +- `{refiner}`: 精炼器种类，例如 `pln` 简单精炼器模型 - `[norm_setting]`: 指定归一化设置，默认为批归一化，其他归一化可以设为: `bn`(批归一化), `gn` (组归一化), `syncbn` (同步批归一化)。 - `[misc]`: 模型中各式各样的设置/插件，例如 `dconv`, `gcb`, `attention`, `mstrain`。 - `[gpu x batch_per_gpu]`: GPU数目 和每个 GPU 的样本数， 默认为 `8x2 `。 - `{schedule}`: 训练方案， `20ki` 意思是 `20k` 迭代轮数。 -- `{dataset}`: 数据集，如 `places`（图像补全）、`comp1k`（抠图）、`div2k`（图像恢复）和 `paired`（图像生成）。 \ No newline at end of file +- `{dataset}`: 数据集，如 `places`（图像补全）、`comp1k`（抠图）、`div2k`（图像恢复）和 `paired`（图像生成）。 From 84e808e67d9eb431bdce96320425687acd9413bb Mon Sep 17 00:00:00 2001 From: lizz Date: Wed, 21 Jul 2021 16:48:59 +0800 Subject: [PATCH 3/4] Imrpove Signed-off-by: lizz --- docs/config.md | 2 +- docs_zh-CN/config.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/config.md b/docs/config.md index 1423b324e4..b1dac7cbd9 100644 --- a/docs/config.md +++ b/docs/config.md @@ -6,7 +6,7 @@ We use python files as our config system. You can find all the provided configs We follow the below style to name config files. Contributors are advised to follow the same style. -``` +```bash {model}_[model setting]_{backbone}_[refiner]_[norm setting]_[misc]_[gpu x batch_per_gpu]_{schedule}_{dataset} ``` diff --git a/docs_zh-CN/config.md b/docs_zh-CN/config.md index 45ebf6d171..f1f102dace 100644 --- a/docs_zh-CN/config.md +++ b/docs_zh-CN/config.md @@ -1,10 +1,12 @@ # 教程 1: 了解配置文件 + mmedit 采用基于 python 文件的配置系统，您可以在 `$MMEditing/configs` 下查看预置的配置文件。 + ## 配置文件命名风格 配置文件按照下面的风格命名。我们建议社区贡献者使用同样的风格。 -``` +```bash {model}_[model setting]_{backbone}_[refiner]_[norm setting]_[misc]_[gpu x batch_per_gpu]_{schedule}_{dataset} ``` From 90d97be759b51ab3a56bfce7ff9482ab04dcc746 Mon Sep 17 00:00:00 2001 From: lizz Date: Wed, 21 Jul 2021 16:52:21 +0800 Subject: [PATCH 4/4] More Signed-off-by: lizz --- docs_zh-CN/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_zh-CN/config.md b/docs_zh-CN/config.md index f1f102dace..6be88c4c47 100644 --- a/docs_zh-CN/config.md +++ b/docs_zh-CN/config.md @@ -19,5 +19,5 @@ mmedit 采用基于 python 文件的配置系统，您可以在 `$MMEditing/conf - `[norm_setting]`: 指定归一化设置，默认为批归一化，其他归一化可以设为: `bn`(批归一化), `gn` (组归一化), `syncbn` (同步批归一化)。 - `[misc]`: 模型中各式各样的设置/插件，例如 `dconv`, `gcb`, `attention`, `mstrain`。 - `[gpu x batch_per_gpu]`: GPU数目 和每个 GPU 的样本数， 默认为 `8x2 `。 -- `{schedule}`: 训练方案， `20ki` 意思是 `20k` 迭代轮数。 +- `{schedule}`: 训练策略，如 `20k`, `100k` 等，意思是 `20k` 或 `100k` 迭代轮数。 - `{dataset}`: 数据集，如 `places`（图像补全）、`comp1k`（抠图）、`div2k`（图像恢复）和 `paired`（图像生成）。