[Docs] fix typos and invalid link (#7)

* fix link issue * fix link issue
open-mmlab · Nov 24, 2021 · 486c8c2 · 486c8c2
1 parent ded7c35
commit 486c8c2
Show file tree

Hide file tree

Showing 11 changed files with 37 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -84,7 +84,7 @@ Supported algorithms:
 
 ## Installation
 
-Please refer to [install.md](docs/install.md) for installation of mmfewshot.
+Please refer to [install.md](docs/install.md) for installation of mmfewshot and [guidance](tools/data/README.md) for dataset preparation.
 
 ## Getting Started
 

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -81,7 +81,7 @@ MMFewShot 是一款基于 PyTorch 的少样本学习代码库，是 [OpenMMLab](
 
 ## 安装
 
-请参考[安装文档](docs/install.md)进行安装。
+请参考[安装文档](docs/install.md)进行安装和参考[数据准备](tools/data/README.md)准备数据集。
 
 ## 快速入门
 

diff --git a/configs/detection/attention_rpn/README.md b/configs/detection/attention_rpn/README.md
@@ -142,14 +142,14 @@ bash ./tools/detection/dist_train.sh \
 
 | Arch  | data source| Base mAP |  ckpt | log |
 | :------: | :-----------: | :------: | :------: |:------: |
-| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_base-training.py) | [TFA](https://github.com/ucbdrive/few-shot-object-detection/blob/main/datasets/README.md) | 23.6 |[ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_base-training_20211102_003348-da28cdfd.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_base-training.log.json) |
-| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-base-training.py) | [official repo](https://github.com/fanq15/FewX/tree/main/datasets) | 24.0 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-base-training_20211102_003347-f9e2dab0.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-base-training.log.json) |
+| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_base-training.py) | [TFA](https://github.com/ucbdrive/few-shot-object-detection/blob/master/datasets/README.md) | 23.6 |[ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_base-training_20211102_003348-da28cdfd.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_base-training.log.json) |
+| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-base-training.py) | [official repo](https://github.com/fanq15/FewX/tree/master/datasets) | 24.0 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-base-training_20211102_003347-f9e2dab0.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-base-training.log.json) |
 
 
 ### Few Shot Finetuning
 
 | Arch  | data source|  Shot | Novel mAP |  ckpt | log |
 | :--------------: |  :--------------: | :-----------: |  :------: |:------: |:------: |
-| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning.py) | [TFA](https://github.com/ucbdrive/few-shot-object-detection/blob/main/datasets/README.md) | 10 | 9.2 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning_20211103_003801-94ec8ada.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning.log.json) |
-| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_30shot-fine-tuning.py) | [TFA](https://github.com/ucbdrive/few-shot-object-detection/blob/main/datasets/README.md) | 30 | 14.8 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_30shot-fine-tuning_20211103_010800-50611991.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_30shot-fine-tuning.log.json) |
-| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning.py) | [official repo](https://github.com/fanq15/FewX/tree/main/datasets) | 10 | 11.6 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-10shot-fine-tuning_20211107_214729-6d046301.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-10shot-fine-tuning.log.json) |
+| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning.py) | [TFA](https://github.com/ucbdrive/few-shot-object-detection/blob/master/datasets/README.md) | 10 | 9.2 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning_20211103_003801-94ec8ada.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning.log.json) |
+| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_30shot-fine-tuning.py) | [TFA](https://github.com/ucbdrive/few-shot-object-detection/blob/master/datasets/README.md) | 30 | 14.8 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_30shot-fine-tuning_20211103_010800-50611991.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_30shot-fine-tuning.log.json) |
+| [r50 c4](/configs/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_10shot-fine-tuning.py) | [official repo](https://github.com/fanq15/FewX/tree/master/datasets) | 10 | 11.6 | [ckpt](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-10shot-fine-tuning_20211107_214729-6d046301.pth) | [log](https://download.openmmlab.com/mmfewshot/detection/attention_rpn/coco/attention-rpn_r50_c4_4xb2_coco_official-10shot-fine-tuning.log.json) |
diff --git a/docs/install.md b/docs/install.md
@@ -6,8 +6,8 @@
 - CUDA 9.2+
 - GCC 5+
 - [mmcv](https://mmcv.readthedocs.io/en/latest/#installation) 1.3.12+
-- [mmdet](https://mmdet.readthedocs.io/en/latest/#installation) 2.16.0+
-- [mmcls](https://mmcls.readthedocs.io/en/latest/#installation) 0.15.0+
+- [mmdet](https://mmdetection.readthedocs.io/en/latest/#installation) 2.16.0+
+- [mmcls](https://mmclassification.readthedocs.io/en/latest/#installation) 0.15.0+
 
 
 Compatible MMCV, MMClassification and MMDetection versions are shown as below. Please install the correct version of them to avoid installation issues.
@@ -73,7 +73,7 @@ Or you can still install MMFewShot manually:
 
     See [here](https://github.com/open-mmlab/mmcv#installation) for different versions of MMCV compatible to different PyTorch and CUDA versions.
 
-    Optionally you can compile mmcv from source if you need to develop both mmcv and mmdet. Refer to the [guide](https://github.com/open-mmlab/mmcv#installation) for details.
+    Optionally you can compile mmcv from source if you need to develop both mmcv and mmfewshot. Refer to the [guide](https://github.com/open-mmlab/mmcv#installation) for details.
 
 2. Install MMClassification and MMDetection.
 

diff --git a/docs_zh-CN/install.md b/docs_zh-CN/install.md
@@ -6,8 +6,8 @@
 - CUDA 9.2+
 - GCC 5+
 - [mmcv](https://mmcv.readthedocs.io/en/latest/#installation) 1.3.12+
-- [mmdet](https://mmdet.readthedocs.io/en/latest/#installation) 2.16.0+
-- [mmcls](https://mmcls.readthedocs.io/en/latest/#installation) 0.15.0+
+- [mmdet](https://mmdetection.readthedocs.io/en/latest/#installation) 2.16.0+
+- [mmcls](https://mmclassification.readthedocs.io/en/latest/#installation) 0.15.0+
 
 
 MMFewShot 和 MMCV, MMCls, MMDet 版本兼容性如下所示，需要安装正确的版本以避免安装出现问题。

diff --git a/tools/classification/slurm_test.sh b/tools/classification/slurm_test.sh
@@ -21,4 +21,4 @@ srun -p ${PARTITION} \
     --cpus-per-task=${CPUS_PER_TASK} \
     --kill-on-bad-exit=1 \
     ${SRUN_ARGS} \
-    python -u tools/test.py ${CONFIG} ${CHECKPOINT} --launcher="slurm" ${PY_ARGS}
+    python -u tools/classification/test.py ${CONFIG} ${CHECKPOINT} --launcher="slurm" ${PY_ARGS}
diff --git a/tools/classification/slurm_train.sh b/tools/classification/slurm_train.sh
@@ -21,4 +21,4 @@ srun -p ${PARTITION} \
     --cpus-per-task=${CPUS_PER_TASK} \
     --kill-on-bad-exit=1 \
     ${SRUN_ARGS} \
-    python -u tools/train.py ${CONFIG} --work-dir=${WORK_DIR} --launcher="slurm" ${PY_ARGS}
+    python -u tools/classification/train.py ${CONFIG} --work-dir=${WORK_DIR} --launcher="slurm" ${PY_ARGS}
diff --git a/tools/data/README.md b/tools/data/README.md
@@ -0,0 +1,20 @@
+# Data Preparation for MMFewShot
+
+It is recommended to symlink the dataset root to `$MMFEWSHOT/data`.
+If your folder structure is different, you may need to change the corresponding paths in config files.
+
+
+# Few Shot Classification
+
+Datasets supported in MMFewShot:
+
+- [CUB Dataset](classification/cub/README.md) \[ [Homepage](http://www.vision.caltech.edu/visipedia/CUB-200-2011.html) \]
+- [Mini ImageNet Dataset](classification/mini-imagenet/README.md) \[ [Homepage](https://image-net.org/challenges/LSVRC/2012/) \] \[ [Split](https://github.com/twitter/meta-learning-lstm/tree/master/data/miniImagenet) \]
+- [Tiered ImageNet Dataset](classification/tiered-imagenet/README.md) \[ [Homepage](https://image-net.org/challenges/LSVRC/2012/) \] \[ [Split](https://github.com/renmengye/few-shot-ssl-public#tieredimagenet) \]
+
+# Few Shot Detection
+
+Datasets supported in MMFewShot:
+
+- [COCO Dataset](detection/coco/README.md) \[ [Homepage](https://cocodataset.org/#home) \] \[ [Split](http://dl.yf.io/fs-det/datasets/cocosplit/) \]
+- [VOC Dataset](detection/voc/README.md) \[ [Homepage](http://host.robots.ox.ac.uk/pascal/VOC/) \] \[ [Split](http://dl.yf.io/fs-det/datasets/vocsplit/) \]
diff --git a/tools/data/classification/README.md b/tools/data/classification/README.md
@@ -1,4 +1,4 @@
-# Data Preparation for Few Shot Detection
+# Data Preparation for Few Shot Classification
 
 It is recommended to symlink the dataset root to `$MMFEWSHOT/data`.
 If your folder structure is different, you may need to change the corresponding paths in config files.

diff --git a/tools/detection/slurm_test.sh b/tools/detection/slurm_test.sh
@@ -21,4 +21,4 @@ srun -p ${PARTITION} \
     --cpus-per-task=${CPUS_PER_TASK} \
     --kill-on-bad-exit=1 \
     ${SRUN_ARGS} \
-    python -u tools/test.py ${CONFIG} ${CHECKPOINT} --launcher="slurm" ${PY_ARGS}
+    python -u tools/detection/test.py ${CONFIG} ${CHECKPOINT} --launcher="slurm" ${PY_ARGS}
diff --git a/tools/detection/slurm_train.sh b/tools/detection/slurm_train.sh
@@ -21,4 +21,4 @@ srun -p ${PARTITION} \
     --cpus-per-task=${CPUS_PER_TASK} \
     --kill-on-bad-exit=1 \
     ${SRUN_ARGS} \
-    python -u tools/train.py ${CONFIG} --work-dir=${WORK_DIR} --launcher="slurm" ${PY_ARGS}
+    python -u tools/detection/train.py ${CONFIG} --work-dir=${WORK_DIR} --launcher="slurm" ${PY_ARGS}