mdformat

open-mmlab · May 18, 2022 · 606b431 · 606b431
1 parent e077a9a
commit 606b431
Show file tree

Hide file tree

Showing 49 changed files with 928 additions and 838 deletions.
diff --git a/.github/ISSUE_TEMPLATE/error-report.md b/.github/ISSUE_TEMPLATE/error-report.md
@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 Thanks for your error report and we appreciate it a lot.
@@ -33,8 +32,8 @@ A placeholder for the command.
 
 1. Please run `python mmrotate/utils/collect_env.py` to collect necessary environment information and paste it here.
 2. You may add addition that may be helpful for locating the problem, such as
-    - How you installed PyTorch [e.g., pip, conda, source]
-    - Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
+   - How you installed PyTorch \[e.g., pip, conda, source\]
+   - Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
 
 **Error traceback**
 If applicable, paste the error trackback here.

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,15 +4,14 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 **Describe the feature**
 
 **Motivation**
 A clear and concise description of the motivation of the feature.
-Ex1. It is inconvenient when [....].
-Ex2. There is a recent paper [....], which is very helpful for [....].
+Ex1. It is inconvenient when \[....\].
+Ex2. There is a recent paper \[....\], which is very helpful for \[....\].
 
 **Related resources**
 If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful.

diff --git a/.github/ISSUE_TEMPLATE/general_questions.md b/.github/ISSUE_TEMPLATE/general_questions.md
@@ -4,5 +4,4 @@ about: Ask general questions to get help
 title: ''
 labels: ''
 assignees: ''
-
 ---
diff --git a/.github/ISSUE_TEMPLATE/reimplementation_questions.md b/.github/ISSUE_TEMPLATE/reimplementation_questions.md
@@ -2,9 +2,8 @@
 name: Reimplementation Questions
 about: Ask about questions during model reimplementation
 title: ''
-labels: 'reimplementation'
+labels: reimplementation
 assignees: ''
-
 ---
 
 **Notice**
@@ -52,7 +51,7 @@ A placeholder for the config.
 
 1. Please run `python mmrotate/utils/collect_env.py` to collect necessary environment information and paste it here.
 2. You may add addition that may be helpful for locating the problem, such as
-   1. How you installed PyTorch [e.g., pip, conda, source]
+   1. How you installed PyTorch \[e.g., pip, conda, source\]
    2. Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
 
 **Results**

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,16 +1,20 @@
 Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
 
 ## Motivation
+
 Please describe the motivation of this PR and the goal you want to achieve through this PR.
 
 ## Modification
+
 Please briefly describe what modification is made in this PR.
 
 ## BC-breaking (Optional)
+
 Does the modification introduce changes that break the back-compatibility of the downstream repos?
 If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.
 
 ## Use cases (Optional)
+
 If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.
 
 ## Checklist

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,5 +1,5 @@
 repos:
-  - repo: https://gitlab.com/pycqa/flake8.git
+  - repo: https://github.com/PyCQA/flake8
     rev: 3.8.3
     hooks:
       - id: flake8
@@ -28,17 +28,20 @@ repos:
         args: [ "--remove" ]
       - id: mixed-line-ending
         args: [ "--fix=lf" ]
-  - repo: https://github.com/markdownlint/markdownlint
-    rev: v0.11.0
-    hooks:
-      - id: markdownlint
-        args: [ "-r", "~MD002,~MD013,~MD029,~MD033,~MD034",
-                "-t", "allow_different_nesting" ]
   - repo: https://github.com/codespell-project/codespell
     rev: v2.1.0
     hooks:
       - id: codespell
         args: [ '--ignore-words-list', 'DOTA' ]
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.14
+    hooks:
+      - id: mdformat
+        args: ["--number"]
+        additional_dependencies:
+          - mdformat-gfm
+          - mdformat_frontmatter
+          - linkify-it-py
   - repo: https://github.com/myint/docformatter
     rev: v1.3.1
     hooks:

diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@
 [🛠️Installation](https://mmrotate.readthedocs.io/en/latest/install.html) |
 [👀Model Zoo](docs/en/model_zoo.md) |
 [🤔Reporting Issues](https://github.com/open-mmlab/mmrotate/issues/new/choose)
+
 </div>
 
 ## Introduction
@@ -43,20 +44,19 @@ The master branch works with **PyTorch 1.6+**.
 
 https://user-images.githubusercontent.com/10410257/154433305-416d129b-60c8-44c7-9ebb-5ba106d3e9d5.MP4
 
-
 <details open>
 <summary><b>Major Features</b></summary>
 
-* **Support multiple angle representations**
+- **Support multiple angle representations**
 
   MMRotate provides three mainstream angle representations to meet different paper settings.
 
-* **Modular Design**
+- **Modular Design**
 
   We decompose the rotated object detection framework into different components,
   which makes it much easy and flexible to build a new model by combining different modules.
 
-* **Strong baseline and State of the art**
+- **Strong baseline and State of the art**
 
   The toolbox provides strong baselines and state-of-the-art methods in rotated object detection.
 
@@ -81,12 +81,11 @@ Please see [get_started.md](docs/en/get_started.md) for the basic usage of MMRot
 We provide [colab tutorial](demo/MMRotate_Tutorial.ipynb) for beginners.
 There are also tutorials:
 
-* [learn the basics](docs/en/intro.md)
-* [learn the config](docs/en/tutorials/customize_config.md)
-* [customize dataset](docs/en/tutorials/customize_dataset.md)
-* [customize model](docs/en/tutorials/customize_models.md)
-* [useful tools](docs/en/tutorials/useful_tools.md)
-
+- [learn the basics](docs/en/intro.md)
+- [learn the config](docs/en/tutorials/customize_config.md)
+- [customize dataset](docs/en/tutorials/customize_dataset.md)
+- [customize model](docs/en/tutorials/customize_models.md)
+- [useful tools](docs/en/tutorials/useful_tools.md)
 
 ## Model Zoo
 
@@ -96,23 +95,23 @@ A summary can be found in the [Model Zoo](docs/en/model_zoo.md) page.
 <details open>
 <summary><b>Supported algorithms:</b></summary>
 
-* [x] [Rotated RetinaNet-OBB/HBB](configs/rotated_retinanet/README.md) (ICCV'2017)
-* [x] [Rotated FasterRCNN-OBB](configs/rotated_faster_rcnn/README.md) (TPAMI'2017)
-* [x] [Rotated RepPoints-OBB](configs/rotated_reppoints/README.md) (ICCV'2019)
-* [x] [RoI Transformer](configs/roi_trans/README.md) (CVPR'2019)
-* [x] [Gliding Vertex](configs/gliding_vertex/README.md) (TPAMI'2020)
-* [x] [Rotated ATSS-OBB](configs/rotated_atss/README.md) (CVPR'2020)
-* [x] [CSL](configs/csl/README.md) (ECCV'2020)
-* [x] [R<sup>3</sup>Det](configs/r3det/README.md) (AAAI'2021)
-* [x] [S<sup>2</sup>A-Net](configs/s2anet/README.md) (TGRS'2021)
-* [x] [ReDet](configs/redet/README.md) (CVPR'2021)
-* [x] [Beyond Bounding-Box](configs/cfa/README.md) (CVPR'2021)
-* [x] [Oriented R-CNN](configs/oriented_rcnn/README.md) (ICCV'2021)
-* [x] [GWD](configs/gwd/README.md) (ICML'2021)
-* [x] [KLD](configs/kld/README.md) (NeurIPS'2021)
-* [x] [SASM](configs/sasm_reppoints/README.md) (AAAI'2022)
-* [x] [KFIoU](configs/kfiou/README.md) (arXiv)
-* [x] [G-Rep](configs/g_reppoints/README.md) (stay tuned)
+- [x] [Rotated RetinaNet-OBB/HBB](configs/rotated_retinanet/README.md) (ICCV'2017)
+- [x] [Rotated FasterRCNN-OBB](configs/rotated_faster_rcnn/README.md) (TPAMI'2017)
+- [x] [Rotated RepPoints-OBB](configs/rotated_reppoints/README.md) (ICCV'2019)
+- [x] [RoI Transformer](configs/roi_trans/README.md) (CVPR'2019)
+- [x] [Gliding Vertex](configs/gliding_vertex/README.md) (TPAMI'2020)
+- [x] [Rotated ATSS-OBB](configs/rotated_atss/README.md) (CVPR'2020)
+- [x] [CSL](configs/csl/README.md) (ECCV'2020)
+- [x] [R<sup>3</sup>Det](configs/r3det/README.md) (AAAI'2021)
+- [x] [S<sup>2</sup>A-Net](configs/s2anet/README.md) (TGRS'2021)
+- [x] [ReDet](configs/redet/README.md) (CVPR'2021)
+- [x] [Beyond Bounding-Box](configs/cfa/README.md) (CVPR'2021)
+- [x] [Oriented R-CNN](configs/oriented_rcnn/README.md) (ICCV'2021)
+- [x] [GWD](configs/gwd/README.md) (ICML'2021)
+- [x] [KLD](configs/kld/README.md) (NeurIPS'2021)
+- [x] [SASM](configs/sasm_reppoints/README.md) (AAAI'2022)
+- [x] [KFIoU](configs/kfiou/README.md) (arXiv)
+- [x] [G-Rep](configs/g_reppoints/README.md) (stay tuned)
 
 </details>
 
@@ -155,22 +154,22 @@ This project is released under the [Apache 2.0 license](LICENSE).
 
 ## Projects in OpenMMLab
 
-* [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab foundational library for computer vision.
-* [MIM](https://github.com/open-mmlab/mim): MIM installs OpenMMLab packages.
-* [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab image classification toolbox and benchmark.
-* [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab detection toolbox and benchmark.
-* [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab's next-generation platform for general 3D object detection.
-* [MMRotate](https://github.com/open-mmlab/mmrotate): OpenMMLab rotated object detection toolbox and benchmark.
-* [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab semantic segmentation toolbox and benchmark.
-* [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab text detection, recognition, and understanding toolbox.
-* [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab pose estimation toolbox and benchmark.
-* [MMHuman3D](https://github.com/open-mmlab/mmhuman3d): OpenMMLab 3D human parametric model toolbox and benchmark.
-* [MMSelfSup](https://github.com/open-mmlab/mmselfsup): OpenMMLab self-supervised learning toolbox and benchmark.
-* [MMRazor](https://github.com/open-mmlab/mmrazor): OpenMMLab model compression toolbox and benchmark.
-* [MMFewShot](https://github.com/open-mmlab/mmfewshot): OpenMMLab fewshot learning toolbox and benchmark.
-* [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab's next-generation action understanding toolbox and benchmark.
-* [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab video perception toolbox and benchmark.
-* [MMFlow](https://github.com/open-mmlab/mmflow): OpenMMLab optical flow toolbox and benchmark.
-* [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab image and video editing toolbox.
-* [MMGeneration](https://github.com/open-mmlab/mmgeneration): OpenMMLab image and video generative models toolbox.
-* [MMDeploy](https://github.com/open-mmlab/mmdeploy): OpenMMLab model deployment framework.
+- [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab foundational library for computer vision.
+- [MIM](https://github.com/open-mmlab/mim): MIM installs OpenMMLab packages.
+- [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab image classification toolbox and benchmark.
+- [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab detection toolbox and benchmark.
+- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab's next-generation platform for general 3D object detection.
+- [MMRotate](https://github.com/open-mmlab/mmrotate): OpenMMLab rotated object detection toolbox and benchmark.
+- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab semantic segmentation toolbox and benchmark.
+- [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab text detection, recognition, and understanding toolbox.
+- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab pose estimation toolbox and benchmark.
+- [MMHuman3D](https://github.com/open-mmlab/mmhuman3d): OpenMMLab 3D human parametric model toolbox and benchmark.
+- [MMSelfSup](https://github.com/open-mmlab/mmselfsup): OpenMMLab self-supervised learning toolbox and benchmark.
+- [MMRazor](https://github.com/open-mmlab/mmrazor): OpenMMLab model compression toolbox and benchmark.
+- [MMFewShot](https://github.com/open-mmlab/mmfewshot): OpenMMLab fewshot learning toolbox and benchmark.
+- [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab's next-generation action understanding toolbox and benchmark.
+- [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab video perception toolbox and benchmark.
+- [MMFlow](https://github.com/open-mmlab/mmflow): OpenMMLab optical flow toolbox and benchmark.
+- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab image and video editing toolbox.
+- [MMGeneration](https://github.com/open-mmlab/mmgeneration): OpenMMLab image and video generative models toolbox.
+- [MMDeploy](https://github.com/open-mmlab/mmdeploy): OpenMMLab model deployment framework.