Bump version to v2.25.0

open-mmlab · Jun 1, 2022 · ca11860 · ca11860
2 parents 240d7a3 + 5970e09
commit ca11860
Show file tree

Hide file tree

Showing 235 changed files with 8,251 additions and 2,606 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -6,12 +6,6 @@ jobs:
  - image: cimg/python:3.7.4
  steps:
  - checkout
- - run:
- name: Install dependencies
- command: |
- sudo apt-add-repository ppa:brightbox/ruby-ng -y
- sudo apt-get update
- sudo apt-get install -y ruby2.7
  - run:
  name: Install pre-commit hook
  command: |
@@ -61,7 +55,7 @@ jobs:
  condition:
  equal: [ "3.9.0", << parameters.python >> ]
  steps:
- - run: pip install protobuf && sudo apt-get update && sudo apt-get -y install libprotobuf-dev protobuf-compiler cmake
+ - run: pip install "protobuf <= 3.20.1" && sudo apt-get update && sudo apt-get -y install libprotobuf-dev protobuf-compiler cmake
  - run:
  name: Install mmdet dependencies
  command: |

diff --git a/.dev_scripts/gather_models.py b/.dev_scripts/gather_models.py
@@ -269,7 +269,7 @@ def main():
  # when using Panoptic Dataset, the evaluation key is 'PQ'.
  for i, key in enumerate(results_lut):
  if 'mAP' not in key and 'PQ' not in key:
- results_lut[i] = key + 'm_AP'
+ results_lut[i] = key + '_mAP'
  model_performance = get_final_results(log_json_path,
  final_epoch_or_iter, results_lut,
  by_epoch)

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/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 mmdet/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 mmdet/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/workflows/build.yml b/.github/workflows/build.yml
@@ -114,6 +114,10 @@ jobs:
  uses: actions/setup-python@v2
  with:
  python-version: ${{ matrix.python-version }}
+ - name: Fetch GPG keys
+ run: |
+ apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/cuda/repos/ubuntu1804/x86_64/3bf863cc.pub
+ apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/machine-learning/repos/ubuntu1804/x86_64/7fa2af80.pub
  - name: Install system dependencies
  run: |
  apt-get update && apt-get install -y ffmpeg libsm6 libxext6 git ninja-build libglib2.0-0 libsm6 libxrender-dev libxext6 python${{matrix.python-version}}-dev
@@ -125,7 +129,7 @@ jobs:
  - name: Install PyTorch
  run: python -m pip install torch==${{matrix.torch}} torchvision==${{matrix.torchvision}} -f https://download.pytorch.org/whl/torch_stable.html
  - name: Install dependencies for compiling onnx when python=3.9
- run: python -m pip install protobuf && apt-get install libprotobuf-dev protobuf-compiler
+ run: python -m pip install "protobuf <= 3.20.1" && apt-get install libprotobuf-dev protobuf-compiler
  if: ${{matrix.python-version == '3.9'}}
  - name: Install mmdet dependencies
  run: |
@@ -180,6 +184,10 @@ jobs:
  uses: actions/setup-python@v2
  with:
  python-version: ${{ matrix.python-version }}
+ - name: Fetch GPG keys
+ run: |
+ apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/cuda/repos/ubuntu1804/x86_64/3bf863cc.pub
+ apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/machine-learning/repos/ubuntu1804/x86_64/7fa2af80.pub
  # Add ppa source repo for python3.9.
  - name: Add python3.9 source
  run: |
@@ -202,7 +210,7 @@ jobs:
  - name: Install PyTorch
  run: python -m pip install torch==${{matrix.torch}} torchvision==${{matrix.torchvision}} -f https://download.pytorch.org/whl/torch_stable.html
  - name: Install dependencies for compiling onnx when python=3.9
- run: python -m pip install protobuf && apt-get update && apt-get -y install libprotobuf-dev protobuf-compiler cmake
+ run: python -m pip install "protobuf <= 3.20.1" && apt-get update && apt-get -y install libprotobuf-dev protobuf-compiler cmake
  if: ${{matrix.python-version == '3.9'}}
  - name: Install mmdet dependencies
  run: |
@@ -246,7 +254,7 @@ jobs:
  with:
  python-version: ${{ matrix.python }}
  - name: Upgrade pip
- run: pip install pip --upgrade --user
+ run: python -m pip install pip --upgrade --user
  - name: Install PyTorch
  # As a complement to Linux CI, we test on PyTorch LTS version
  run: pip install torch==1.8.2+${{ matrix.platform }} torchvision==0.9.2+${{ matrix.platform }} -f https://download.pytorch.org/whl/lts/1.8/torch_lts.html

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
@@ -24,16 +24,19 @@ 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
+ - 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
@@ -2,17 +2,17 @@
  <img src="resources/mmdet-logo.png" width="600"/>
  <div>&nbsp;</div>
  <div align="center">
- <b>OpenMMLab website</b>
+ <b><font size="5">OpenMMLab website</font></b>
  <sup>
   <a href="https://openmmlab.com">
-  <i>HOT</i>
+  <i><font size="4">HOT</font></i>
   </a>
  </sup>
  &nbsp;&nbsp;&nbsp;&nbsp;
- <b>OpenMMLab platform</b>
+ <b><font size="5">OpenMMLab platform</font></b>
  <sup>
   <a href="https://platform.openmmlab.com">
-  <i>TRY IT OUT</i>
+  <i><font size="4">TRY IT OUT</font></i>
   </a>
  </sup>
  </div>
@@ -24,27 +24,32 @@
 [![codecov](https://codecov.io/gh/open-mmlab/mmdetection/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmdetection)
 [![license](https://img.shields.io/github/license/open-mmlab/mmdetection.svg)](https://github.com/open-mmlab/mmdetection/blob/master/LICENSE)
 [![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmdetection.svg)](https://github.com/open-mmlab/mmdetection/issues)
+[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmdetection.svg)](https://github.com/open-mmlab/mmdetection/issues)
 
- <img src="https://user-images.githubusercontent.com/12907710/137271636-56ba1cd2-b110-4812-8221-b4c120320aa9.png"/>
-
-[📘Documentation](https://mmdetection.readthedocs.io/en/v2.21.0/) |
-[🛠️Installation](https://mmdetection.readthedocs.io/en/v2.21.0/get_started.html) |
-[👀Model Zoo](https://mmdetection.readthedocs.io/en/v2.21.0/model_zoo.html) |
-[🆕Update News](https://mmdetection.readthedocs.io/en/v2.21.0/changelog.html) |
+[📘Documentation](https://mmdetection.readthedocs.io/en/stable/) |
+[🛠️Installation](https://mmdetection.readthedocs.io/en/stable/get_started.html) |
+[👀Model Zoo](https://mmdetection.readthedocs.io/en/stable/model_zoo.html) |
+[🆕Update News](https://mmdetection.readthedocs.io/en/stable/changelog.html) |
 [🚀Ongoing Projects](https://github.com/open-mmlab/mmdetection/projects) |
 [🤔Reporting Issues](https://github.com/open-mmlab/mmdetection/issues/new/choose)
 
 </div>
 
-## Introduction
+<div align="center">
 
 English | [简体中文](README_zh-CN.md)
 
+</div>
+
+## Introduction
+
 MMDetection is an open source object detection toolbox based on PyTorch. It is
 a part of the [OpenMMLab](https://openmmlab.com/) project.
 
 The master branch works with **PyTorch 1.5+**.
 
+<img src="https://user-images.githubusercontent.com/12907710/137271636-56ba1cd2-b110-4812-8221-b4c120320aa9.png"/>
+
 <details open>
 <summary>Major features</summary>
 
@@ -68,22 +73,42 @@ The master branch works with **PyTorch 1.5+**.
 
 Apart from MMDetection, we also released a library [mmcv](https://github.com/open-mmlab/mmcv) for computer vision research, which is heavily depended on by this toolbox.
 
-## License
-
-This project is released under the [Apache 2.0 license](LICENSE).
-
-## Changelog
+## What's New
 
-**2.24.1** was released in 30/4/2022:
+**2.25.0** was released in 1/6/2022:
 
-- Support [Simple Copy Paste](configs/simple_copy_paste)
-- Support automatically scaling LR according to GPU number and samples per GPU
-- Support Class Aware Sampler that improves performance on OpenImages Dataset
+- Support dedicated `MMDetWandbHook` hook
+- Support [ConvNeXt](configs/convnext), [DDOD](configs/ddod), [SOLOv2](configs/solov2)
+- Support [Mask2Former](configs/mask2former) for instance segmentation
+- Rename [config files of Mask2Former](configs/mask2former)
 
 Please refer to [changelog.md](docs/en/changelog.md) for details and release history.
 
 For compatibility changes between different versions of MMDetection, please refer to [compatibility.md](docs/en/compatibility.md).
 
+## Installation
+
+Please refer to [Installation](docs/en/get_started.md/#Installation) for installation instructions.
+
+## Getting Started
+
+Please see [get_started.md](docs/en/get_started.md) for the basic usage of MMDetection. We provide [colab tutorial](demo/MMDet_Tutorial.ipynb) and [instance segmentation colab tutorial](demo/MMDet_InstanceSeg_Tutorial.ipynb), and other tutorials for:
+
+- [with existing dataset](docs/en/1_exist_data_model.md)
+- [with new dataset](docs/en/2_new_data_model.md)
+- [with existing dataset_new_model](docs/en/3_exist_data_new_model.md)
+- [learn about configs](docs/en/tutorials/config.md)
+- [customize_datasets](docs/en/tutorials/customize_dataset.md)
+- [customize data pipelines](docs/en/tutorials/data_pipeline.md)
+- [customize_models](docs/en/tutorials/customize_models.md)
+- [customize runtime settings](docs/en/tutorials/customize_runtime.md)
+- [customize_losses](docs/en/tutorials/customize_losses.md)
+- [finetuning models](docs/en/tutorials/finetune.md)
+- [export a model to ONNX](docs/en/tutorials/pytorch2onnx.md)
+- [export ONNX to TRT](docs/en/tutorials/onnx2tensorrt.md)
+- [weight initialization](docs/en/tutorials/init_cfg.md)
+- [how to xxx](docs/en/tutorials/how_to.md)
+
 ## Overview of Benchmark and Model Zoo
 
 Results and models are available in the [model zoo](docs/en/model_zoo.md).
@@ -132,6 +157,7 @@ Results and models are available in the [model zoo](docs/en/model_zoo.md).
   <li><a href="configs/double_heads">Double-Head R-CNN (CVPR'2020)</a></li>
   <li><a href="configs/atss">ATSS (CVPR'2020)</a></li>
   <li><a href="configs/nas_fcos">NAS-FCOS (CVPR'2020)</a></li>
+  <li><a href="configs/centripetalnet">CentripetalNet (CVPR'2020)</a></li>
   <li><a href="configs/autoassign">AutoAssign (ArXiv'2020)</a></li>
   <li><a href="configs/sabl">Side-Aware Boundary Localization (ECCV'2020)</a></li>
   <li><a href="configs/dynamic_rcnn">Dynamic R-CNN (ECCV'2020)</a></li>
@@ -143,7 +169,7 @@ Results and models are available in the [model zoo](docs/en/model_zoo.md).
   <li><a href="configs/yolox">YOLOX (CVPR'2021)</a></li>
   <li><a href="configs/deformable_detr">Deformable DETR (ICLR'2021)</a></li>
   <li><a href="configs/tood">TOOD (ICCV'2021)</a></li>
-  <li><a href="configs/centripetalnet">CentripetalNet (CVPR'2020)</a></li>
+  <li><a href="configs/ddod">DDOD (ACM MM'2021)</a></li>
   </ul>
   </td>
   <td>
@@ -157,8 +183,10 @@ Results and models are available in the [model zoo](docs/en/model_zoo.md).
   <li><a href="configs/solo">SOLO (ECCV'2020)</a></li>
   <li><a href="configs/point_rend">PointRend (CVPR'2020)</a></li>
   <li><a href="configs/detectors">DetectoRS (ArXiv'2020)</a></li>
+  <li><a href="configs/solov2">SOLOv2 (NeurIPS'2020)</a></li>
   <li><a href="configs/scnet">SCNet (AAAI'2021)</a></li>
   <li><a href="configs/queryinst">QueryInst (ICCV'2021)</a></li>
+  <li><a href="configs/mask2former">Mask2Former (ArXiv'2021)</a></li>
   </ul>
   </td>
   <td>
@@ -231,6 +259,7 @@ Results and models are available in the [model zoo](docs/en/model_zoo.md).
   <li><a href="configs/pvt">PVTv2 (ArXiv'2021)</a></li>
   <li><a href="configs/resnet_strikes_back">ResNet strikes back (ArXiv'2021)</a></li>
   <li><a href="configs/efficientnet">EfficientNet (ArXiv'2021)</a></li>
+  <li><a href="configs/convnext">ConvNeXt (CVPR'2022)</a></li>
   </ul>
   </td>
   <td>
@@ -270,15 +299,7 @@ Results and models are available in the [model zoo](docs/en/model_zoo.md).
 
 Some other methods are also supported in [projects using MMDetection](./docs/en/projects.md).
 
-## Installation
-
-Please refer to [get_started.md](docs/en/get_started.md) for installation.
-
-## Getting Started
-
-Please see [get_started.md](docs/en/get_started.md) for the basic usage of MMDetection.
-We provide [detection colab tutorial](demo/MMDet_Tutorial.ipynb) and [instance segmentation colab tutorial](demo/MMDet_InstanceSeg_Tutorial.ipynb), and full guidance for quick run [with existing dataset](docs/en/1_exist_data_model.md) and [with new dataset](docs/en/2_new_data_model.md) for beginners.
-There are also tutorials for [finetuning models](docs/en/tutorials/finetune.md), [adding new dataset](docs/en/tutorials/customize_dataset.md), [designing data pipeline](docs/en/tutorials/data_pipeline.md), [customizing models](docs/en/tutorials/customize_models.md), [customizing runtime settings](docs/en/tutorials/customize_runtime.md) and [useful tools](docs/en/useful_tools.md).
+## FAQ
 
 Please refer to [FAQ](docs/en/faq.md) for frequently asked questions.
 
@@ -309,6 +330,10 @@ If you use this toolbox or benchmark in your research, please cite this project.
 }
 ```
 
+## License
+
+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.