Skip to content

Latest commit

 

History

History
179 lines (138 loc) · 10.9 KB

README_zh-CN.md

File metadata and controls

179 lines (138 loc) · 10.9 KB

PyPI badge codecov license

English | 简体中文

简介

MMCV 是一个面向计算机视觉的基础库,它支持了很多开源项目,例如:

MMCV 提供了如下众多功能:

  • 通用的 IO 接口
  • 图像和视频处理
  • 图像和标注结果可视化
  • 常用小工具(进度条,计时器等)
  • 基于 PyTorch 的通用训练框架
  • 多种 CNN 网络结构
  • 高质量实现的常见 CUDA 算子

如想了解更多特性和使用,请参考文档

提示: MMCV 需要 Python 3.6 以上版本。

安装

MMCV 有两个版本:

  • mmcv: 精简版,不包含 CUDA 算子但包含其余所有特性和功能,类似 MMCV 1.0 之前的版本。如果你不需要使用 CUDA 算子的话,精简版可以作为一个考虑选项。
  • mmcv-full: 完整版,包含所有的特性以及丰富的开箱即用的 CUDA 算子。注意完整版本可能需要更长时间来编译。

注意: 请不要在同一个环境中安装两个版本,否则可能会遇到类似 ModuleNotFound 的错误。在安装一个版本之前,需要先卸载另一个。

a. 安装精简版

pip install mmcv

b. 安装完整版

在安装 mmcv-full 之前,请确保 PyTorch 已经成功安装在环境中,可以参考 PyTorch 官方文档

我们提供了不同 PyTorch 和 CUDA 版本的 mmcv-full 预编译包,可以大大简化用户安装编译过程。强烈推荐通过预编译包来安装。

i. 安装最新版本

如下是安装最新版 mmcv-full 的命令

pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html

请将链接中的 {cu_version}{torch_version} 根据自身需求替换成实际的版本号,例如想安装和 CUDA 11PyTorch 1.7.0 兼容的最新版 mmcv-full,使用如下替换过的命令

pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu110/torch1.7.0/index.html

如果想知道更多 CUDA 和 PyTorch 版本的命令,可以参考下面的表格,将链接中的 =={mmcv_version} 删去即可。

ii. 安装特定的版本

如下是安装特定版本 mmcv-full 的命令

pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html

首先请参考版本发布信息找到想要安装的版本号,将 {mmcv_version} 替换成该版本号,例如 1.2.2。 然后将链接中的 {cu_version}{torch_version} 根据自身需求替换成实际的版本号,例如想安装和 CUDA 11PyTorch 1.7.0 兼容的 mmcv-full 1.2.2 版本,使用如下替换过的命令

pip install mmcv-full==1.2.2 -f https://download.openmmlab.com/mmcv/dist/cu110/torch1.7.0/index.html

对于更多的 PyTorch 和 CUDA 版本组合,请参考下表:

CUDA torch 1.8 torch 1.7 torch 1.6 torch 1.5 torch 1.4 torch 1.3
11.1
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu111/torch1.8.0/index.html
11.0
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu110/torch1.7.0/index.html
10.2
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.8.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.7.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.6.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.5.0/index.html
10.1
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.8.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.7.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.6.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.5.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.4.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.3.0/index.html
9.2
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.7.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.6.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.5.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.4.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cu92/torch1.3.0/index.html
cpu
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.8.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.7.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.6.0/index.html
安装
 pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.5.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.4.0/index.html
安装
pip install mmcv-full=={mmcv_version} -f https://download.openmmlab.com/mmcv/dist/cpu/torch1.3.0/index.html

除了使用预编译包之外,另一种方式是在本地进行编译,直接运行下述命令

pip install mmcv-full

但注意本地编译可能会耗时 10 分钟以上。

c. 安装完整版并且编译 onnxruntime 的自定义算子

  • 详细的指南请查看 这里

如果想从源码编译 MMCV,请参考该文档

FAQ

如果你遇到了安装问题,CUDA 相关的问题或者 RuntimeErrors,可以首先参考问题解决页面 看是否已经有解决方案。

贡献指南

我们感谢所有的贡献者为改进和提升 MMCV 所作出的努力。请参考贡献指南来了解参与项目贡献的相关指引。