From 272f2007397d8aa984195d2cc6ac6710b8d1fd5d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Haian=20Huang=28=E6=B7=B1=E5=BA=A6=E7=9C=B8=29?=
<1286304229@qq.com>
Date: Mon, 8 Feb 2021 11:03:12 +0800
Subject: [PATCH] Add paper conference link and update MMCV installation docs
(#4597)
* Add paper conference link and mmcv install docs
* Update contributing
---
.github/CONTRIBUTING.md | 71 +-------------------------
README.md | 108 ++++++++++++++++++++--------------------
configs/paa/README.md | 9 ++++
docs/get_started.md | 8 ++-
4 files changed, 71 insertions(+), 125 deletions(-)
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index d65e30a4..c6696262 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,70 +1 @@
-# Contributing to mmdetection
-
-All kinds of contributions are welcome, including but not limited to the following.
-
-- Fixes (typo, bugs)
-- New features and components
-
-## Workflow
-
-1. fork and pull the latest mmdetection
-2. checkout a new branch (do not use master branch for PRs)
-3. commit your changes
-4. create a PR
-
-Note
-
-- If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.
-- If you are the author of some papers and would like to include your method to mmdetection, please let us know (open an issue or contact the maintainers). We will much appreciate your contribution.
-- For new features and new modules, unit tests are required to improve the code's robustness.
-
-## Code style
-
-### Python
-
-We adopt [PEP8](https://www.python.org/dev/peps/pep-0008/) as the preferred code style.
-
-We use the following tools for linting and formatting:
-
-- [flake8](http://flake8.pycqa.org/en/latest/): linter
-- [yapf](https://github.com/google/yapf): formatter
-- [isort](https://github.com/timothycrosley/isort): sort imports
-
-Style configurations of yapf and isort can be found in [setup.cfg](../setup.cfg).
-
-We use [pre-commit hook](https://pre-commit.com/) that checks and formats for `flake8`, `yapf`, `isort`, `trailing whitespaces`,
- fixes `end-of-files`, sorts `requirments.txt` automatically on every commit.
-The config for a pre-commit hook is stored in [.pre-commit-config](../.pre-commit-config.yaml).
-
-After you clone the repository, you will need to install initialize pre-commit hook.
-
-```shell
-pip install -U pre-commit
-```
-
-From the repository folder
-
-```shell
-pre-commit install
-```
-
-If you are facing issue when installing markdown lint, you may install ruby for markdown lint by following
-
-```shell
-# install rvm
-curl -L https://get.rvm.io | bash -s -- --autolibs=read-fail
-# set up environment
-# Note that you might need to edit ~/.bashrc, ~/.bash_profile, and ~/.profile
-source ~/.profile
-rvm autolibs disable
-# install ruby
-rvm install 2.7.1
-```
-
-After this on every commit check code linters and formatter will be enforced.
-
->Before you create a PR, make sure that your code lints and is formatted by yapf.
-
-### C++ and CUDA
-
-We follow the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
+We appreciate all contributions to improve MMDetection. Please refer to [CONTRIBUTING.md](https://github.com/open-mmlab/mmcv/blob/master/CONTRIBUTING.md) in MMCV for more details about the contributing guideline.
diff --git a/README.md b/README.md
index 96a5a88e..5fafb1d8 100644
--- a/README.md
+++ b/README.md
@@ -52,63 +52,63 @@ Results and models are available in the [model zoo](docs/model_zoo.md).
Supported backbones:
-- [x] ResNet
-- [x] ResNeXt
-- [x] VGG
-- [x] HRNet
-- [x] RegNet
-- [x] Res2Net
-- [x] ResNeSt
+- [x] ResNet (CVPR'2016)
+- [x] ResNeXt (CVPR'2017)
+- [x] VGG (ICLR'2015)
+- [x] HRNet (CVPR'2019)
+- [x] RegNet (CVPR'2020)
+- [x] Res2Net (TPAMI'2020)
+- [x] ResNeSt (ArXiv'2020)
Supported methods:
-- [x] [RPN](configs/rpn)
-- [x] [Fast R-CNN](configs/fast_rcnn)
-- [x] [Faster R-CNN](configs/faster_rcnn)
-- [x] [Mask R-CNN](configs/mask_rcnn)
-- [x] [Cascade R-CNN](configs/cascade_rcnn)
-- [x] [Cascade Mask R-CNN](configs/cascade_rcnn)
-- [x] [SSD](configs/ssd)
-- [x] [RetinaNet](configs/retinanet)
-- [x] [GHM](configs/ghm)
-- [x] [Mask Scoring R-CNN](configs/ms_rcnn)
-- [x] [Double-Head R-CNN](configs/double_heads)
-- [x] [Hybrid Task Cascade](configs/htc)
-- [x] [Libra R-CNN](configs/libra_rcnn)
-- [x] [Guided Anchoring](configs/guided_anchoring)
-- [x] [FCOS](configs/fcos)
-- [x] [RepPoints](configs/reppoints)
-- [x] [Foveabox](configs/foveabox)
-- [x] [FreeAnchor](configs/free_anchor)
-- [x] [NAS-FPN](configs/nas_fpn)
-- [x] [ATSS](configs/atss)
-- [x] [FSAF](configs/fsaf)
-- [x] [PAFPN](configs/pafpn)
-- [x] [Dynamic R-CNN](configs/dynamic_rcnn)
-- [x] [PointRend](configs/point_rend)
-- [x] [CARAFE](configs/carafe/README.md)
-- [x] [DCNv2](configs/dcn/README.md)
-- [x] [Group Normalization](configs/gn/README.md)
-- [x] [Weight Standardization](configs/gn+ws/README.md)
-- [x] [OHEM](configs/faster_rcnn/faster_rcnn_r50_fpn_ohem_1x_coco.py)
-- [x] [Soft-NMS](configs/faster_rcnn/faster_rcnn_r50_fpn_soft_nms_1x_coco.py)
-- [x] [Generalized Attention](configs/empirical_attention/README.md)
-- [x] [GCNet](configs/gcnet/README.md)
-- [x] [Mixed Precision (FP16) Training](configs/fp16/README.md)
-- [x] [InstaBoost](configs/instaboost/README.md)
-- [x] [GRoIE](configs/groie/README.md)
-- [x] [DetectoRS](configs/detectors/README.md)
-- [x] [Generalized Focal Loss](configs/gfl/README.md)
-- [x] [CornerNet](configs/cornernet/README.md)
-- [x] [Side-Aware Boundary Localization](configs/sabl/README.md)
-- [x] [YOLOv3](configs/yolo/README.md)
-- [x] [PAA](configs/paa/README.md)
-- [x] [YOLACT](configs/yolact/README.md)
-- [x] [CentripetalNet](configs/centripetalnet/README.md)
-- [x] [VFNet](configs/vfnet/README.md)
-- [x] [DETR](configs/detr/README.md)
-- [x] [CascadeRPN](configs/cascade_rpn/README.md)
-- [x] [SCNet](configs/scnet/README.md)
+- [x] [RPN (NeurIPS'2015)](configs/rpn)
+- [x] [Fast R-CNN (ICCV'2015)](configs/fast_rcnn)
+- [x] [Faster R-CNN (NeurIPS'2015)](configs/faster_rcnn)
+- [x] [Mask R-CNN (ICCV'2017)](configs/mask_rcnn)
+- [x] [Cascade R-CNN (CVPR'2018)](configs/cascade_rcnn)
+- [x] [Cascade Mask R-CNN (CVPR'2018)](configs/cascade_rcnn)
+- [x] [SSD (ECCV'2016)](configs/ssd)
+- [x] [RetinaNet (ICCV'2017)](configs/retinanet)
+- [x] [GHM (AAAI'2019)](configs/ghm)
+- [x] [Mask Scoring R-CNN (CVPR'2019)](configs/ms_rcnn)
+- [x] [Double-Head R-CNN (CVPR'2020)](configs/double_heads)
+- [x] [Hybrid Task Cascade (CVPR'2019)](configs/htc)
+- [x] [Libra R-CNN (CVPR'2019)](configs/libra_rcnn)
+- [x] [Guided Anchoring (CVPR'2019)](configs/guided_anchoring)
+- [x] [FCOS (ICCV'2019)](configs/fcos)
+- [x] [RepPoints (ICCV'2019)](configs/reppoints)
+- [x] [Foveabox (TIP'2020)](configs/foveabox)
+- [x] [FreeAnchor (NeurIPS'2019)](configs/free_anchor)
+- [x] [NAS-FPN (CVPR'2019)](configs/nas_fpn)
+- [x] [ATSS (CVPR'2020)](configs/atss)
+- [x] [FSAF (CVPR'2019)](configs/fsaf)
+- [x] [PAFPN (CVPR'2018)](configs/pafpn)
+- [x] [Dynamic R-CNN (ECCV'2020)](configs/dynamic_rcnn)
+- [x] [PointRend (CVPR'2020)](configs/point_rend)
+- [x] [CARAFE (ICCV'2019)](configs/carafe/README.md)
+- [x] [DCNv2 (CVPR'2019)](configs/dcn/README.md)
+- [x] [Group Normalization (ECCV'2018)](configs/gn/README.md)
+- [x] [Weight Standardization (ArXiv'2019)](configs/gn+ws/README.md)
+- [x] [OHEM (CVPR'2016)](configs/faster_rcnn/faster_rcnn_r50_fpn_ohem_1x_coco.py)
+- [x] [Soft-NMS (ICCV'2017)](configs/faster_rcnn/faster_rcnn_r50_fpn_soft_nms_1x_coco.py)
+- [x] [Generalized Attention (ICCV'2019)](configs/empirical_attention/README.md)
+- [x] [GCNet (ICCVW'2019)](configs/gcnet/README.md)
+- [x] [Mixed Precision (FP16) Training (ArXiv'2017)](configs/fp16/README.md)
+- [x] [InstaBoost (ICCV'2019)](configs/instaboost/README.md)
+- [x] [GRoIE (ICPR'2020)](configs/groie/README.md)
+- [x] [DetectoRS (ArXix'2020)](configs/detectors/README.md)
+- [x] [Generalized Focal Loss (NeurIPS'2020)](configs/gfl/README.md)
+- [x] [CornerNet (ECCV'2018)](configs/cornernet/README.md)
+- [x] [Side-Aware Boundary Localization (ECCV'2020)](configs/sabl/README.md)
+- [x] [YOLOv3 (ArXiv'2018)](configs/yolo/README.md)
+- [x] [PAA (ECCV'2020)](configs/paa/README.md)
+- [x] [YOLACT (ICCV'2019)](configs/yolact/README.md)
+- [x] [CentripetalNet (CVPR'2020)](configs/centripetalnet/README.md)
+- [x] [VFNet (ArXix'2020)](configs/vfnet/README.md)
+- [x] [DETR (ECCV'2020)](configs/detr/README.md)
+- [x] [CascadeRPN (NeurIPS'2019)](configs/cascade_rpn/README.md)
+- [x] [SCNet (AAAI'2021)](configs/scnet/README.md)
Some other methods are also supported in [projects using MMDetection](./docs/projects.md).
diff --git a/configs/paa/README.md b/configs/paa/README.md
index 7fca0db0..9960dcf9 100644
--- a/configs/paa/README.md
+++ b/configs/paa/README.md
@@ -2,6 +2,15 @@
[ALGORITHM]
+```latex
+@inproceedings{paa-eccv2020,
+ title={Probabilistic Anchor Assignment with IoU Prediction for Object Detection},
+ author={Kim, Kang and Lee, Hee Seok},
+ booktitle = {ECCV},
+ year={2020}
+}
+```
+
## Results and Models
We provide config files to reproduce the object detection results in the
diff --git a/docs/get_started.md b/docs/get_started.md
index 9b2a132a..e3279947 100644
--- a/docs/get_started.md
+++ b/docs/get_started.md
@@ -66,7 +66,13 @@ If mmcv and mmcv-full are both installed, there will be `ModuleNotFoundError`.
3. Install mmcv-full, we recommend you to install the pre-build package as below.
```shell
- pip install mmcv-full==latest+torch1.6.0+cu101 -f https://download.openmmlab.com/mmcv/dist/index.html
+ pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html
+ ```
+
+ Please replace `{cu_version}` and `{torch_version}` in the url to your desired one. For example, to install the latest `mmcv-full` with `CUDA 11` and `PyTorch 1.7.0`, use the following command:
+
+ ```shell
+ pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu110/torch1.7.0/index.html
```
See [here](https://github.com/open-mmlab/mmcv#install-with-pip) for different versions of MMCV compatible to different PyTorch and CUDA versions.
--
GitLab