Update documentation.

Tonyzhang2000 · Dec 5, 2023 · 53b6863 · 53b6863
1 parent 2bf6ad7
commit 53b6863
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -264,6 +264,7 @@ Results and models are available in the [model zoo](docs/en/model_zoo.md).
 - [x] [LEVIR-CD](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#levir-cd)
 - [x] [BDD100K](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#bdd100K)
 - [x] [NYU](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#nyu)
+- [x] [ACDC](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#acdc)
 
 </details>
 

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -253,6 +253,7 @@ MMSegmentation v1.x 在 0.x 版本的基础上有了显著的提升，提供了
 - [x] [LEVIR-CD](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#levir-cd)
 - [x] [BDD100K](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#bdd100K)
 - [x] [NYU](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#nyu)
+- [x] [ACDC](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#acdc)
 
 </details>
 

diff --git a/docs/en/user_guides/2_dataset_prepare.md b/docs/en/user_guides/2_dataset_prepare.md
@@ -205,6 +205,13 @@ mmsegmentation
 │   │   ├── annotations
 │   │   │   ├── train
 │   │   │   ├── test
+│   ├── acdc
+│   │   ├── gt
+│   │   │   ├── test
+│   │   │   ├── train
+│   │   ├── rgb_anno
+│   │   │   ├── test
+│   │   │   ├── train
 ```
 
 ## Download dataset via MIM
@@ -752,3 +759,30 @@ mmsegmentation
   ```bash
   python tools/dataset_converters/nyu.py nyu.zip
   ```
+
+## ACDC Dataset
+
+The data could be found [here](https://acdc.vision.ee.ethz.ch/download).
+
+Download and unzip the data into `$ACDC`, it should have the following structure:
+
+```
+$ACDC
+├── gt
+│   ├── fog
+│   ├── night
+│   ├── rain
+│   ├── snow
+├── rgb_anon
+│   ├── fog
+│   ├── night
+│   ├── rain
+│   ├── snow
+```
+
+We provided a script to process the ACDC dataset into mmsegmentation accepted format.
+
+```shell
+# --split means the weather split, available options [fog, night, rain, snow, all]
+python tools/dataset_converters/acdc.py $ACDC --split $split
+```
diff --git a/docs/zh_cn/user_guides/2_dataset_prepare.md b/docs/zh_cn/user_guides/2_dataset_prepare.md
@@ -748,3 +748,30 @@ mmsegmentation
   ```bash
   python tools/dataset_converters/nyu.py nyu.zip
   ```
+
+## ACDC
+
+您可以从 [这个链接](https://acdc.vision.ee.ethz.ch/download) 下载 ACDC 数据集。
+
+下载完成后请将数据集解压缩到 `$ACDC`, 得到以下结构:
+
+```
+$ACDC
+├── gt
+│   ├── fog
+│   ├── night
+│   ├── rain
+│   ├── snow
+├── rgb_anon
+│   ├── fog
+│   ├── night
+│   ├── rain
+│   ├── snow
+```
+
+请运行以下命令转换 ACDC 数据集：
+
+```shell
+# --split 是天气选项, 可以从 [fog, night, rain, snow, all] 中选择
+python tools/dataset_converters/acdc.py $ACDC --split $split
+```