From a9d65271abfcb3137b3defc9fa03049615fe51da Mon Sep 17 00:00:00 2001
From: Ma Zerun <mzr1996@163.com>
Date: Tue, 24 Aug 2021 17:46:46 +0800
Subject: [PATCH] [Docs] Add algorithm readme and update meta yml (#418)

* Add README.md for models without checkpoints.

* Update model-index.yml

* Update metafile.yml of seresnet
---
 configs/resnest/README.md            | 16 ++++++++++++++++
 configs/seresnet/metafile.yml        |  4 ++--
 configs/tnt/README.md                | 16 ++++++++++++++++
 configs/vision_transformer/README.md | 16 ++++++++++++++++
 model-index.yml                      |  2 +-
 5 files changed, 51 insertions(+), 3 deletions(-)
 create mode 100644 configs/resnest/README.md
 create mode 100644 configs/tnt/README.md
 create mode 100644 configs/vision_transformer/README.md

diff --git a/configs/resnest/README.md b/configs/resnest/README.md
new file mode 100644
index 00000000000..9333316dfc4
--- /dev/null
+++ b/configs/resnest/README.md
@@ -0,0 +1,16 @@
+# ResNeSt: Split-Attention Networks
+
+## Introduction
+
+<!-- [ALGORITHM] -->
+
+```latex
+@misc{zhang2020resnest,
+      title={ResNeSt: Split-Attention Networks},
+      author={Hang Zhang and Chongruo Wu and Zhongyue Zhang and Yi Zhu and Haibin Lin and Zhi Zhang and Yue Sun and Tong He and Jonas Mueller and R. Manmatha and Mu Li and Alexander Smola},
+      year={2020},
+      eprint={2004.08955},
+      archivePrefix={arXiv},
+      primaryClass={cs.CV}
+}
+```
diff --git a/configs/seresnet/metafile.yml b/configs/seresnet/metafile.yml
index 3e90ed3eacd..1865aa9a04a 100644
--- a/configs/seresnet/metafile.yml
+++ b/configs/seresnet/metafile.yml
@@ -26,7 +26,7 @@ Models:
           Top 5 Accuracy: 93.84
         Task: Image Classification
     Weights: https://download.openmmlab.com/mmclassification/v0/se-resnet/se-resnet50_batch256_imagenet_20200804-ae206104.pth
-    Config: configs/seresnet50/seresnet50_b32x8_imagenet.py
+    Config: configs/seresnet/seresnet50_b32x8_imagenet.py
   - Name: seresnet101_b32x8_imagenet
     Metadata:
       FLOPs: 7860000000
@@ -39,4 +39,4 @@ Models:
           Top 5 Accuracy: 94.07
         Task: Image Classification
     Weights: https://download.openmmlab.com/mmclassification/v0/se-resnet/se-resnet101_batch256_imagenet_20200804-ba5b51d4.pth
-    Config: configs/seresnet101/seresnet101_b32x8_imagenet.py
+    Config: configs/seresnet/seresnet101_b32x8_imagenet.py
diff --git a/configs/tnt/README.md b/configs/tnt/README.md
new file mode 100644
index 00000000000..7617c998d1e
--- /dev/null
+++ b/configs/tnt/README.md
@@ -0,0 +1,16 @@
+# Transformer in Transformer
+
+## Introduction
+
+<!-- [ALGORITHM] -->
+
+```latex
+@misc{han2021transformer,
+      title={Transformer in Transformer},
+      author={Kai Han and An Xiao and Enhua Wu and Jianyuan Guo and Chunjing Xu and Yunhe Wang},
+      year={2021},
+      eprint={2103.00112},
+      archivePrefix={arXiv},
+      primaryClass={cs.CV}
+}
+```
diff --git a/configs/vision_transformer/README.md b/configs/vision_transformer/README.md
new file mode 100644
index 00000000000..de818be1d27
--- /dev/null
+++ b/configs/vision_transformer/README.md
@@ -0,0 +1,16 @@
+# An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale
+
+## Introduction
+
+[ALGORITHM]
+
+```latex
+@inproceedings{
+  dosovitskiy2021an,
+  title={An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale},
+  author={Alexey Dosovitskiy and Lucas Beyer and Alexander Kolesnikov and Dirk Weissenborn and Xiaohua Zhai and Thomas Unterthiner and Mostafa Dehghani and Matthias Minderer and Georg Heigold and Sylvain Gelly and Jakob Uszkoreit and Neil Houlsby},
+  booktitle={International Conference on Learning Representations},
+  year={2021},
+  url={https://openreview.net/forum?id=YicbFdNTTy}
+}
+```
diff --git a/model-index.yml b/model-index.yml
index bba4775bc29..5737454e5c7 100644
--- a/model-index.yml
+++ b/model-index.yml
@@ -4,7 +4,7 @@ Import:
   - configs/resnet/metafile.yml
   - configs/resnext/metafile.yml
   - configs/seresnet/metafile.yml
-  - configs/seresnext/metafile.yml
   - configs/shufflenet_v1/metafile.yml
   - configs/shufflenet_v2/metafile.yml
+  - configs/swin_transformer/metafile.yml
   - configs/vgg/metafile.yml