[Docs] Replace markdownlint with mdformat for avoiding installing ruby

open-mmlab · May 20, 2022 · 66587e6 · 66587e6
1 parent 0945527
commit 66587e6
Show file tree

Hide file tree

Showing 75 changed files with 1,451 additions and 1,412 deletions.
diff --git a/.dev/log_collector/readme.md b/.dev/log_collector/readme.md
@@ -43,7 +43,7 @@ markdown_file ='markdowns/lr_in_trans.json.md'
 json_file = 'jsons/trans_in_cnn.json'
 ```
 
- The structure of the work-dir directory should be like：
+The structure of the work-dir directory should be like：
 
 ```text
 ├── work-dir
@@ -69,14 +69,15 @@ python log_collector.py ./example_config.py
 
 The output markdown file is like:
 
-|exp_num|method|mIoU best|best index|mIoU last|last index|last iter num|
-|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
-|1|segformer_mit-b5_512x512_160k_ade20k_cnn_lr_with_warmup|0.2776|10|0.2776|10|160000|
-|2|segformer_mit-b5_512x512_160k_ade20k_cnn_no_warmup_lr|0.2802|10|0.2802|10|160000|
-|3|segformer_mit-b5_512x512_160k_ade20k_mit_trans_lr|0.4943|11|0.4943|11|160000|
-|4|segformer_mit-b5_512x512_160k_ade20k_swin_trans_lr|0.4883|11|0.4883|11|160000|
+| exp_num |                         method                          | mIoU best | best index | mIoU last | last index | last iter num |
+| :-----: | :-----------------------------------------------------: | :-------: | :--------: | :-------: | :--------: | :-----------: |
+|    1    | segformer_mit-b5_512x512_160k_ade20k_cnn_lr_with_warmup |  0.2776   |     10     |  0.2776   |     10     |    160000     |
+|    2    |  segformer_mit-b5_512x512_160k_ade20k_cnn_no_warmup_lr  |  0.2802   |     10     |  0.2802   |     10     |    160000     |
+|    3    |    segformer_mit-b5_512x512_160k_ade20k_mit_trans_lr    |  0.4943   |     11     |  0.4943   |     11     |    160000     |
+|    4    |   segformer_mit-b5_512x512_160k_ade20k_swin_trans_lr    |  0.4883   |     11     |  0.4883   |     11     |    160000     |
 
 The output json file is like:
+
 ```json
 [
     {

diff --git a/.dev/md2yml.py b/.dev/md2yml.py
@@ -127,9 +127,11 @@ def parse_md(md_file):
             elif line[:15] == '<!-- [BACKBONE]':
                 is_backbone = True
                 i += 1
-            elif line[0] == '|' and (
-                    i + 1) < len(lines) and lines[i + 1][:3] == '| -':
+            elif (line[0] == '|' and (i + 1) < len(lines)
+                  and lines[i + 1][:3] == '| -' and 'Method' in line
+                  and 'Crop Size' in line and 'Mem (GB)' in line):
                 cols = [col.strip() for col in line.split('|')]
+                print(cols)
                 method_id = cols.index('Method')
                 backbone_id = cols.index('Backbone')
                 crop_size_id = cols.index('Crop Size')

diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 
@@ -70,7 +70,7 @@ members of the project's leadership.
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: https://www.contributor-covenant.org
-
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
+
+[homepage]: https://www.contributor-covenant.org
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -16,8 +16,8 @@ All kinds of contributions are welcome, including but not limited to the followi
 
 - 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 mmsegmentation,
-  please contact Kai Chen (chenkaidev[at]gmail[dot]com). We will much appreciate your contribution.
-:::
+  please contact Kai Chen (chenkaidev\[at\]gmail\[dot\]com). We will much appreciate your contribution.
+  :::
 
 ## Code style
 
@@ -34,7 +34,7 @@ We use the following tools for linting and formatting:
 Style configurations of yapf and isort can be found in [setup.cfg](../setup.cfg) and [.isort.cfg](../.isort.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.
+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.
@@ -51,7 +51,7 @@ pre-commit install
 
 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.
+> Before you create a PR, make sure that your code lints and is formatted by yapf.
 
 ### C++ and CUDA
 

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.
@@ -21,19 +20,20 @@ A clear and concise description of what the bug is.
 
 1. What command or script did you run?
 
-    ```none
-    A placeholder for the command.
-    ```
+   ```none
+   A placeholder for the command.
+   ```
 
 2. Did you make any modifications on the code or config? Did you understand what you have modified?
+
 3. What dataset did you use?
 
 **Environment**
 
 1. Please run `python mmseg/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**
 

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: ''
-
 ---
 
 If you feel we have helped you, give us a STAR! :satisfied:
@@ -54,7 +53,7 @@ A placeholder for the config.
 
 1. Please run `PYTHONPATH=${PWD}:$PYTHONPATH python mmseg/utils/collect_env.py` to collect the necessary environment information and paste it here.
 2. You may add an 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/README_zh-CN.md b/README_zh-CN.md
@@ -208,7 +208,7 @@ MMSegmentation 是一个由来自不同高校和企业的研发人员共同参
  <img src="docs/zh_cn/imgs/zhihu_qrcode.jpg" height="400" />  <img src="docs/zh_cn/imgs/qq_group_qrcode.jpg" height="400" />
  </div>
 
- 我们会在 OpenMMLab 社区为大家
+我们会在 OpenMMLab 社区为大家
 
 - 📢 分享 AI 框架的前沿核心技术
 - 💻 解读 PyTorch 常用模块源码
@@ -217,4 +217,4 @@ MMSegmentation 是一个由来自不同高校和企业的研发人员共同参
 - 🏃 获取更高效的问题答疑和意见反馈
 - 🔥 提供与各行各业开发者充分交流的平台
 
- 干货满满 📘，等你来撩 💗，OpenMMLab 社区期待您的加入 👬
+干货满满 📘，等你来撩 💗，OpenMMLab 社区期待您的加入 👬