From 159d9251640a161e270eba520a78403b9bc76370 Mon Sep 17 00:00:00 2001
From: Wenwei Zhang <40779233+ZwwWayne@users.noreply.github.com>
Date: Mon, 30 Nov 2020 23:24:13 +0800
Subject: [PATCH] Add DETR readme.md (#4206)

* Add DETR readme.md

* update model zoo

* fix typo
---
 README.md              |  1 +
 configs/detr/README.md | 25 +++++++++++++++++++++++++
 docs/model_zoo.md      |  3 +++
 3 files changed, 29 insertions(+)
 create mode 100644 configs/detr/README.md

diff --git a/README.md b/README.md
index f4961f56768..8be7cb75e2c 100644
--- a/README.md
+++ b/README.md
@@ -104,6 +104,7 @@ Supported methods:
 - [x] [YOLACT](configs/yolact/README.md)
 - [x] [CentripetalNet](configs/centripetalnet/README.md)
 - [x] [VFNet](configs/vfnet/README.md)
+- [x] [DETR](configs/detr/README.md)
 
 Some other methods are also supported in [projects using MMDetection](./docs/projects.md).
 
diff --git a/configs/detr/README.md b/configs/detr/README.md
new file mode 100644
index 00000000000..ef85706174b
--- /dev/null
+++ b/configs/detr/README.md
@@ -0,0 +1,25 @@
+# DETR
+
+## Introduction
+
+We provide the config files for DETR: [End-to-End Object Detection with Transformers](https://arxiv.org/abs/2005.12872).
+
+```BibTeX
+@inproceedings{detr,
+  author    = {Nicolas Carion and
+               Francisco Massa and
+               Gabriel Synnaeve and
+               Nicolas Usunier and
+               Alexander Kirillov and
+               Sergey Zagoruyko},
+  title     = {End-to-End Object Detection with Transformers},
+  booktitle = {ECCV},
+  year      = {2020}
+}
+```
+
+## Results and Models
+
+| Backbone | Model | Lr schd | Mem (GB) | Inf time (fps) | box AP | Config | Download |
+|:------:|:--------:|:-------:|:--------:|:--------------:|:------:|:------:|:--------:|
+| R-50 | DETR  |150e ||  | | [config](https://github.com/open-mmlab/mmdetection/tree/master/configs/detr/detr_r50_8x4_150e_coco.py) | [model]() &#124; [log]() |
diff --git a/docs/model_zoo.md b/docs/model_zoo.md
index 98987c7851b..95bba2a7454 100644
--- a/docs/model_zoo.md
+++ b/docs/model_zoo.md
@@ -162,6 +162,9 @@ Please refer to [CentripetalNet](https://github.com/open-mmlab/mmdetection/blob/
 ### ResNeSt
 Please refer to [ResNeSt](https://github.com/open-mmlab/mmdetection/blob/master/configs/resnest) for details.
 
+### DETR
+Please refer to [DETR](https://github.com/open-mmlab/mmdetection/blob/master/configs/detr) for details.
+
 ### Other datasets
 
 We also benchmark some methods on [PASCAL VOC](https://github.com/open-mmlab/mmdetection/blob/master/configs/pascal_voc), [Cityscapes](https://github.com/open-mmlab/mmdetection/blob/master/configs/cityscapes) and [WIDER FACE](https://github.com/open-mmlab/mmdetection/blob/master/configs/wider_face).