Merge branch 'master_fork' into logging#903

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+blank_issues_enabled: false
+
+contact_links:
+  - name: Common Issues
+    url: https://mmcv.readthedocs.io/en/latest/trouble_shooting.html
+    about: Check if your issue already has solutions
+  - name: MMCV Documentation
+    url: https://mmcv.readthedocs.io/en/latest/
+    about: Check if your question is answered in docs

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+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 [....].
+
+**Related resources**
+If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+If you would like to implement the feature and create a PR, please leave a comment here and that would be much appreciated.

.github/ISSUE_TEMPLATE/general_questions.md

@@ -0,0 +1,13 @@
+---
+name: General questions
+about: Ask general questions to get help
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Checklist**
+
+1. I have searched related issues but cannot get the expected help.
+2. I have read the FAQ documentation but cannot get the expected help.

.github/ISSUE_TEMPLATE/unexpected_report.md

@@ -0,0 +1,46 @@
+---
+name: Unexpected Results
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Thanks for reporting the unexpected results and we appreciate it a lot.
+
+**Checklist**
+
+1. I have searched related issues but cannot get the expected help.
+2. I have read the [FAQ documentation](https://mmcv.readthedocs.io/en/latest/trouble_shooting.html) but cannot get the expected help.
+3. The unexpected results still exist in the latest version.
+
+**Describe the Issue**
+A clear and concise description of what the bug is, including what results are expected and what the real results you got.
+
+**Reproduction**
+
+1. What command, code, or script did you run?
+
+```bash
+A placeholder for the command.
+```
+
+2. Did you make any modifications on the code? Did you understand what you have modified?
+
+**Environment**
+
+1. Please run `python -c "from mmcv.utils import collect_env; print(collect_env())"` 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.)
+
+**Error traceback**
+If applicable, paste the error traceback here.
+
+```none
+A placeholder for traceback.
+```
+
+**Bug fix**
+If you have already identified the reason, you can provide the information here. If you are willing to create a PR to fix it, please also leave a comment here and that would be much appreciated!

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+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
+
+1. Pre-commit or other linting tools are used to fix the potential lint issues.
+2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
+3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
+4. The documentation has been modified accordingly, like docstring or example tutorials.

.pre-commit-config.yaml

@@ -33,7 +33,8 @@ repos:
     rev: 2.1.4
     hooks:
       - id: markdownlint
-        args: ["-r", "~MD002,~MD013,~MD029,~MD033,~MD034"]
+        args: ["-r", "~MD002,~MD013,~MD029,~MD033,~MD034",
+              "-t", "allow_different_nesting"]
   - repo: https://github.com/myint/docformatter
     rev: v1.3.1
     hooks:

README.md

@@ -11,13 +11,16 @@ English | [简体中文](README_zh-CN.md)
 MMCV is a foundational library for computer vision research and supports many
 research projects as below:
 
-- [MMDetection](https://github.com/open-mmlab/mmdetection): Detection toolbox and benchmark
-- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): General 3D object detection toolbox and benchmark
-- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): Semantic segmentation toolbox and benchmark
-- [MMEditing](https://github.com/open-mmlab/mmediting): Image and video editing toolbox
-- [MMPose](https://github.com/open-mmlab/mmpose): Pose estimation toolbox and benchmark
-- [MMAction2](https://github.com/open-mmlab/mmaction2): Action understanding toolbox and benchmark
-- [MMClassification](https://github.com/open-mmlab/mmclassification): Image classification toolbox and benchmark
+- [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.
+- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab semantic segmentation 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.
+- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab pose estimation toolbox and benchmark.
+- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab image and video editing toolbox.
+- [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab text detection, recognition and understanding toolbox.
+- [MMGeneration](https://github.com/open-mmlab/mmgeneration): OpenMMLab image and video generative models toolbox.
 
 It provides the following functionalities.
 
@@ -37,18 +40,12 @@ Note: MMCV requires Python 3.6+.
 
 There are two versions of MMCV:
 
-- **mmcv**: lite, without CUDA ops but all other features, similar to mmcv<1.0.0. It is useful when you do not need those CUDA ops.
 - **mmcv-full**: comprehensive, with full features and various CUDA ops out of box. It takes longer time to build.
+- **mmcv**: lite, without CUDA ops but all other features, similar to mmcv<1.0.0. It is useful when you do not need those CUDA ops.
 
-**Note**: Do not install both versions in the same environment, otherwise you may encounter errors like `ModuleNotFound`. You need to uninstall one before installing the other.
-
-a. Install the lite version.
-
-```python
-pip install mmcv
-```
+**Note**: Do not install both versions in the same environment, otherwise you may encounter errors like `ModuleNotFound`. You need to uninstall one before installing the other. `Installing the full verion is highly recommended if CUDA is avaliable`.
 
-b. Install the full version.
+a. Install the full version.
 
 Before installing mmcv-full, make sure that PyTorch has been successfully installed following the [official guide](https://pytorch.org/).
 
@@ -165,6 +162,12 @@ pip install mmcv-full
 
 Note that the local compiling may take up to 10 mins.
 
+b. Install the lite version.
+
+```python
+pip install mmcv
+```
+
 c. Install full version with custom operators for onnxruntime
 
 - Check [here](docs/onnxruntime_op.md) for detailed instruction.

README_zh-CN.md

@@ -10,15 +10,16 @@
 
 MMCV 是一个面向计算机视觉的基础库，它支持了很多开源项目，例如：
 
-- [MMCV](https://github.com/open-mmlab/mmcv): 计算机视觉基础库
-- [MMClassification](https://github.com/open-mmlab/mmclassification): 图像分类工具箱
-- [MMDetection](https://github.com/open-mmlab/mmdetection): 目标检测工具箱
-- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): 新一代通用 3D 目标检测平台
-- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): 语义分割工具箱
-- [MMAction2](https://github.com/open-mmlab/mmaction2): 新一代视频理解工具箱
-- [MMTracking](https://github.com/open-mmlab/mmtracking): 一体化视频目标感知平台
-- [MMPose](https://github.com/open-mmlab/mmpose): 姿态估计工具箱
-- [MMEditing](https://github.com/open-mmlab/mmediting): 图像视频编辑工具箱
+- [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱
+- [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab 目标检测工具箱
+- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab 新一代通用 3D 目标检测平台
+- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab 语义分割工具箱
+- [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab 新一代视频理解工具箱
+- [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab 一体化视频目标感知平台
+- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱
+- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab 图像视频编辑工具箱
+- [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab 全流程文字检测识别理解工具包
+- [MMGeneration](https://github.com/open-mmlab/mmgeneration): OpenMMLab 图片视频生成模型工具箱
 
 MMCV 提供了如下众多功能：
 
@@ -38,18 +39,12 @@ MMCV 提供了如下众多功能：
 
 MMCV 有两个版本：
 
-- **mmcv**: 精简版，不包含 CUDA 算子但包含其余所有特性和功能，类似 MMCV 1.0 之前的版本。如果你不需要使用 CUDA 算子的话，精简版可以作为一个考虑选项。
 - **mmcv-full**: 完整版，包含所有的特性以及丰富的开箱即用的 CUDA 算子。注意完整版本可能需要更长时间来编译。
+- **mmcv**: 精简版，不包含 CUDA 算子但包含其余所有特性和功能，类似 MMCV 1.0 之前的版本。如果你不需要使用 CUDA 算子的话，精简版可以作为一个考虑选项。
 
-**注意**: 请不要在同一个环境中安装两个版本，否则可能会遇到类似 `ModuleNotFound` 的错误。在安装一个版本之前，需要先卸载另一个。
-
-a. 安装精简版
-
-```python
-pip install mmcv
-```
+**注意**: 请不要在同一个环境中安装两个版本，否则可能会遇到类似 `ModuleNotFound` 的错误。在安装一个版本之前，需要先卸载另一个。`如果CUDA可用，强烈推荐安装mmcv-full`。
 
-b. 安装完整版
+a. 安装完整版
 
 在安装 mmcv-full 之前，请确保 PyTorch 已经成功安装在环境中，可以参考 PyTorch 官方[文档](https://pytorch.org/)。
 
@@ -164,6 +159,12 @@ pip install mmcv-full
 
 但注意本地编译可能会耗时 10 分钟以上。
 
+b. 安装精简版
+
+```python
+pip install mmcv
+```
+
 c. 安装完整版并且编译 onnxruntime 的自定义算子
 
 - 详细的指南请查看 [这里](docs/onnxruntime_op.md)。
@@ -177,3 +178,22 @@ c. 安装完整版并且编译 onnxruntime 的自定义算子
 ## 贡献指南
 
 我们感谢所有的贡献者为改进和提升 MMCV 所作出的努力。请参考[贡献指南](CONTRIBUTING.md)来了解参与项目贡献的相关指引。
+
+## 欢迎加入 OpenMMLab 社区
+
+扫描下方的二维码可关注 OpenMMLab 团队的 [知乎官方账号](https://www.zhihu.com/people/openmmlab)，加入 OpenMMLab 团队的 [官方交流 QQ 群](https://jq.qq.com/?_wv=1027&k=aCvMxdr3)
+
+<div align="center">
+<img src="docs/_static/zhihu_qrcode.jpg" height="400" />  <img src="docs/_static/qq_group_qrcode.jpg" height="400" />
+</div>
+
+我们会在 OpenMMLab 社区为大家
+
+- 📢 分享 AI 框架的前沿核心技术
+- 💻 解读 PyTorch 常用模块源码
+- 📰 发布 OpenMMLab 的相关新闻
+- 🚀 介绍 OpenMMLab 开发的前沿算法
+- 🏃 获取更高效的问题答疑和意见反馈
+- 🔥 提供与各行各业开发者充分交流的平台
+
+干货满满 📘，等你来撩 💗，OpenMMLab 社区期待您的加入 👬

docs/deployment.rst

@@ -0,0 +1,11 @@
+Deployment
+========
+
+.. toctree::
+    :maxdepth: 2
+
+    onnx.md
+    onnxruntime_op.md
+    onnxruntime_custom_ops.md
+    tensorrt_plugin.md
+    tensorrt_custom_ops.md

docs/index.rst

@@ -17,6 +17,7 @@ Contents
    cnn.md
    ops.md
    build.md
+   deployment.rst
    trouble_shooting.md
    api.rst
 

docs/onnx.md

@@ -14,36 +14,6 @@ opset_version = 11
 register_extra_symbolics(opset_version)
 ```
 
-## ONNX simplify
-
-### Intention
-
-`mmcv.onnx.simplify` is based on [onnx-simplifier](https://github.com/daquexian/onnx-simplifier), which is a useful tool to make exported ONNX models slimmer by performing a series of optimization. However, for Pytorch models with custom op from `mmcv`, it would break down. Thus, custom ops for ONNX Runtime should be registered.
-
-### Prerequisite
-
-`mmcv.onnx.simplify` has three dependencies: `onnx`, `onnxoptimizer`, `onnxruntime`. After installation of `mmcv`, you have to install them manually using pip.
-
-```bash
-pip install onnx onnxoptimizer onnxruntime
-```
-
-### Usage
-
-```python
-import onnx
-import numpy as np
-
-import mmcv
-from mmcv.onnx.simplify import simplify
-
-dummy_input = np.random.randn(1, 3, 224, 224).astype(np.float32)
-input = {'input':dummy_input}
-input_file = 'sample.onnx'
-output_file = 'slim.onnx'
-model = simplify(input_file, [input], output_file)
-```
-
 ### FAQs
 
 - None