[Docs] change tag into comment (open-mmlab#5043)

tangpan85 · Apr 23, 2021 · 563fb46 · 563fb46
1 parent 2313bd7
commit 563fb46
Show file tree

Hide file tree

Showing 61 changed files with 62 additions and 62 deletions.
diff --git a/configs/albu_example/README.md b/configs/albu_example/README.md
@@ -1,6 +1,6 @@
 # Albu Example
 
-[OTHERS]
+<!-- [OTHERS] -->
 
 ```
 @article{2018arXiv180906839B,

diff --git a/configs/atss/README.md b/configs/atss/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{zhang2019bridging,

diff --git a/configs/autoassign/README.md b/configs/autoassign/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```
 @article{zhu2020autoassign,

diff --git a/configs/carafe/README.md b/configs/carafe/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide config files to reproduce the object detection & instance segmentation results in the ICCV 2019 Oral paper for [CARAFE: Content-Aware ReAssembly of FEatures](https://arxiv.org/abs/1905.02188).
 

diff --git a/configs/cascade_rcnn/README.md b/configs/cascade_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{Cai_2019,

diff --git a/configs/cascade_rpn/README.md b/configs/cascade_rpn/README.md
@@ -1,6 +1,6 @@
 # Cascade RPN
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide the code for reproducing experiment results of [Cascade RPN](https://arxiv.org/abs/1909.06720).
 

diff --git a/configs/centripetalnet/README.md b/configs/centripetalnet/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @InProceedings{Dong_2020_CVPR,

diff --git a/configs/cityscapes/README.md b/configs/cityscapes/README.md
@@ -1,6 +1,6 @@
 # Cityscapes Dataset
 
-[DATASET]
+<!-- [DATASET] -->
 
 ```
 @inproceedings{Cordts2016Cityscapes,

diff --git a/configs/cornernet/README.md b/configs/cornernet/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{law2018cornernet,

diff --git a/configs/dcn/README.md b/configs/dcn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```none
 @inproceedings{dai2017deformable,
@@ -13,7 +13,7 @@
 }
 ```
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```
 @article{zhu2018deformable,

diff --git a/configs/deepfashion/README.md b/configs/deepfashion/README.md
@@ -1,6 +1,6 @@
 # DeepFashion
 
-[DATASET]
+<!-- [DATASET] -->
 
 [MMFashion](https://github.com/open-mmlab/mmfashion) develops "fashion parsing and segmentation" module
 based on the dataset

diff --git a/configs/detectors/README.md b/configs/detectors/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide the config files for [DetectoRS: Detecting Objects with Recursive Feature Pyramid and Switchable Atrous Convolution](https://arxiv.org/pdf/2006.02334.pdf).
 

diff --git a/configs/detr/README.md b/configs/detr/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide the config files for DETR: [End-to-End Object Detection with Transformers](https://arxiv.org/abs/2005.12872).
 

diff --git a/configs/double_heads/README.md b/configs/double_heads/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{wu2019rethinking,

diff --git a/configs/dynamic_rcnn/README.md b/configs/dynamic_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```
 @article{DynamicRCNN,

diff --git a/configs/empirical_attention/README.md b/configs/empirical_attention/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{zhu2019empirical,

diff --git a/configs/fast_rcnn/README.md b/configs/fast_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{girshick2015fast,

diff --git a/configs/faster_rcnn/README.md b/configs/faster_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{Ren_2017,

diff --git a/configs/fcos/README.md b/configs/fcos/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{tian2019fcos,

diff --git a/configs/foveabox/README.md b/configs/foveabox/README.md
@@ -1,6 +1,6 @@
 # FoveaBox: Beyond Anchor-based Object Detector
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 FoveaBox is an accurate, flexible and completely anchor-free object detection system for object detection framework, as presented in our paper [https://arxiv.org/abs/1904.03797](https://arxiv.org/abs/1904.03797):
 Different from previous anchor-based methods, FoveaBox directly learns the object existing possibility and the bounding box coordinates without anchor reference. This is achieved by: (a) predicting category-sensitive semantic maps for the object existing possibility, and (b) producing category-agnostic bounding box for each position that potentially contains an object.

diff --git a/configs/fp16/README.md b/configs/fp16/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[OTHERS]
+<!-- [OTHERS] -->
 
 ```latex
 @article{micikevicius2017mixed,

diff --git a/configs/free_anchor/README.md b/configs/free_anchor/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{zhang2019freeanchor,

diff --git a/configs/fsaf/README.md b/configs/fsaf/README.md
@@ -1,6 +1,6 @@
 # Feature Selective Anchor-Free Module for Single-Shot Object Detection
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 FSAF is an anchor-free method published in CVPR2019 ([https://arxiv.org/pdf/1903.00621.pdf](https://arxiv.org/pdf/1903.00621.pdf)).
 Actually it is equivalent to the anchor-based method with only one anchor at each feature map position in each FPN level.

diff --git a/configs/gcnet/README.md b/configs/gcnet/README.md
@@ -7,7 +7,7 @@ We provide config files to reproduce the results in the paper for
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 **GCNet** is initially described in [arxiv](https://arxiv.org/abs/1904.11492). Via absorbing advantages of Non-Local Networks (NLNet) and Squeeze-Excitation Networks (SENet),  GCNet provides a simple, fast and effective approach for global context modeling, which generally outperforms both NLNet and SENet on major benchmarks for various recognition tasks.
 

diff --git a/configs/gfl/README.md b/configs/gfl/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide config files to reproduce the object detection results in the paper [Generalized Focal Loss: Learning Qualified and Distributed Bounding Boxes for Dense Object Detection](https://arxiv.org/abs/2006.04388)
 

diff --git a/configs/ghm/README.md b/configs/ghm/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```
 @inproceedings{li2019gradient,

diff --git a/configs/gn+ws/README.md b/configs/gn+ws/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```
 @article{weightstandardization,

diff --git a/configs/gn/README.md b/configs/gn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{wu2018group,

diff --git a/configs/grid_rcnn/README.md b/configs/grid_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{lu2019grid,

diff --git a/configs/groie/README.md b/configs/groie/README.md
@@ -11,7 +11,7 @@ on COCO object detection.
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 This paper is motivated by the need to overcome to the limitations of existing
 RoI extractors which select only one (the best) layer from FPN.

diff --git a/configs/guided_anchoring/README.md b/configs/guided_anchoring/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide config files to reproduce the results in the CVPR 2019 paper for [Region Proposal by Guided Anchoring](https://arxiv.org/abs/1901.03278).
 

diff --git a/configs/hrnet/README.md b/configs/hrnet/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{SunXLW19,

diff --git a/configs/htc/README.md b/configs/htc/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide config files to reproduce the results in the CVPR 2019 paper for [Hybrid Task Cascade](https://arxiv.org/abs/1901.07518).
 

diff --git a/configs/instaboost/README.md b/configs/instaboost/README.md
@@ -1,6 +1,6 @@
 # InstaBoost for MMDetection
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 Configs in this directory is the implementation for ICCV2019 paper "InstaBoost: Boosting Instance Segmentation Via Probability Map Guided Copy-Pasting" and provided by the authors of the paper. InstaBoost is a data augmentation method for object detection and instance segmentation. The paper has been released on [`arXiv`](https://arxiv.org/abs/1908.07801).
 

diff --git a/configs/ld/readme.md → configs/ld/README.md b/configs/ld/readme.md → configs/ld/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @Article{zheng2021LD,

diff --git a/configs/legacy_1.x/README.md b/configs/legacy_1.x/README.md
@@ -1,6 +1,6 @@
 # Legacy Configs in MMDetection V1.x
 
-[OTHERS]
+<!-- [OTHERS] -->
 
 Configs in this directory implement the legacy configs used by MMDetection V1.x and its model zoos.
 

diff --git a/configs/libra_rcnn/README.md b/configs/libra_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 We provide config files to reproduce the results in the CVPR 2019 paper [Libra R-CNN](https://arxiv.org/pdf/1904.02701.pdf).
 

diff --git a/configs/lvis/README.md b/configs/lvis/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[DATASET]
+<!-- [DATASET] -->
 
 ```latex
 @inproceedings{gupta2019lvis,

diff --git a/configs/mask_rcnn/README.md b/configs/mask_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{He_2017,

diff --git a/configs/ms_rcnn/README.md b/configs/ms_rcnn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```
 @inproceedings{huang2019msrcnn,

diff --git a/configs/nas_fcos/README.md b/configs/nas_fcos/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @article{wang2019fcos,

diff --git a/configs/nas_fpn/README.md b/configs/nas_fpn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{ghiasi2019fpn,

diff --git a/configs/paa/README.md b/configs/paa/README.md
@@ -1,6 +1,6 @@
 # Probabilistic Anchor Assignment with IoU Prediction for Object Detection
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```latex
 @inproceedings{paa-eccv2020,

diff --git a/configs/pafpn/README.md b/configs/pafpn/README.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-[ALGORITHM]
+<!-- [ALGORITHM] -->
 
 ```
 @inproceedings{liu2018path,