support v1.4.0

6f3c5f1c · limm · 6f674c7e · 6f3c5f1c · 6f3c5f1c · 6f3c5f1c
Commit 6f3c5f1c authored Jul 11, 2024 by limm
20 changed files
--- a/docs/zh_cn/_static/css/readthedocs.css
+++ b/docs/zh_cn/_static/css/readthedocs.css
@@ -4,7 +4,3 @@
    height: 40px;
    width: 85px;
 }
-table.colwidths-auto td {
-    width: 50%
-}
--- a/docs/zh_cn/_static/image/mmcv-logo.png
+++ b/docs/zh_cn/_static/image/mmcv-logo.png
--- a/docs_zh_CN/api.rst
+++ b/docs_zh_CN/api.rst
+fileio
+-------
+.. automodule:: mmcv.fileio
+    :members:
+image
+------
+.. automodule:: mmcv.image
+    :members:
+video
+------
+.. automodule:: mmcv.video
+    :members:
+arraymisc
+---------
+.. automodule:: mmcv.arraymisc
+    :members:
+visualization
+--------------
+.. automodule:: mmcv.visualization
+    :members:
+utils
+-----
+.. automodule:: mmcv.utils
+    :members:
+cnn
+----
+.. automodule:: mmcv.cnn
+    :members:
+runner
+------
+.. automodule:: mmcv.runner
+    :members:
+ops
+------
+.. automodule:: mmcv.ops
+    :members:
--- a/docs_zh_CN/community/contributing.md
+++ b/docs_zh_CN/community/contributing.md
+## 贡献代码
+欢迎任何类型的贡献，包括但不限于
+- 修改拼写错误或代码错误
+- 添加文档或将文档翻译成其他语言
+- 添加新功能和新组件
+### 工作流
+| 详细工作流见 [拉取请求](pr.md)
+1. 复刻并拉取最新的 OpenMMLab 算法库
+2. 创建新的分支（不建议使用主分支提拉取请求）
+3. 提交你的修改
+4. 创建拉取请求
+```{note}
+如果你计划添加新功能并且该功能包含比较大的改动，建议先开 issue 讨论
+```
+### 代码风格
+#### Python
+[PEP8](https://www.python.org/dev/peps/pep-0008/) 作为 OpenMMLab 算法库首选的代码规范，我们使用以下工具检查和格式化代码
+- [flake8](http://flake8.pycqa.org/en/latest/): Python 官方发布的代码规范检查工具，是多个检查工具的封装
+- [yapf](https://github.com/google/yapf): Google 发布的代码规范检查工具
+- [isort](https://github.com/timothycrosley/isort): 自动调整模块导入顺序的工具
+- [markdownlint](https://github.com/markdownlint/markdownlint): 检查 markdown 文件的工具
+- [docformatter](https://github.com/myint/docformatter): 格式化 docstring 的工具
+yapf 和 isort 的配置可以在 [setup.cfg](./setup.cfg) 找到
+通过配置 [pre-commit hook](https://pre-commit.com/) ，我们可以在提交代码时自动检查和格式化 `flake8`、`yapf`、`isort`、`trailing whitespaces`、`markdown files`，
+修复 `end-of-files`、`double-quoted-strings`、`python-encoding-pragma`、`mixed-line-ending`，调整 `requirments.txt` 的包顺序。
+pre-commit 钩子的配置可以在 [.pre-commit-config](./.pre-commit-config.yaml) 找到。
+在克隆算法库后，你需要安装并初始化 pre-commit 钩子
+```shell
+pip install -U pre-commit
+```
+切换算法库根目录
+```shell
+pre-commit install
+```
+如果安装 markdownlint 遇到了问题，可以尝试使用以下的步骤安装 ruby
+```shell
+# install rvm
+curl -L https://get.rvm.io | bash -s -- --autolibs=read-fail
+[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"
+rvm autolibs disable
+# install ruby
+rvm install 2.7.1
+```
+或者参考 [这个代码库](https://github.com/innerlee/setup) 和 [`zzruby.sh`](https://github.com/innerlee/setup/blob/master/zzruby.sh)。
+至此，每一次 commit 修改都会触发 pre-commit 检查代码格式。
+>提交拉取请求前，请确保你的代码符合 yapf 的格式
+#### C++ and CUDA
+C++ 和 CUDA 的代码规范遵从 [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)
--- a/docs_zh_CN/community/pr.md
+++ b/docs_zh_CN/community/pr.md
+## 拉取请求
+### 什么是拉取请求？
+`拉取请求` (Pull Request), [GitHub 官方文档](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)定义如下。
+>拉取请求是一种通知机制。你修改了他人的代码，将你的修改通知原来作者，希望他合并你的修改。
+### 基本的工作流：
+1. 获取最新的代码库
+2. 从主分支创建最新的分支进行开发
+3. 提交修改
+4. 推送你的修改并创建一个`拉取请求`
+5. 讨论、审核代码
+6. 将开发分支合并到主分支
+### 具体步骤
+1. 获取最新的代码库
+    + 当你第一次提 PR 时
+        - 复刻 OpenMMLab 原代码库，点击 GitHub 页面右上角的 **Fork** 按钮即可
+        ![avatar](../../docs/_static/community/1.png)
+        - 克隆复刻的代码库到本地
+            ```bash
+            git clone git@github.com:XXX/mmcv.git
+            ```
+        - 添加原代码库为上游代码库
+            ```bash
+            git remote add upstream git@github.com:open-mmlab/mmcv
+            ```
+    + 从第二个 PR 起
+       - 检出本地代码库的主分支，然后从最新的原代码库的主分支拉取更新
+            ```bash
+            git checkout master
+            git pull upstream master
+            ```
+2. 从主分支创建一个新的开发分支
+    ```bash
+    git checkout -b branchname
+    ```
+    注意：为了保证提交历史清晰可读，我们强烈推荐您先检出主分支 (master)，再创建新的分支。
+3. 提交你的修改
+    ```bash
+    # coding
+    git add [files]
+    git commit -m 'messages'
+    ```
+4. 推送你的修改到复刻的代码库，并创建一个`拉取请求`
+    + 推送当前分支到远端复刻的代码库
+        ```bash
+        git push origin branchname
+        ```
+    + 创建一个`拉取请求`
+    ![avatar](../../docs/_static/community/2.png)
+    + 修改`拉取请求`信息模板，描述修改原因和修改内容。还可以在 PR 描述中，手动关联到相关的`议题` (issue),（更多细节，请参考[官方文档](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)）。
+5. 讨论并评审你的代码
+    + 创建`拉取请求`时，可以关联给相关人员进行评审
+    ![avatar](../../docs/_static/community/3.png)
+    + 根据评审人员的意见修改代码，并推送修改
+6.  `拉取请求`合并之后删除该分支
+```bash
+git branch -d branchname # delete local branch
+git push origin --delete branchname # delete remote branch
+```
+### PR 规范
+1. 使用 [pre-commit hook](https://pre-commit.com)，尽量减少代码风格相关问题
+2. 一个PR对应一个短期分支
+3. 粒度要细，一个PR只做一件事情，避免超大的PR
+    >- Bad:实现Faster R-CNN
+    >- Acceptable:给 Faster R-CNN 添加一个 box head
+    >- Good:给 box head 增加一个参数来支持自定义的 conv 层数
+4. 每次 Commit 时需要提供清晰且有意义 commit 信息
+5. 提供清晰且有意义的`拉取请求`描述
+    >- 标题写明白任务名称，一般格式:[Prefix] Short description of the pull request (Suffix)
+    >- prefix: 新增功能 [Feature], 修 bug [Fix], 文档相关 [Docs], 开发中 [WIP] (暂时不会被review)
+    >- 描述里介绍`拉取请求`的主要修改内容，结果，以及对其他部分的影响, 参考`拉取请求`模板
+    >- 关联相关的`议题` (issue) 和其他`拉取请求`
--- a/docs/zh_cn/compatibility.md
+++ b/docs/zh_cn/compatibility.md
--- a/docs/en/conf.py
+++ b/docs/en/conf.py
@@ -15,19 +15,21 @@ import os
 import sys
 import pytorch_sphinx_theme
+from m2r import MdInclude
+from recommonmark.transform import AutoStructify
 from sphinx.builders.html import StandaloneHTMLBuilder
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('..'))
-version_file = '../../mmcv/version.py'
+version_file = '../mmcv/version.py'
-with open(version_file) as f:
+with open(version_file, 'r') as f:
    exec(compile(f.read(), version_file, 'exec'))
 __version__ = locals()['__version__']
 # -- Project information -----------------------------------------------------
 project = 'mmcv'
-copyright = '2018-2022, OpenMMLab'
+copyright = '2018-2021, OpenMMLab'
 author = 'MMCV Authors'
 # The short X.Y version
@@ -47,28 +49,16 @@ release = __version__
 extensions = [
    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
+    'sphinx.ext.autosectionlabel',
    'sphinx_markdown_tables',
    'myst_parser',
    'sphinx_copybutton',
 ]  # yapf: disable
-myst_heading_anchors = 4
-myst_enable_extensions = ['colon_fence']
-# Configuration for intersphinx
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'numpy': ('https://numpy.org/doc/stable', None),
-    'torch': ('https://pytorch.org/docs/stable/', None),
-    'mmengine': ('https://mmengine.readthedocs.io/en/latest', None),
-}
 autodoc_mock_imports = ['mmcv._ext', 'mmcv.utils.ext_loader', 'torchvision']
+autosectionlabel_prefix_document = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -89,7 +79,7 @@ master_doc = 'index'
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'zh_CN'
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -118,9 +108,94 @@ html_theme_options = {
            'name': 'GitHub',
            'url': 'https://github.com/open-mmlab/mmcv'
        },
-    ],
+        {
-    # Specify the language of shared menu
+            'name':
-    'menu_lang': 'en',
+            '文档',
+            'children': [
+                {
+                    'name': 'MMCV',
+                    'url': 'https://mmcv.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MIM',
+                    'url': 'https://openmim.readthedocs.io/en/latest/'
+                },
+                {
+                    'name': 'MMAction2',
+                    'url': 'https://mmaction2.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMClassification',
+                    'url':
+                    'https://mmclassification.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMDetection',
+                    'url': 'https://mmdetection.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMDetection3D',
+                    'url':
+                    'https://mmdetection3d.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMEditing',
+                    'url': 'https://mmediting.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMGeneration',
+                    'url': 'https://mmgeneration.readthedocs.io/en/latest/',
+                },
+                {
+                    'name': 'MMOCR',
+                    'url': 'https://mmocr.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMPose',
+                    'url': 'https://mmpose.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMSegmentation',
+                    'url':
+                    'https://mmsegmentation.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMTracking',
+                    'url': 'https://mmtracking.readthedocs.io/zh_CN/latest/',
+                },
+                {
+                    'name': 'MMFlow',
+                    'url': 'https://mmflow.readthedocs.io/en/latest/',
+                },
+                {
+                    'name': 'MMFewShot',
+                    'url': 'https://mmfewshot.readthedocs.io/zh_CN/latest/',
+                },
+            ]
+        },
+        {
+            'name':
+            'OpenMMLab',
+            'children': [
+                {
+                    'name': '主页',
+                    'url': 'https://openmmlab.com/'
+                },
+                {
+                    'name': 'GitHub',
+                    'url': 'https://github.com/open-mmlab/'
+                },
+                {
+                    'name': '推特',
+                    'url': 'https://twitter.com/OpenMMLab'
+                },
+                {
+                    'name': '知乎',
+                    'url': 'https://zhihu.com/people/openmmlab'
+                },
+            ]
+        },
+    ]
 }
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -213,3 +288,16 @@ StandaloneHTMLBuilder.supported_image_types = [
 # Ignore >>> when copying code
 copybutton_prompt_text = r'>>> |\.\.\. '
 copybutton_prompt_is_regexp = True
+def setup(app):
+    app.add_config_value('no_underscore_emphasis', False, 'env')
+    app.add_config_value('m2r_parse_relative_links', False, 'env')
+    app.add_config_value('m2r_anonymous_references', False, 'env')
+    app.add_config_value('m2r_disable_inline_math', False, 'env')
+    app.add_directive('mdinclude', MdInclude)
+    app.add_config_value('recommonmark_config', {
+        'auto_toc_tree_section': 'Contents',
+        'enable_eval_rst': True,
+    }, True)
+    app.add_transform(AutoStructify)
--- a/docs_zh_CN/deployment/onnx.md
+++ b/docs_zh_CN/deployment/onnx.md
+## MMCV中ONNX模块简介 (实验性)
+### register_extra_symbolics
+在将PyTorch模型导出成ONNX时，需要注册额外的符号函数
+#### 范例
+```python
+import mmcv
+from mmcv.onnx import register_extra_symbolics
+opset_version = 11
+register_extra_symbolics(opset_version)
+```
+#### 常见问题
+- 无
--- a/docs_zh_CN/deployment/onnxruntime_custom_ops.md
+++ b/docs_zh_CN/deployment/onnxruntime_custom_ops.md
+## ONNX Runtime自定义算子
+<!-- TOC -->
+- [ONNX Runtime自定义算子](#onnx-runtime自定义算子)
+  - [SoftNMS](#softnms)
+    - [描述](#描述)
+    - [模型参数](#模型参数)
+    - [输入](#输入)
+    - [输出](#输出)
+    - [类型约束](#类型约束)
+  - [RoIAlign](#roialign)
+    - [描述](#描述-1)
+    - [模型参数](#模型参数-1)
+    - [输入](#输入-1)
+    - [输出](#输出-1)
+    - [类型约束](#类型约束-1)
+  - [NMS](#nms)
+    - [描述](#描述-2)
+    - [模型参数](#模型参数-2)
+    - [输入](#输入-2)
+    - [输出](#输出-2)
+    - [类型约束](#类型约束-2)
+  - [grid_sampler](#grid_sampler)
+    - [描述](#描述-3)
+    - [模型参数](#模型参数-3)
+    - [输入](#输入-3)
+    - [输出](#输出-3)
+    - [类型约束](#类型约束-3)
+  - [CornerPool](#cornerpool)
+    - [描述](#描述-4)
+    - [模型参数](#模型参数-4)
+    - [输入](#输入-4)
+    - [输出](#输出-4)
+    - [类型约束](#类型约束-4)
+  - [cummax](#cummax)
+    - [描述](#描述-5)
+    - [模型参数](#模型参数-5)
+    - [输入](#输入-5)
+    - [输出](#输出-5)
+    - [类型约束](#类型约束-5)
+  - [cummin](#cummin)
+    - [描述](#描述-6)
+    - [模型参数](#模型参数-6)
+    - [输入](#输入-6)
+    - [输出](#输出-6)
+    - [类型约束](#类型约束-6)
+  - [MMCVModulatedDeformConv2d](#mmcvmodulateddeformconv2d)
+    - [描述](#描述-7)
+    - [模型参数](#模型参数-7)
+    - [输入](#输入-7)
+    - [输出](#输出-7)
+    - [类型约束](#类型约束-7)
+<!-- TOC -->
+### SoftNMS
+#### 描述
+根据`scores`计算`boxes`的soft NMS。 请阅读[Soft-NMS -- Improving Object Detection With One Line of Code](https://arxiv.org/abs/1704.04503)了解细节。
+#### 模型参数
+| 类型    | 参数名          | 描述                                                    |
+| ------- | --------------- | ------------------------------------------------------- |
+| `float` | `iou_threshold` | 用来判断候选框重合度的阈值，取值范围[0, 1]。默认值为0   |
+| `float` | `sigma`         | 高斯方法的超参数                                        |
+| `float` | `min_score`     | NMS的score阈值                                          |
+| `int`   | `method`        | NMS的计算方式, (0: `naive`, 1: `linear`, 2: `gaussian`) |
+| `int`   | `offset`        | 用来计算候选框的宽高(x2 - x1 + offset)。可选值0或1      |
+#### 输入
+<dl>
+<dt><tt>boxes</tt>: T</dt>
+<dd>输入候选框。形状为(N, 4)的二维张量，N为候选框数量。</dd>
+<dt><tt>scores</tt>: T</dt>
+<dd>输入得分。形状为(N, )的一维张量。</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>dets</tt>: T</dt>
+<dd>输出的检测框与得分。形状为(num_valid_boxes, 5)的二维张量，内容为[[x1, y1, x2, y2, score], ...]。num_valid_boxes是合法的检测框数量。</dd>
+<dt><tt>indices</tt>: tensor(int64)</dt>
+<dd>输出序号。形状为(num_valid_boxes, )的一维张量。</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32)
+### RoIAlign
+#### 描述
+在特征图上计算RoIAlign，通常在双阶段目标检测模型的bbox_head中使用
+#### 模型参数
+| 类型    | 参数名           | 描述                                                    |
+| ------- | ---------------- | ------------------------------------------------------- |
+| `int`   | `output_height`  | roi特征的输出高度                                       |
+| `int`   | `output_width`   | roi特征的输出宽度                                       |
+| `float` | `spatial_scale`  | 输入检测框的缩放系数                                    |
+| `int`   | `sampling_ratio` | 输出的采样率。`0`表示使用密集采样                       |
+| `str`   | `mode`           | 池化方式。 `avg`或`max`                                 |
+| `int`   | `aligned`        | 如果`aligned=1`，则像素会进行-0.5的偏移以达到更好的对齐 |
+#### 输入
+<dl>
+<dt><tt>input</tt>: T</dt>
+<dd>输入特征图；形状为(N, C, H, W)的四维张量，其中N为batch大小，C为输入通道数，H和W为输入特征图的高和宽。</dd>
+<dt><tt>rois</tt>: T</dt>
+<dd>需要进行池化的感兴趣区域；形状为(num_rois, 5)的二维张量，内容为[[batch_index, x1, y1, x2, y2], ...]。rois的坐标为输入特征图的坐标系。</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>feat</tt>: T</dt>
+<dd>池化的输出；形状为(num_rois, C, output_height, output_width)的四维张量。每个输出特征feat[i]都与输入感兴趣区域rois[i]一一对应。<dd>
+</dl>
+#### 类型约束
+- T:tensor(float32)
+### NMS
+#### 描述
+根据IoU阈值对候选框进行非极大值抑制。
+#### 模型参数
+| 类型    | 参数名          | 描述                                                  |
+| ------- | --------------- | ----------------------------------------------------- |
+| `float` | `iou_threshold` | 用来判断候选框重合度的阈值，取值范围[0, 1]。默认值为0 |
+| `int`   | `offset`        | 用来计算候选框的宽高(x2 - x1 + offset)。可选值0或1    |
+#### 输入
+<dl>
+<dt><tt>boxes</tt>: T</dt>
+<dd>输入候选框。形状为(N, 4)的二维张量，N为候选框数量。</dd>
+<dt><tt>scores</tt>: T</dt>
+<dd>输入得分。形状为(N, )的一维张量。</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>indices</tt>: tensor(int32, Linear)</dt>
+<dd>被选中的候选框索引。形状为(num_valid_boxes, )的一维张量，num_valid_boxes表示被选上的候选框数量。</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32)
+### grid_sampler
+#### 描述
+根据`grid`的像素位置对`input`进行网格采样。
+#### 模型参数
+| 类型  | 参数名               | 描述                                                                                                                                                 |
+| ----- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `int` | `interpolation_mode` | 计算输出使用的插值模式。(0: `bilinear` , 1: `nearest`)                                                                                               |
+| `int` | `padding_mode`       | 边缘填充模式。(0: `zeros`, 1: `border`, 2: `reflection`)                                                                                             |
+| `int` | `align_corners`      | 如果`align_corners=1`，则极值(`-1`和`1`)会被当做输入边缘像素的中心点。如果`align_corners=0`，则它们会被看做是边缘像素的边缘点,减小分辨率对采样的影响 |
+#### 输入
+<dl>
+<dt><tt>input</tt>: T</dt>
+<dd>输入特征；形状为(N, C, inH, inW)的四维张量，其中N为batch大小，C为输入通道数，inH和inW为输入特征图的高和宽。</dd>
+<dt><tt>grid</tt>: T</dt>
+<dd>输入网格；形状为(N, outH, outW, 2)的四维张量，outH和outW为输出的高和宽。 </dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>output</tt>: T</dt>
+<dd>输出特征；形状为(N, C, outH, outW)的四维张量。</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### CornerPool
+#### 描述
+对`input`计算CornerPool。请阅读[CornerNet -- Detecting Objects as Paired Keypoints](https://arxiv.org/abs/1808.01244)了解更多细节。
+#### 模型参数
+| 类型  | 参数名 | 描述                                                     |
+| ----- | ------ | -------------------------------------------------------- |
+| `int` | `mode` | 池化模式。(0: `top`, 1: `bottom`, 2: `left`, 3: `right`) |
+#### 输入
+<dl>
+<dt><tt>input</tt>: T</dt>
+<dd>输入特征；形状为(N, C, H, W)的四维张量，其中N为batch大小，C为输入通道数，H和W为输入特征图的高和宽。</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>output</tt>: T</dt>
+<dd>输出特征；形状为(N, C, H, W)的四维张量。</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32)
+### cummax
+#### 描述
+返回一个元组(`values`, `indices`)，其中`values`为`input`第`dim`维的累计最大值，`indices`为第`dim`维最大值位置。请阅读[torch.cummax](https://pytorch.org/docs/stable/generated/torch.cummax.html)了解更多细节。
+#### 模型参数
+| 类型  | 参数名 | 描述               |
+| ----- | ------ | ------------------ |
+| `int` | `dim`  | 进行累计计算的维度 |
+#### 输入
+<dl>
+<dt><tt>input</tt>: T</dt>
+<dd>输入张量；可以使任意形状；也支持空Tensor</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>output</tt>: T</dt>
+<dd>`input`第`dim`维的累计最大值，形状与`input`相同。类型和`input`一致</dd>
+<dt><tt>indices</tt>: tensor(int64)</dt>
+<dd>第`dim`维最大值位置，形状与`input`相同。</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32)
+### cummin
+#### 描述
+返回一个元组(`values`, `indices`)，其中`values`为`input`第`dim`维的累计最小值，`indices`为第`dim`维最小值位置。请阅读[torch.cummin](https://pytorch.org/docs/stable/generated/torch.cummin.html)了解更多细节。
+#### 模型参数
+| 类型  | 参数名 | 描述               |
+| ----- | ------ | ------------------ |
+| `int` | `dim`  | 进行累计计算的维度 |
+#### 输入
+<dl>
+<dt><tt>input</tt>: T</dt>
+<dd>输入张量；可以是任意形状；也支持空Tensor</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>output</tt>: T</dt>
+<dd>`input`第`dim`维的累计最小值，形状与`input`相同。类型和`input`一致</dd>
+<dt><tt>indices</tt>: tensor(int64)</dt>
+<dd>第`dim`维最小值位置，形状与`input`相同。</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32)
+### MMCVModulatedDeformConv2d
+#### 描述
+在输入特征上计算Modulated Deformable Convolution，请阅读[Deformable ConvNets v2: More Deformable, Better Results](https://arxiv.org/abs/1811.11168?from=timeline)了解更多细节。
+#### 模型参数
+| 类型           | 参数名              | 描述                                                          |
+| -------------- | ------------------- | ------------------------------------------------------------- |
+| `list of ints` | `stride`            | 卷积的步长 (sH, sW)                                           |
+| `list of ints` | `padding`           | 输入特征填充大小 (padH, padW)                                 |
+| `list of ints` | `dilation`          | 卷积核各元素间隔 (dH, dW)                                     |
+| `int`          | `deformable_groups` | 可变偏移量的分组，通常置位1即可                               |
+| `int`          | `groups`            | 卷积分组数，`input_channel`会根据这个值被分为数个分组进行计算 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入特征；形状为(N, C, inH, inW)的四维张量，其中N为batch大小，C为输入通道数，inH和inW为输入特征图的高和宽。</dd>
+<dt><tt>inputs[1]</tt>: T</dt>
+<dd>输入偏移量；形状为(N, deformable_group* 2* kH* kW, outH, outW)的四维张量，kH和kW为输入特征图的高和宽，outH和outW为输入特征图的高和宽。</dd>
+<dt><tt>inputs[2]</tt>: T</dt>
+<dd>输入掩码；形状为(N, deformable_group* kH* kW, outH, outW)的四维张量。</dd>
+<dt><tt>inputs[3]</tt>: T</dt>
+<dd>输入权重；形状为(output_channel, input_channel, kH, kW)的四维张量。</dd>
+<dt><tt>inputs[4]</tt>: T, optional</dt>
+<dd>输入偏移量；形状为(output_channel)的一维张量。</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>输出特征；形状为(N, output_channel, outH, outW)的四维张量。</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
--- a/docs_zh_CN/deployment/onnxruntime_op.md
+++ b/docs_zh_CN/deployment/onnxruntime_op.md
+## MMCV中的ONNX Runtime自定义算子
+### ONNX Runtime介绍
+**ONNX Runtime**是一个跨平台的推理与训练加速器，适配许多常用的机器学习/深度神经网络框架。请访问[github](https://github.com/microsoft/onnxruntime)了解更多信息。
+### ONNX介绍
+**ONNX**是**Open Neural Network Exchange**的缩写，是许多机器学习/深度神经网络框架使用的*中间表示(IR)*。请访问[github](https://github.com/onnx/onnx)了解更多信息。
+### 为什么要在MMCV中添加ONNX自定义算子？
+- 为了验证ONNX模型在ONNX Runtime下的推理的正确性。
+- 为了方便使用了`mmcv.ops`自定义算子的模型的部署工作。
+### MMCV已支持的算子
+|                                       算子                                       |  CPU  |  GPU  | MMCV版本 |
+| :------------------------------------------------------------------------------: | :---: | :---: | :------: |
+|                   [SoftNMS](onnxruntime_custom_ops.md#softnms)                   |   Y   |   N   |  1.2.3   |
+|                  [RoIAlign](onnxruntime_custom_ops.md#roialign)                  |   Y   |   N   |  1.2.5   |
+|                       [NMS](onnxruntime_custom_ops.md#nms)                       |   Y   |   N   |  1.2.7   |
+|              [grid_sampler](onnxruntime_custom_ops.md#grid_sampler)              |   Y   |   N   |  1.3.1   |
+|                [CornerPool](onnxruntime_custom_ops.md#cornerpool)                |   Y   |   N   |  1.3.4   |
+|                    [cummax](onnxruntime_custom_ops.md#cummax)                    |   Y   |   N   |  1.3.4   |
+|                    [cummin](onnxruntime_custom_ops.md#cummin)                    |   Y   |   N   |  1.3.4   |
+| [MMCVModulatedDeformConv2d](onnxruntime_custom_ops.md#mmcvmodulateddeformconv2d) |   Y   |   N   |  1.3.12  |
+### 如何编译ONNX Runtime自定义算子？
+*请注意我们仅在**onnxruntime>=1.8.1**的Linux x86-64 cpu平台上进行过测试*
+#### 准备工作
+- 克隆代码仓库
+```bash
+git clone https://github.com/open-mmlab/mmcv.git
+```
+- 从ONNX Runtime下载`onnxruntime-linux`：[releases](https://github.com/microsoft/onnxruntime/releases/tag/v1.8.1)，解压缩，根据路径创建变量`ONNXRUNTIME_DIR`并把路径下的lib目录添加到`LD_LIBRARY_PATH`，步骤如下：
+```bash
+wget https://github.com/microsoft/onnxruntime/releases/download/v1.8.1/onnxruntime-linux-x64-1.8.1.tgz
+tar -zxvf onnxruntime-linux-x64-1.8.1.tgz
+cd onnxruntime-linux-x64-1.8.1
+export ONNXRUNTIME_DIR=$(pwd)
+export LD_LIBRARY_PATH=$ONNXRUNTIME_DIR/lib:$LD_LIBRARY_PATH
+```
+#### Linux系统下编译
+```bash
+cd mmcv ## to MMCV root directory
+MMCV_WITH_OPS=1 MMCV_WITH_ORT=1 python setup.py develop
+```
+### 如何在python下使用ONNX Runtime对导出的ONNX模型做编译
+使用`pip`安装ONNX Runtime
+```bash
+pip install onnxruntime==1.8.1
+```
+推理范例
+```python
+import os
+import numpy as np
+import onnxruntime as ort
+from mmcv.ops import get_onnxruntime_op_path
+ort_custom_op_path = get_onnxruntime_op_path()
+assert os.path.exists(ort_custom_op_path)
+session_options = ort.SessionOptions()
+session_options.register_custom_ops_library(ort_custom_op_path)
+## exported ONNX model with custom operators
+onnx_file = 'sample.onnx'
+input_data = np.random.randn(1, 3, 224, 224).astype(np.float32)
+sess = ort.InferenceSession(onnx_file, session_options)
+onnx_results = sess.run(None, {'input' : input_data})
+```
+### 如何为MMCV添加ONNX Runtime的自定义算子
+#### 开发前提醒
+- 该算子的ONNX Runtime实现尚未在MMCV中支持[已实现算子列表](https://github.com/microsoft/onnxruntime/blob/master/docs/OperatorKernels.md)。
+- 确保该自定义算子可以被ONNX导出。
+#### 添加方法
+以`soft_nms`为例：
+1. 在ONNX Runtime头文件目录`mmcv/ops/csrc/onnxruntime/`下添加头文件`soft_nms.h`
+2. 在ONNX Runtime源码目录`mmcv/ops/csrc/onnxruntime/cpu/`下添加算子实现`soft_nms.cpp`
+3. 在[onnxruntime_register.cpp](../../mmcv/ops/csrc/onnxruntime/cpu/onnxruntime_register.cpp)中注册实现的算子`soft_nms`
+    ```c++
+    #include "soft_nms.h"
+    SoftNmsOp c_SoftNmsOp;
+    if (auto status = ortApi->CustomOpDomain_Add(domain, &c_SoftNmsOp)) {
+    return status;
+    }
+    ```
+4. 在`tests/test_ops/test_onnx.py`添加单元测试，
+   可以参考[here](../../tests/test_ops/test_onnx.py)。
+**最后，欢迎为MMCV添加ONNX Runtime自定义算子** :nerd_face:
+### 已知问题
+- "RuntimeError: tuple appears in op that does not forward tuples, unsupported kind: `prim::PythonOp`."
+   1. 请注意`cummax`和`cummin`算子是在torch >= 1.5.0被添加的。但他们需要在torch version >= 1.7.0才能正确导出。否则会在导出时发生上面的错误。
+   2. 解决方法：升级PyTorch到1.7.0以上版本
+### 引用
+- [How to export Pytorch model with custom op to ONNX and run it in ONNX Runtime](https://github.com/onnx/tutorials/blob/master/PyTorchCustomOperator/README.md)
+- [How to add a custom operator/kernel in ONNX Runtime](https://github.com/microsoft/onnxruntime/blob/master/docs/AddingCustomOp.md)
--- a/docs_zh_CN/deployment/tensorrt_custom_ops.md
+++ b/docs_zh_CN/deployment/tensorrt_custom_ops.md
+## TensorRT自定义算子
+<!-- TOC -->
+- [TensorRT自定义算子](#tensorrt自定义算子)
+  - [MMCVRoIAlign](#mmcvroialign)
+    - [描述](#描述)
+    - [模型参数](#模型参数)
+    - [输入](#输入)
+    - [输出](#输出)
+    - [类型约束](#类型约束)
+  - [ScatterND](#scatternd)
+    - [描述](#描述-1)
+    - [模型参数](#模型参数-1)
+    - [输入](#输入-1)
+    - [输出](#输出-1)
+    - [类型约束](#类型约束-1)
+  - [NonMaxSuppression](#nonmaxsuppression)
+    - [描述](#描述-2)
+    - [模型参数](#模型参数-2)
+    - [输入](#输入-2)
+    - [输出](#输出-2)
+    - [类型约束](#类型约束-2)
+  - [MMCVDeformConv2d](#mmcvdeformconv2d)
+    - [描述](#描述-3)
+    - [模型参数](#模型参数-3)
+    - [输入](#输入-3)
+    - [输出](#输出-3)
+    - [类型约束](#类型约束-3)
+  - [grid_sampler](#grid_sampler)
+    - [描述](#描述-4)
+    - [模型参数](#模型参数-4)
+    - [输入](#输入-4)
+    - [输出](#输出-4)
+    - [类型约束](#类型约束-4)
+  - [cummax](#cummax)
+    - [描述](#描述-5)
+    - [模型参数](#模型参数-5)
+    - [输入](#输入-5)
+    - [输出](#输出-5)
+    - [类型约束](#类型约束-5)
+  - [cummin](#cummin)
+    - [描述](#描述-6)
+    - [模型参数](#模型参数-6)
+    - [输入](#输入-6)
+    - [输出](#输出-6)
+    - [类型约束](#类型约束-6)
+  - [MMCVInstanceNormalization](#mmcvinstancenormalization)
+    - [描述](#描述-7)
+    - [模型参数](#模型参数-7)
+    - [输入](#输入-7)
+    - [输出](#输出-7)
+    - [类型约束](#类型约束-7)
+  - [MMCVModulatedDeformConv2d](#mmcvmodulateddeformconv2d)
+    - [描述](#描述-8)
+    - [模型参数](#模型参数-8)
+    - [输入](#输入-8)
+    - [输出](#输出-8)
+    - [类型约束](#类型约束-8)
+<!-- TOC -->
+### MMCVRoIAlign
+#### 描述
+在特征图上计算RoIAlign，在多数双阶段目标检测模型的bbox_head中使用
+#### 模型参数
+| 类型    | 参数名           | 描述                                                    |
+| ------- | ---------------- | ------------------------------------------------------- |
+| `int`   | `output_height`  | roi特征的输出高度                                       |
+| `int`   | `output_width`   | roi特征的输出宽度                                       |
+| `float` | `spatial_scale`  | 输入检测框的缩放系数                                    |
+| `int`   | `sampling_ratio` | 输出的采样率。`0`表示使用密集采样                       |
+| `str`   | `mode`           | 池化方式。 `avg`或`max`                                 |
+| `int`   | `aligned`        | 如果`aligned=1`，则像素会进行-0.5的偏移以达到更好的对齐 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入特征图；形状为(N, C, H, W)的四维张量，其中N为batch大小，C为输入通道数，H和W为输入特征图的高和宽。</dd>
+<dt><tt>inputs[1]</tt>: T</dt>
+<dd>需要进行池化的感兴趣区域；形状为(num_rois, 5)的二维张量，内容为[[batch_index, x1, y1, x2, y2], ...]。rois的坐标为输入特征图的坐标系。</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>池化的输出；形状为(num_rois, C, output_height, output_width)的四维张量。每个输出特征feat[i]都与输入感兴趣区域rois[i]一一对应。<dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### ScatterND
+#### 描述
+ScatterND接收三个输入，分别为秩为r >= 1的`data`，秩为q >= 1的`indices`以及秩为 q + r - indices.shape[-1] -1 的`update`。输出的计算方式为：首先创建一个`data`的拷贝，然后根据`indces`的值使用`update`对拷贝的`data`进行更新。注意`indices`中不应该存在相同的条目，也就是说对同一个位置进行一次以上的更新是不允许的。
+输出的计算方式可以参考如下代码：
+```python
+  output = np.copy(data)
+  update_indices = indices.shape[:-1]
+  for idx in np.ndindex(update_indices):
+      output[indices[idx]] = updates[idx]
+```
+#### 模型参数
+无
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>秩为r >= 1的输入`data`</dd>
+<dt><tt>inputs[1]</tt>: tensor(int32, Linear)</dt>
+<dd>秩为q >= 1的输入`update`</dd>
+<dt><tt>inputs[2]</tt>: T</dt>
+<dd>秩为 q + r - indices.shape[-1] -1 的输入`update`</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>秩为r >= 1的输出张量</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear), tensor(int32, Linear)
+### NonMaxSuppression
+#### 描述
+根据IoU阈值对候选框进行非极大值抑制。
+#### 模型参数
+| 类型    | 参数名                       | 描述                                                                                     |
+| ------- | ---------------------------- | ---------------------------------------------------------------------------------------- |
+| `int`   | `center_point_box`           | 0 - 候选框的格式为[y1, x1, y2, x2]， 1-候选框的格式为[x_center, y_center, width, height] |
+| `int`   | `max_output_boxes_per_class` | 每一类最大的输出检测框个数。默认为0，输出检测框个数等于输入候选框数                      |
+| `float` | `iou_threshold`              | 用来判断候选框重合度的阈值，取值范围[0, 1]。默认值为0                                    |
+| `float` | `score_threshold`            | 用来判断候选框是否合法的阈值                                                             |
+| `int`   | `offset`                     | 检测框长宽计算方式为(x2 - x1 + offset)，可选值0或1                                       |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入候选框。形状为(num_batches, spatial_dimension, 4)的三维张量</dd>
+<dt><tt>inputs[1]</tt>: T</dt>
+<dd>输入得分。形状为(num_batches, num_classes, spatial_dimension)的三维张量</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: tensor(int32, Linear)</dt>
+<dd>被选中的候选框索引。形状为(num_selected_indices, 3)的二维张量。每一行内容为[batch_index, class_index, box_index]。</dd>
+<dd>其中 num_selected_indices=num_batches* num_classes* min(max_output_boxes_per_class, spatial_dimension)。</dd>
+<dd>所有未被选中的候选框索引都会被填充为-1</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### MMCVDeformConv2d
+#### 描述
+在输入特征上计算Deformable Convolution，请阅读[Deformable Convolutional Network](https://arxiv.org/abs/1703.06211)了解更多细节。
+#### 模型参数
+| 类型           | 参数名             | 描述                                                                                          |
+| -------------- | ------------------ | --------------------------------------------------------------------------------------------- |
+| `list of ints` | `stride`           | 卷积的步长 (sH, sW)                                                                           |
+| `list of ints` | `padding`          | 输入特征填充大小 (padH, padW)                                                                 |
+| `list of ints` | `dilation`         | 卷积核各元素间隔 (dH, dW)                                                                     |
+| `int`          | `deformable_group` | 可变偏移量的分组                                                                              |
+| `int`          | `group`            | 卷积分组数，`input_channel`会根据这个值被分为数个分组进行计算                                 |
+| `int`          | `im2col_step`      | 可变卷积使用im2col计算卷积。输入与偏移量会以im2col_step为步长分块计算，减少临时空间的使用量。 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入特征；形状为(N, C, inH, inW)的四维张量，其中N为batch大小，C为输入通道数，inH和inW为输入特征图的高和宽</dd>
+<dt><tt>inputs[1]</tt>: T</dt>
+<dd>输入偏移量；形状为(N, deformable_group* 2* kH* kW, outH, outW)的四维张量，kH和kW为输入特征图的高和宽，outH和outW为输入特征图的高和宽</dd>
+<dt><tt>inputs[2]</tt>: T</dt>
+<dd>输入权重；形状为(output_channel, input_channel, kH, kW)的四维张量</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>输出特征；形状为(N, output_channel, outH, outW)的四维张量</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### grid_sampler
+#### 描述
+根据`grid`的像素位置对`input`进行网格采样。
+#### 模型参数
+| 类型  | 参数名               | 描述                                                                                                                                                 |
+| ----- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `int` | `interpolation_mode` | 计算输出使用的插值模式。(0: `bilinear` , 1: `nearest`)                                                                                               |
+| `int` | `padding_mode`       | 边缘填充模式。(0: `zeros`, 1: `border`, 2: `reflection`)                                                                                             |
+| `int` | `align_corners`      | 如果`align_corners=1`，则极值(`-1`和`1`)会被当做输入边缘像素的中心点。如果`align_corners=0`，则它们会被看做是边缘像素的边缘点,减小分辨率对采样的影响 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入特征；形状为(N, C, inH, inW)的四维张量，其中N为batch大小，C为输入通道数，inH和inW为输入特征图的高和宽</dd>
+<dt><tt>inputs[1]</tt>: T</dt>
+<dd>输入网格；形状为(N, outH, outW, 2)的四维张量，outH和outW为输出的高和宽 </dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>输出特征；形状为(N, C, outH, outW)的四维张量</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### cummax
+#### 描述
+返回一个元组(`values`, `indices`)，其中`values`为`input`第`dim`维的累计最大值，`indices`为第`dim`维最大值位置。请阅读[torch.cummax](https://pytorch.org/docs/stable/generated/torch.cummax.html)了解更多细节。
+#### 模型参数
+| 类型  | 参数名 | 描述               |
+| ----- | ------ | ------------------ |
+| `int` | `dim`  | 进行累计计算的维度 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入张量；可以使任意形状</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>`input`第`dim`维的累计最大值，形状与`input`相同。类型和`input`一致</dd>
+<dt><tt>outputs[1]</tt>: (int32, Linear)</dt>
+<dd>第`dim`维最大值位置，形状与`input`相同</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### cummin
+#### 描述
+返回一个元组(`values`, `indices`)，其中`values`为`input`第`dim`维的累计最小值，`indices`为第`dim`维最小值位置。请阅读[torch.cummin](https://pytorch.org/docs/stable/generated/torch.cummin.html)了解更多细节。
+#### 模型参数
+| 类型  | 参数名 | 描述               |
+| ----- | ------ | ------------------ |
+| `int` | `dim`  | 进行累计计算的维度 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入张量；可以使任意形状</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>`input`第`dim`维的累计最小值，形状与`input`相同。类型和`input`一致</dd>
+<dt><tt>outputs[1]</tt>: (int32, Linear)</dt>
+<dd>第`dim`维最小值位置，形状与`input`相同</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### MMCVInstanceNormalization
+#### 描述
+对特征计算instance normalization，请阅读[Instance Normalization: The Missing Ingredient for Fast Stylization](https://arxiv.org/abs/1607.08022)了解更多详细信息。
+#### 模型参数
+| 类型    | 参数名    | 描述                         |
+| ------- | --------- | ---------------------------- |
+| `float` | `epsilon` | 用来避免除0错误。默认为1e-05 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入特征。形状为(N, C, H， W)的四维张量，其中N为batch大小，C为输入通道数，H和W为输入特征图的高和宽</dd>
+<dt><tt>inputs[1]</tt>: T</dt>
+<dd>输入缩放系数。形状为(C，)的一维张量</dd>
+<dt><tt>inputs[2]</tt>: T</dt>
+<dd>输入偏移量。形状为(C，)的一维张量</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>输出特征。形状为(N, C, H， W)的四维张量</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
+### MMCVModulatedDeformConv2d
+#### 描述
+在输入特征上计算Modulated Deformable Convolution，请阅读[Deformable ConvNets v2: More Deformable, Better Results](https://arxiv.org/abs/1811.11168?from=timeline)了解更多细节。
+#### 模型参数
+| 类型           | 参数名              | 描述                                                          |
+| -------------- | ------------------- | ------------------------------------------------------------- |
+| `list of ints` | `stride`            | 卷积的步长 (sH, sW)                                           |
+| `list of ints` | `padding`           | 输入特征填充大小 (padH, padW)                                 |
+| `list of ints` | `dilation`          | 卷积核各元素间隔 (dH, dW)                                     |
+| `int`          | `deformable_groups` | 可变偏移量的分组，通常置位1即可                               |
+| `int`          | `groups`            | 卷积分组数，`input_channel`会根据这个值被分为数个分组进行计算 |
+#### 输入
+<dl>
+<dt><tt>inputs[0]</tt>: T</dt>
+<dd>输入特征；形状为(N, C, inH, inW)的四维张量，其中N为batch大小，C为输入通道数，inH和inW为输入特征图的高和宽</dd>
+<dt><tt>inputs[1]</tt>: T</dt>
+<dd>输入偏移量；形状为(N, deformable_group* 2* kH* kW, outH, outW)的四维张量，kH和kW为输入特征图的高和宽，outH和outW为输入特征图的高和宽</dd>
+<dt><tt>inputs[2]</tt>: T</dt>
+<dd>输入掩码；形状为(N, deformable_group* kH* kW, outH, outW)的四维张量</dd>
+<dt><tt>inputs[3]</tt>: T</dt>
+<dd>输入权重；形状为(output_channel, input_channel, kH, kW)的四维张量</dd>
+<dt><tt>inputs[4]</tt>: T, optional</dt>
+<dd>输入偏移量；形状为(output_channel)的一维张量</dd>
+</dl>
+#### 输出
+<dl>
+<dt><tt>outputs[0]</tt>: T</dt>
+<dd>输出特征；形状为(N, output_channel, outH, outW)的四维张量</dd>
+</dl>
+#### 类型约束
+- T:tensor(float32, Linear)
--- a/docs_zh_CN/deployment/tensorrt_plugin.md
+++ b/docs_zh_CN/deployment/tensorrt_plugin.md
+## MMCV中的TensorRT自定义算子 (实验性)
+<!-- TOC -->
+- [MMCV中的TensorRT自定义算子 (实验性)](#mmcv中的tensorrt自定义算子-实验性)
+  - [介绍](#介绍)
+  - [MMCV中的TensorRT插件列表](#mmcv中的tensorrt插件列表)
+  - [如何编译MMCV中的TensorRT插件](#如何编译mmcv中的tensorrt插件)
+    - [准备](#准备)
+    - [在Linux上编译](#在linux上编译)
+  - [创建TensorRT推理引擎并在python下进行推理](#创建tensorrt推理引擎并在python下进行推理)
+  - [如何在MMCV中添加新的TensorRT自定义算子](#如何在mmcv中添加新的tensorrt自定义算子)
+    - [主要流程](#主要流程)
+    - [注意](#注意)
+  - [已知问题](#已知问题)
+  - [引用](#引用)
+<!-- TOC -->
+### 介绍
+**NVIDIA TensorRT**是一个为深度学习模型高性能推理准备的软件开发工具(SDK)。它包括深度学习推理优化器和运行时，可为深度学习推理应用提供低延迟和高吞吐量。请访问[developer's website](https://developer.nvidia.com/tensorrt)了解更多信息。
+为了简化TensorRT部署带有MMCV自定义算子的模型的流程，MMCV中添加了一系列TensorRT插件。
+### MMCV中的TensorRT插件列表
+|         ONNX算子          |                                  TensorRT插件                                   | MMCV版本 |
+| :-----------------------: | :-----------------------------------------------------------------------------: | :------: |
+|       MMCVRoiAlign        |              [MMCVRoiAlign](./tensorrt_custom_ops.md#mmcvroialign)              |  1.2.6   |
+|         ScatterND         |                 [ScatterND](./tensorrt_custom_ops.md#scatternd)                 |  1.2.6   |
+|     NonMaxSuppression     |         [NonMaxSuppression](./tensorrt_custom_ops.md#nonmaxsuppression)         |  1.3.0   |
+|     MMCVDeformConv2d      |          [MMCVDeformConv2d](./tensorrt_custom_ops.md#mmcvdeformconv2d)          |  1.3.0   |
+|       grid_sampler        |              [grid_sampler](./tensorrt_custom_ops.md#grid-sampler)              |  1.3.1   |
+|          cummax           |                    [cummax](./tensorrt_custom_ops.md#cummax)                    |  1.3.5   |
+|          cummin           |                    [cummin](./tensorrt_custom_ops.md#cummin)                    |  1.3.5   |
+| MMCVInstanceNormalization | [MMCVInstanceNormalization](./tensorrt_custom_ops.md#mmcvinstancenormalization) |  1.3.5   |
+| MMCVModulatedDeformConv2d | [MMCVModulatedDeformConv2d](./tensorrt_custom_ops.md#mmcvmodulateddeformconv2d) |  master  |
+注意
+- 以上所有算子均在 TensorRT-7.2.1.6.Ubuntu-16.04.x86_64-gnu.cuda-10.2.cudnn8.0 环境下开发。
+### 如何编译MMCV中的TensorRT插件
+#### 准备
+- 克隆代码仓库
+```bash
+git clone https://github.com/open-mmlab/mmcv.git
+```
+- 安装TensorRT
+从 [NVIDIA Developer Zone](https://developer.nvidia.com/nvidia-tensorrt-download) 下载合适的TensorRT版本。
+比如，对安装了cuda-10.2的x86-64的Ubuntu 16.04，下载文件为`TensorRT-7.2.1.6.Ubuntu-16.04.x86_64-gnu.cuda-10.2.cudnn8.0.tar.gz`.
+然后使用下面方式安装并配置环境
+```bash
+cd ~/Downloads
+tar -xvzf TensorRT-7.2.1.6.Ubuntu-16.04.x86_64-gnu.cuda-10.2.cudnn8.0.tar.gz
+export TENSORRT_DIR=`pwd`/TensorRT-7.2.1.6
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$TENSORRT_DIR/lib
+```
+安装python依赖: tensorrt, graphsurgeon, onnx-graphsurgeon
+```bash
+pip install $TENSORRT_DIR/python/tensorrt-7.2.1.6-cp37-none-linux_x86_64.whl
+pip install $TENSORRT_DIR/onnx_graphsurgeon/onnx_graphsurgeon-0.2.6-py2.py3-none-any.whl
+pip install $TENSORRT_DIR/graphsurgeon/graphsurgeon-0.4.5-py2.py3-none-any.whl
+```
+想了解更多通过tar包安装TensorRT，请访问[Nvidia' website](https://docs.nvidia.com/deeplearning/tensorrt/archives/tensorrt-721/install-guide/index.html#installing-tar).
+#### 在Linux上编译
+```bash
+cd mmcv ## to MMCV root directory
+MMCV_WITH_OPS=1 MMCV_WITH_TRT=1 pip install -e .
+```
+### 创建TensorRT推理引擎并在python下进行推理
+范例如下：
+```python
+import torch
+import onnx
+from mmcv.tensorrt import (TRTWrapper, onnx2trt, save_trt_engine,
+                                   is_tensorrt_plugin_loaded)
+assert is_tensorrt_plugin_loaded(), 'Requires to complie TensorRT plugins in mmcv'
+onnx_file = 'sample.onnx'
+trt_file = 'sample.trt'
+onnx_model = onnx.load(onnx_file)
+## Model input
+inputs = torch.rand(1, 3, 224, 224).cuda()
+## Model input shape info
+opt_shape_dict = {
+    'input': [list(inputs.shape),
+              list(inputs.shape),
+              list(inputs.shape)]
+}
+## Create TensorRT engine
+max_workspace_size = 1 << 30
+trt_engine = onnx2trt(
+    onnx_model,
+    opt_shape_dict,
+    max_workspace_size=max_workspace_size)
+## Save TensorRT engine
+save_trt_engine(trt_engine, trt_file)
+## Run inference with TensorRT
+trt_model = TRTWrapper(trt_file, ['input'], ['output'])
+with torch.no_grad():
+    trt_outputs = trt_model({'input': inputs})
+    output = trt_outputs['output']
+```
+### 如何在MMCV中添加新的TensorRT自定义算子
+#### 主要流程
+下面是主要的步骤：
+1. 添加c++头文件
+2. 添加c++源文件
+3. 添加cuda kernel文件
+4. 在`trt_plugin.cpp`中注册插件
+5. 在`tests/test_ops/test_tensorrt.py`中添加单元测试
+**以RoIAlign算子插件`roi_align`举例。**
+1. 在TensorRT包含目录`mmcv/ops/csrc/tensorrt/`中添加头文件`trt_roi_align.hpp`
+2. 在TensorRT源码目录`mmcv/ops/csrc/tensorrt/plugins/`中添加头文件`trt_roi_align.cpp`
+3. 在TensorRT源码目录`mmcv/ops/csrc/tensorrt/plugins/`中添加cuda kernel文件`trt_roi_align_kernel.cu`
+4. 在[trt_plugin.cpp](https://github.com/open-mmlab/mmcv/blob/master/mmcv/ops/csrc/tensorrt/plugins/trt_plugin.cpp)中注册`roi_align`插件
+    ```c++
+    #include "trt_plugin.hpp"
+    #include "trt_roi_align.hpp"
+    REGISTER_TENSORRT_PLUGIN(RoIAlignPluginDynamicCreator);
+    extern "C" {
+    bool initLibMMCVInferPlugins() { return true; }
+    }  // extern "C"
+    ```
+5. 在`tests/test_ops/test_tensorrt.py`中添加单元测试
+#### 注意
+- 部分MMCV中的自定义算子存在对应的cuda实现，在进行TensorRT插件开发的时候可以参考。
+### 已知问题
+- 无
+### 引用
+- [Developer guide of Nvidia TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/developer-guide/index.html)
+- [TensorRT Open Source Software](https://github.com/NVIDIA/TensorRT)
+- [onnx-tensorrt](https://github.com/onnx/onnx-tensorrt)
+- [TensorRT python API](https://docs.nvidia.com/deeplearning/tensorrt/api/python_api/index.html)
+- [TensorRT c++ plugin API](https://docs.nvidia.com/deeplearning/tensorrt/api/c_api/classnvinfer1_1_1_i_plugin.html)
--- a/docs_zh_CN/faq.md
+++ b/docs_zh_CN/faq.md
+## 常见问题
+在这里我们列出了用户经常遇到的问题以及对应的解决方法。如果您遇到了其他常见的问题，并且知道可以帮到大家的解决办法，
+欢迎随时丰富这个列表。
+- MMCV 和 MMDetection 的兼容性问题；"ConvWS is already registered in conv layer"
+    请按照上述说明为您的 MMDetection 版本安装正确版本的 MMCV。
+- "No module named 'mmcv.ops'"; "No module named 'mmcv._ext'"
+    1. 使用 `pip uninstall mmcv` 卸载您环境中的 mmcv
+    2. 按照上述说明安装 mmcv-full
+- "invalid device function" 或者 "no kernel image is available for execution"
+    1. 检查 GPU 的 CUDA 计算能力
+    2. 运行  `python mmdet/utils/collect_env.py` 来检查 PyTorch、torchvision 和 MMCV 是否是针对正确的 GPU 架构构建的
+        您可能需要去设置 `TORCH_CUDA_ARCH_LIST` 来重新安装 MMCV
+        兼容性问题的可能会出现在使用旧版的 GPUs，如：colab 上的 Tesla K80 (3.7)
+    3. 检查运行环境是否和 mmcv/mmdet 编译时的环境相同。例如，您可能使用 CUDA 10.0 编译 mmcv，但在 CUDA 9.0 的环境中运行它
+- "undefined symbol" 或者 "cannot open xxx.so"。
+    1. 如果符号和 CUDA/C++ 相关（例如：libcudart.so 或者 GLIBCXX），请检查 CUDA/GCC 运行时的版本是否和编译 mmcv 的一致
+    2. 如果符号和 PyTorch 相关（例如：符号包含 caffe、aten 和 TH），请检查 PyTorch 运行时的版本是否和编译 mmcv 的一致
+    3. 运行 `python mmdet/utils/collect_env.py` 以检查 PyTorch、torchvision 和 MMCV 构建和运行的环境是否相同
+- "RuntimeError: CUDA error: invalid configuration argument"。
+    这个错误可能是由于您的 GPU 性能不佳造成的。尝试降低[THREADS_PER_BLOCK](https://github.com/open-mmlab/mmcv/blob/cac22f8cf5a904477e3b5461b1cc36856c2793da/mmcv/ops/csrc/common_cuda_helper.hpp#L10)
+    的值并重新编译 mmcv。
+- "RuntimeError: nms is not compiled with GPU support"。
+    这个错误是由于您的 CUDA 环境没有正确安装。
+    您可以尝试重新安装您的 CUDA 环境，然后删除 mmcv/build 文件夹并重新编译 mmcv。
--- a/docs_zh_CN/get_started/build.md
+++ b/docs_zh_CN/get_started/build.md
+## 从源码编译 MMCV
+### 在 Linux 或者 macOS 上编译 MMCV
+克隆算法库
+```bash
+git clone https://github.com/open-mmlab/mmcv.git
+cd mmcv
+```
+你可以安装 lite 版本
+```bash
+pip install -e .
+```
+也可以安装 full 版本
+```bash
+MMCV_WITH_OPS=1 pip install -e .
+```
+如果是在 macOS 上编译，则需要在安装命令前添加一些环境变量
+```bash
+CC=clang CXX=clang++ CFLAGS='-stdlib=libc++'
+```
+例如
+```bash
+CC=clang CXX=clang++ CFLAGS='-stdlib=libc++' MMCV_WITH_OPS=1 pip install -e .
+```
+```{note}
+如果你打算使用 `opencv-python-headless` 而不是 `opencv-python`，例如在一个很小的容器环境或者没有图形用户界面的服务器中，你可以先安装 `opencv-python-headless`，这样在安装 mmcv 依赖的过程中会跳过 `opencv-python`
+```
+### 在 Windows 上编译 MMCV
+在 Windows 上编译 MMCV 比 Linux 复杂，本节将一步步介绍如何在 Windows 上编译 MMCV。
+#### 依赖项
+请首先安装以下的依赖项：
+- [Git](https://git-scm.com/download/win)：安装期间，请选择 **add git to Path**
+- [Visual Studio Community 2019](https://visualstudio.microsoft.com)：用于编译 C++ 和 CUDA 代码
+- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)：包管理工具
+- [CUDA 10.2](https://developer.nvidia.com/cuda-10.2-download-archive)：如果只需要 CPU 版本可以不安装 CUDA，安装CUDA时，可根据需要进行自定义安装。如果已经安装新版本的显卡驱动，建议取消驱动程序的安装
+```{note}
+您需要知道如何在 Windows 上设置变量环境，尤其是 "PATH" 的设置，以下安装过程都会用到。
+```
+#### 设置 Python 环境
+1. 从 Windows 菜单启动 Anaconda 命令行
+```{note}
+如 Miniconda 安装程序建议，不要使用原始的 `cmd.exe` 或是 `powershell.exe`。命令行有两个版本，一个基于 PowerShell，一个基于传统的 `cmd.exe`。请注意以下说明都是使用的基于 PowerShell
+```
+2. 创建一个新的 Conda 环境
+    ```shell
+    conda create --name mmcv python=3.7  # 经测试，3.6, 3.7, 3.8 也能通过
+    conda activate mmcv  # 确保做任何操作前先激活环境
+    ```
+3. 安装 PyTorch 时，可以根据需要安装支持 CUDA 或不支持 CUDA 的版本
+    ```shell
+    # CUDA version
+    conda install pytorch torchvision cudatoolkit=10.2 -c pytorch
+    # CPU version
+    conda install pytorch torchvision cpuonly -c pytorch
+    ```
+4. 准备 MMCV 源代码
+    ```shell
+    git clone https://github.com/open-mmlab/mmcv.git
+    cd mmcv
+    ```
+5. 安装所需 Python 依赖包
+    ```shell
+    pip3 install -r requirements.txt
+    ```
+#### 编译与安装 MMCV
+MMCV 有三种安装的模式：
+1. Lite 版本（不包含算子）
+    这种方式下，没有算子被编译，这种模式的 mmcv 是原生的 python 包
+2. Full 版本（只包含 CPU 算子）
+    编译 CPU 算子，但只有 x86 将会被编译，并且编译版本只能在 CPU only 情况下运行
+3. Full 版本（既包含 CPU 算子，又包含 CUDA 算子）
+    同时编译 CPU 和 CUDA 算子，`ops` 模块的 x86 与 CUDA 的代码都可以被编译。同时编译的版本可以在 CUDA 上调用 GPU
+##### 通用步骤
+1. 设置 MSVC 编译器
+    设置环境变量。添加 `C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Tools\MSVC\14.27.29110\bin\Hostx86\x64` 到 `PATH`，则 `cl.exe` 可以在命令行中运行，如下所示。
+    ```none
+    (base) PS C:\Users\xxx> cl
+    Microsoft (R) C/C++ Optimizing  Compiler Version 19.27.29111 for x64
+    Copyright (C) Microsoft Corporation.   All rights reserved.
+    usage: cl [ option... ] filename... [ / link linkoption... ]
+    ```
+    为了兼容性，我们使用 x86-hosted 以及 x64-targeted 版本，即路径中的 `Hostx86\x64` 。
+    因为 PyTorch 将解析 `cl.exe` 的输出以检查其版本，只有 utf-8 将会被识别，你可能需要将系统语言更改为英语。控制面板 -> 地区-> 管理-> 非 Unicode 来进行语言转换。
+##### 安装方式一：Lite version（不包含算子）
+在完成上述的公共步骤后，从菜单打开 Anaconda 命令框，输入以下命令
+```shell
+# 激活环境
+conda activate mmcv
+# 切换到 mmcv 根目录
+cd mmcv
+# 安装
+python setup.py develop
+# 检查是否安装成功
+pip list
+```
+##### 安装方式二：Full version（只编译 CPU 算子）
+1. 完成上述的公共步骤
+2. 设置环境变量
+    ```shell
+    $env:MMCV_WITH_OPS = 1
+    $env:MAX_JOBS = 8  # 根据你可用CPU以及内存量进行设置
+    ```
+3. 编译安装
+    ```shell
+    conda activate mmcv  # 激活环境
+    cd mmcv  # 改变路径
+    python setup.py build_ext  # 如果成功, cl 将被启动用于编译算子
+    python setup.py develop  # 安装
+    pip list  # 检查是否安装成功
+    ```
+##### 安装方式三：Full version（既编译 CPU 算子又编译 CUDA 算子）
+1. 完成上述的公共步骤
+2. 设置环境变量
+    ```shell
+    $env:MMCV_WITH_OPS = 1
+    $env:MAX_JOBS = 8  # 根据你可用CPU以及内存量进行设置
+    ```
+3.  检查 `CUDA_PATH` 或者 `CUDA_HOME` 环境变量已经存在在 `envs` 之中
+    ```none
+    (base) PS C:\Users\WRH> ls env:
+    Name                           Value
+    ----                           -----
+    CUDA_PATH                      C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v10.2
+    CUDA_PATH_V10_1                C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v10.1
+    CUDA_PATH_V10_2                C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v10.2
+    ```
+    如果没有，你可以按照下面的步骤设置
+    ```shell
+    $env:CUDA_HOME = "C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v10.2"
+    # 或者
+    $env:CUDA_HOME = $env:CUDA_PATH_V10_2  # CUDA_PATH_V10_2 已经在环境变量中
+    ```
+4. 设置 CUDA 的目标架构
+    ```shell
+    $env:TORCH_CUDA_ARCH_LIST="6.1" # 支持 GTX 1080
+    # 或者用所有支持的版本，但可能会变得很慢
+    $env:TORCH_CUDA_ARCH_LIST="3.5 3.7 5.0 5.2 6.0 6.1 7.0 7.5"
+    ```
+```{note}
+我们可以在 [here](https://developer.nvidia.com/cuda-gpus) 查看 GPU 的计算能力
+```
+5. 编译安装
+    ```shell
+    $env:MMCV_WITH_OPS = 1
+    $env:MAX_JOBS = 8 # 根据你可用CPU以及内存量进行设置
+    conda activate mmcv # 激活环境
+    cd mmcv  # 改变路径
+    python setup.py build_ext  # 如果成功, cl 将被启动用于编译算子
+    python setup.py develop # 安装
+    pip list # 检查是否安装成功
+    ```
+```{note}
+如果你的 PyTorch 版本是 1.6.0，你可能会遇到一些这个 [issue](https://github.com/pytorch/pytorch/issues/42467) 提到的错误，则可以参考这个 [pull request](https://github.com/pytorch/pytorch/pull/43380/files) 修改 本地环境的 PyTorch 源代码
+```
+如果编译安装 mmcv 的过程中遇到了问题，你也许可以在 [Frequently Asked Question](../faq.html) 找到解决方法
--- a/docs_zh_CN/get_started/installation.md
+++ b/docs_zh_CN/get_started/installation.md
+## 安装 MMCV
+MMCV 有两个版本：
+- **mmcv-full**: 完整版，包含所有的特性以及丰富的开箱即用的 CUDA 算子。注意完整版本可能需要更长时间来编译。
+- **mmcv**: 精简版，不包含 CUDA 算子但包含其余所有特性和功能，类似 MMCV 1.0 之前的版本。如果你不需要使用 CUDA 算子的话，精简版可以作为一个考虑选项。
+```{warning}
+请不要在同一个环境中安装两个版本，否则可能会遇到类似 `ModuleNotFound` 的错误。在安装一个版本之前，需要先卸载另一个。`如果CUDA可用，强烈推荐安装mmcv-full`。
+```
+a. 安装完整版
+在安装 mmcv-full 之前，请确保 PyTorch 已经成功安装在环境中，可以参考 PyTorch 官方[文档](https://pytorch.org/)。
+我们提供了不同 PyTorch 和 CUDA 版本的 mmcv-full 预编译包，可以大大简化用户安装编译过程。强烈推荐通过预编译包来安装。另外，安装完成后可以运行 [check_installation.py](https://github.com/open-mmlab/mmcv/.dev_scripts/check_installation.py) 脚本检查 mmcv-full 是否安装成功。
+i. 安装最新版本
+如下是安装最新版 ``mmcv-full`` 的命令
+```shell
+pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html
+```
+请将链接中的 ``{cu_version}`` 和 ``{torch_version}`` 根据自身需求替换成实际的版本号，例如想安装和 ``CUDA 11.1``、``PyTorch 1.9.0`` 兼容的最新版 ``mmcv-full``，使用如下替换过的命令
+```shell
+pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.9.0/index.html
+```
+```{note}
+PyTorch 在 1.x.0 和 1.x.1 之间通常是兼容的，故 mmcv-full 只提供 1.x.0 的编译包。如果你
+的 PyTorch 版本是 1.x.1，你可以放心地安装在 1.x.0 版本编译的 mmcv-full。例如，如果你的
+PyTorch 版本是 1.8.1、CUDA 版本是 11.1，你可以使用以下命令安装 mmcv-full。
+`pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.8.0/index.html`
+```
+如果想知道更多 CUDA 和 PyTorch 版本的命令，可以参考下面的表格，将链接中的 ``=={mmcv_version}`` 删去即可。
+ii. 安装特定的版本
+如下是安装特定版本 ``mmcv-full`` 的命令
+```shell
+pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html
+```
+首先请参考版本发布信息找到想要安装的版本号，将 ``{mmcv_version}`` 替换成该版本号，例如 ``1.3.9``。
+然后将链接中的 ``{cu_version}`` 和 ``{torch_version}`` 根据自身需求替换成实际的版本号，例如想安装和 ``CUDA 11.1``、``PyTorch 1.9.0`` 兼容的 ``mmcv-full`` 1.3.9 版本，使用如下替换过的命令
+```shell
+pip install mmcv-full==1.3.9 -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.9.0/index.html
+```
+对于更多的 PyTorch 和 CUDA 版本组合，请参考下表：
+<table class="docutils">
+  <tbody>
+    <tr>
+      <th width="80"> CUDA </th>
+      <th valign="bottom" align="left" style="min-width: 100px">torch 1.10</th>
+      <th valign="bottom" align="left" style="min-width: 100px">torch 1.9</th>
+      <th valign="bottom" align="left" style="min-width: 100px">torch 1.8</th>
+      <th valign="bottom" align="left" style="min-width: 100px">torch 1.7</th>
+      <th valign="bottom" align="left" style="min-width: 100px">torch 1.6</th>
+      <th valign="bottom" align="left" style="min-width: 100px">torch 1.5</th>
+    </tr>
+    <tr>
+      <td align="left">11.3</td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10.0/index.html</code></pre> </details> </td>
+      <td align="left"></td>
+      <td align="left"></code></pre> </details> </td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+    </tr>
+    <tr>
+      <td align="left">11.1</td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.10.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.9.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.8.0/index.html</code></pre> </details> </td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+    </tr>
+    <tr>
+      <td align="left">11.0</td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu110/torch1.7.0/index.html</code></pre> </details> </td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+    </tr>
+    <tr>
+      <td align="left">10.2</td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.10.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.9.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.7.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.6.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code>pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.5.0/index.html</code></pre> </details> </td>
+    </tr>
+    <tr>
+      <td align="left">10.1</td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.8.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.7.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.6.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.5.0/index.html</code></pre> </details> </td>
+    </tr>
+    <tr>
+      <td align="left">9.2</td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+      <td align="left"> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.7.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.6.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.5.0/index.html</code></pre> </details> </td>
+    </tr>
+    <tr>
+      <td align="left">cpu</td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.10.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.9.0/index.html</code></pre> </details> </td>
+       <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.8.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.7.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.6.0/index.html</code></pre> </details> </td>
+      <td align="left"><details><summary> 安装 </summary><pre><code> pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.5.0/index.html</code></pre> </details> </td>
+    </tr>
+  </tbody>
+</table>
+```{note}
+以上提供的预编译包并不囊括所有的 mmcv-full 版本，我们可以点击对应链接查看支持的版本。例如，点击 [cu102-torch1.8.0](https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html)，可以看到 `cu102-torch1.8.0` 只提供了 1.3.0 及以上的 mmcv-full 版本。另外，从 `mmcv v1.3.17` 开始，我们不再提供`PyTorch 1.3 & 1.4` 对应的 mmcv-full 预编译包。你可以在 [这](./docs_zh_CN/get_started/previous_versions.md) 找到 `PyTorch 1.3 & 1.4` 对应的预编包。虽然我们不再提供 `PyTorch 1.3 & 1.4` 对应的预编译包，但是我们依然在 CI 中保证对它们的兼容持续到下一年。
+```
+除了使用预编译包之外，另一种方式是在本地进行编译，直接运行下述命令
+```python
+pip install mmcv-full
+```
+但注意本地编译可能会耗时 10 分钟以上。
+b. 安装精简版
+```python
+pip install mmcv
+```
+c. 安装完整版并且编译 onnxruntime 的自定义算子
+- 详细的指南请查看 [这里](https://mmcv.readthedocs.io/zh_CN/latest/deployment/onnxruntime_custom_ops.html)。
+如果想从源码编译 MMCV，请参考[该文档](https://mmcv.readthedocs.io/zh_CN/latest/get_started/build.html)。
--- a/docs/zh_cn/get_started/introduction.md
+++ b/docs/zh_cn/get_started/introduction.md
 ## 介绍 MMCV
-MMCV 是一个面向计算机视觉的基础库，它提供了以下功能：
+MMCV 是一个面向计算机视觉的基础库，它支持了很多开源项目，例如：
- [图像和视频处理](../understand_mmcv/data_process.md)
- [图像和标注结果可视化](../understand_mmcv/visualization.md)
- [图像变换](../understand_mmcv/data_transform.md)
- [多种 CNN 网络结构](../understand_mmcv/cnn.md)
- [高质量实现的常见 CUDA 算子](../understand_mmcv/ops.md)
-MMCV 支持多种平台，包括：
- Linux
- Windows
- macOS
-它支持的 OpenMMLab 项目：
 - [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 目标检测平台
- [MMRotate](https://github.com/open-mmlab/mmrotate): OpenMMLab 旋转框检测工具箱与测试基准
- [MMYOLO](https://github.com/open-mmlab/mmyolo): OpenMMLab YOLO 系列工具箱与测试基准
 - [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab 语义分割工具箱
- [MMOCR](https://github.com/open-mmlab/mmocr): OpenMMLab 全流程文字检测识别理解工具箱
- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱
- [MMHuman3D](https://github.com/open-mmlab/mmhuman3d): OpenMMLab 人体参数化模型工具箱与测试基准
- [MMSelfSup](https://github.com/open-mmlab/mmselfsup): OpenMMLab 自监督学习工具箱与测试基准
- [MMRazor](https://github.com/open-mmlab/mmrazor): OpenMMLab 模型压缩工具箱与测试基准
- [MMFewShot](https://github.com/open-mmlab/mmfewshot): OpenMMLab 少样本学习工具箱与测试基准
 - [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab 新一代视频理解工具箱
 - [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab 一体化视频目标感知平台
- [MMFlow](https://github.com/open-mmlab/mmflow): 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 图片视频生成模型工具箱
- [MMDeploy](https://github.com/open-mmlab/mmdeploy): OpenMMLab 模型部署框架
+MMCV 提供了如下众多功能：
+- 通用的 IO 接口
+- 图像和视频处理
+- 图像和标注结果可视化
+- 常用小工具（进度条，计时器等）
+- 基于 PyTorch 的通用训练框架
+- 多种 CNN 网络结构
+- 高质量实现的常见 CUDA 算子
+如想了解更多特性和使用，请参考[文档](https://mmcv.readthedocs.io/zh_CN/latest)。
+```{note}
+MMCV 需要 Python 3.6 以上版本。
+```
--- a/docs/zh_cn/get_started/previous_versions.md
+++ b/docs/zh_cn/get_started/previous_versions.md
 ## 其他版本的 PyTorch
 我们不再提供在较低的 `PyTorch` 版本下编译的 `mmcv-full` 包，但为了您的方便，您可以在下面找到它们。
 ### PyTorch 1.4
-| 1.0.0 \<= mmcv_version \<= 1.2.1
+| 1.0.0 <= mmcv_version <= 1.2.1
 #### CUDA 10.1
@@ -26,7 +27,7 @@ pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dis
 ### PyTorch v1.3
-| 1.0.0 \<= mmcv_version \<= 1.3.16
+| 1.0.0 <= mmcv_version <= 1.3.16
 #### CUDA 10.1

--- a/docs/zh_cn/index.rst
+++ b/docs/zh_cn/index.rst
@@ -10,22 +10,30 @@
   get_started/introduction.md
   get_started/installation.md
   get_started/build.md
-   get_started/article.md
 .. toctree::
   :maxdepth: 2
   :caption: 深入理解 MMCV
+   understand_mmcv/config.md
+   understand_mmcv/registry.md
+   understand_mmcv/runner.md
+   understand_mmcv/io.md
   understand_mmcv/data_process.md
-   understand_mmcv/data_transform.md
   understand_mmcv/visualization.md
   understand_mmcv/cnn.md
   understand_mmcv/ops.md
+   understand_mmcv/utils.md
 .. toctree::
-   :caption: 语言切换
+   :maxdepth: 2
+   :caption: 部署
-   switch_language.md
+   deployment/onnx.md
+   deployment/onnxruntime_op.md
+   deployment/onnxruntime_custom_ops.md
+   deployment/tensorrt_plugin.md
+   deployment/tensorrt_custom_ops.md
 .. toctree::
   :maxdepth: 2
@@ -34,6 +42,8 @@
   compatibility.md
 .. toctree::
+   :maxdepth: 2
+   :caption: 常见问题
   faq.md
@@ -43,20 +53,12 @@
   community/contributing.md
   community/pr.md
-   community/code_style.md
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
   :caption: API 文档
-   mmcv.image <api/image>
+   api.rst
-   mmcv.video <api/video>
-   mmcv.visualization <api/visualization>
-   mmcv.cnn <api/cnn>
-   mmcv.ops <api/ops>
-   mmcv.transforms <api/transforms>
-   mmcv.arraymisc <api/arraymisc>
-   mmcv.utils <api/utils>
 Indices and tables

--- a/docs/zh_cn/make.bat
+++ b/docs/zh_cn/make.bat
--- a/docs/zh_cn/mmcv-logo.png
+++ b/docs/zh_cn/mmcv-logo.png