Folder specific readmes

README.md

@@ -63,7 +63,10 @@ pip install -r requirements.txt
           used: [[`Mask RCNN R50-FPN-1x Link`](https://dl.fbaipublicfiles.com/detectron2/COCO-InstanceSegmentation/mask_rcnn_R_50_FPN_1x/137260431/model_final_a54504.pkl)]
     - JSON in `doc_v2` directory
 
-More information can be found in folder specific READMEs.
+More information can be found in folder-specific READMEs.
+- [images/README.md](images/README.md)
+- [doc_v2/README.md](doc_v2/README.md)
+- [init_weights/README.md](init_weights/README.md)
 
 ### SLURM Workloads
 

configs/README.md

@@ -1,16 +1,81 @@
+# Model Zoo
+
+## Ablative Variants
+
 ### Deformable Backbone
 
-Remove defgrid mask head by commenting out the `add_defgrid_maskhead_config(cfg)` from the basic setup
+Remove defgrid mask head by commenting out the `add_defgrid_maskhead_config(cfg)` from the `def setup(args)`
 in `train_net_palmira.py`
 
 ```bash
-Python train_palmira.py --config-file  configs/dconv/dconv_c3-c5.yaml num-gpus 4 --resume
+python train_palmira.py \
+    --config-file configs/dconv/dconv_c3-c5.yaml \
+    --num-gpus 4
+```
+
+To toggle other layers of the ResNet, edit this section of the config.yaml
+
+```yaml
+MODEL:
+  RESNETS:
+    DEFORM_ON_PER_STAGE: [ False, True, True, True ] # on Res3, Res4, Res5
 ```
 
 ### Vanilla Mask RCNN
 
-Defgrid mask needs to be removed here as well.
+Remove defgrid mask head by commenting out the `add_defgrid_maskhead_config(cfg)` from the `def setup(args)`
+in `train_net_palmira.py`
 
 ```bash
-Python train_palmira.py --config-file  configs/mrcnn/vanilla_mrcnn.yaml num-gpus 4 --resume
+python train_palmira.py \
+    --config-file configs/mrcnn/vanilla_mrcnn.yaml \
+    --num-gpus 4
+```
+
+## Other Baselines
+
+| Model Name |                                          Repo                                         |
+|:----------:|:-------------------------------------------------------------------------------------:|
+|  CondInst  |      [Code](https://github.com/aim-uofa/AdelaiDet/tree/master/configs/CondInst)       |
+| PointRend  | [Code](https://github.com/facebookresearch/detectron2/tree/master/projects/PointRend) |
+|   BMRCNN   |       [Code](https://github.com/hustvl/BMaskR-CNN/tree/master/projects/BMaskR-CNN)    |
+|    DETR    |            [Code](https://github.com/facebookresearch/detr/tree/master/d2)            |
+
+# References
+```bibtex
+@misc{carion2020endtoend,
+      title={End-to-End Object Detection with Transformers}, 
+      author={Nicolas Carion and Francisco Massa and Gabriel Synnaeve and Nicolas Usunier and Alexander Kirillov and Sergey Zagoruyko},
+      year={2020},
+      eprint={2005.12872},
+      archivePrefix={arXiv},
+      primaryClass={cs.CV}
+}
+```
+
+```bibtex
+@inproceedings{tian2020conditional,
+  title     =  {Conditional Convolutions for Instance Segmentation},
+  author    =  {Tian, Zhi and Shen, Chunhua and Chen, Hao},
+  booktitle =  {Proc. Eur. Conf. Computer Vision (ECCV)},
+  year      =  {2020}
+}
+```
+
+```bibtex
+@article{ChengWHL20,
+  title={Boundary-preserving Mask R-CNN},
+  author={Tianheng Cheng and Xinggang Wang and Lichao Huang and Wenyu Liu},
+  booktitle={ECCV},
+  year={2020}
+}
+```
+
+```bibtex
+@InProceedings{kirillov2019pointrend,
+  title={{PointRend}: Image Segmentation as Rendering},
+  author={Alexander Kirillov and Yuxin Wu and Kaiming He and Ross Girshick},
+  journal={ArXiv:1912.08193},
+  year={2019}
+}
 ```

doc_v2/README.md

@@ -1 +1,11 @@
-Place the downloaded Annotations(json files) in this Directory
+# JSON Files Directory Structure
+
+Verify that the dataset downloaded matches this directory structure
+
+```
+└── doc
+    ├── test
+    ├── train
+    ├── train_val_combined
+    └── val
+```

images/README.md

@@ -1 +1,11 @@
-Place the downloaded Palmira dataset in this Directory
+# Dataset Directory Structure
+
+Verify that the dataset downloaded matches this directory structure
+```
+└── images
+    ├── ASR_Images
+    ├── Bhoomi_data
+    ├── jain-mscripts
+    ├── penn_in_hand
+    └── penn-in-hand
+```