本文档提供了安装 MMPose 的相关步骤。
- Linux | Windows | macOS
- Python 3.6+
- PyTorch 1.5+
- CUDA 9.2+ (如果从源码编译 PyTorch,则可以兼容 CUDA 9.0 版本)
- GCC 5+
- mmcv 请安装最新版本的 mmcv-full
- Numpy
- cv2
- json_tricks
- xtcocotools
可选项:
a. 创建并激活 conda 虚拟环境,如:
conda create -n open-mmlab python=3.7 -y
conda activate open-mmlab
b. 参考 官方文档 安装 PyTorch 和 torchvision ,如:
conda install pytorch torchvision -c pytorch
注:确保 CUDA 的编译版本和 CUDA 的运行版本相匹配。 用户可以参照 PyTorch 官网 对预编译包所支持的 CUDA 版本进行核对。
例 1
:如果用户的 /usr/local/cuda
文件夹下已安装 CUDA 10.2 版本,并且想要安装 PyTorch 1.8.0 版本,
则需要安装 CUDA 10.2 下预编译的 PyTorch。
conda install pytorch==1.8.0 torchvision==0.9.0 cudatoolkit=10.2 -c pytorch
例 2
:如果用户的 /usr/local/cuda
文件夹下已安装 CUDA 9.2 版本,并且想要安装 PyTorch 1.7.0 版本,
则需要安装 CUDA 9.2 下预编译的 PyTorch。
conda install pytorch==1.7.0 torchvision==0.8.0 cudatoolkit=9.2 -c pytorch
如果 PyTorch 是由源码进行编译安装(而非直接下载预编译好的安装包),则可以使用更多的 CUDA 版本(如 9.0 版本)。
a. 安装最新版本的 mmcv-full。MMPose 推荐用户使用如下的命令安装预编译好的 mmcv。
# pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.9.0/index.html
# 我们可以忽略 PyTorch 的小版本号
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.9/index.html
PyTorch 在 1.x.0 和 1.x.1 之间通常是兼容的,故 mmcv-full 只提供 1.x.0 的编译包。如果你的 PyTorch 版本是 1.x.1,你可以放心地安装在 1.x.0 版本编译的 mmcv-full。
可查阅 这里 以参考不同版本的 MMCV 所兼容的 PyTorch 和 CUDA 版本。
另外,用户也可以通过使用以下命令从源码进行编译:
git clone https://github.com/open-mmlab/mmcv.git
cd mmcv
MMCV_WITH_OPS=1 pip install -e . # mmcv-full 包含一些 cuda 算子,执行该步骤会安装 mmcv-full(而非 mmcv)
# 或者使用 pip install -e . # 这个命令安装的 mmcv 将不包含 cuda ops,通常适配 CPU(无 GPU)环境
cd ..
注意:如果之前安装过 mmcv,那么需要先使用 pip uninstall mmcv
命令进行卸载。如果 mmcv 和 mmcv-full 同时被安装, 会报 ModuleNotFoundError
的错误。
b. 克隆 MMPose 库。
git clone https://github.com/open-mmlab/mmpose.git
cd mmpose
c. 安装依赖包和 MMPose。
pip install -r requirements.txt
pip install -v -e . # or "python setup.py develop"
如果是在 macOS 环境安装 MMPose,则需使用如下命令:
CC=clang CXX=clang++ CFLAGS='-stdlib=libc++' pip install -e .
d. 安装其他可选依赖。
如果用户不需要做相关任务,这部分步骤可以选择跳过。
可选项:
注意:
-
在步骤 c 中,git commit 的 id 将会被写到版本号中,如 0.6.0+2e7045c。这个版本号也会被保存到训练好的模型中。 这里推荐用户每次在步骤 b 中对本地代码和 github 上的源码进行同步。如果 C++/CUDA 代码被修改,就必须进行这一步骤。
-
根据上述步骤,MMPose 就会以
dev
模式被安装,任何本地的代码修改都会立刻生效,不需要再重新安装一遍(除非用户提交了 commits,并且想更新版本号)。 -
如果用户想使用
opencv-python-headless
而不是opencv-python
,可再安装 MMCV 前安装opencv-python-headless
。 -
如果 mmcv 已经被安装,用户需要使用
pip uninstall mmcv
命令进行卸载。如果 mmcv 和 mmcv-full 同时被安装, 会报ModuleNotFoundError
的错误。 -
一些依赖包是可选的。运行
python setup.py develop
将只会安装运行代码所需的最小要求依赖包。 要想使用一些可选的依赖包,如smplx
,用户需要通过pip install -r requirements/optional.txt
进行安装, 或者通过调用pip
(如pip install -v -e .[optional]
,这里的[optional]
可替换为all
,tests
,build
或optional
) 指定安装对应的依赖包,如pip install -v -e .[tests,build]
。
MMPose 可以在只有 CPU 的环境下安装(即无法使用 GPU 的环境)。
在 CPU 模式下,用户可以运行 demo/demo.py
的代码。
这里提供了 conda 下安装 MMPose 并链接 COCO 数据集路径的完整脚本(假设 COCO 数据的路径在 $COCO_ROOT)。
conda create -n open-mmlab python=3.7 -y
conda activate open-mmlab
# 安装最新的,使用默认版本的 CUDA 版本(一般为最新版本)预编译的 PyTorch 包
conda install -c pytorch pytorch torchvision -y
# 安装 mmcv-full。其中,命令里 url 的 ``{cu_version}`` 和 ``{torch_version}`` 变量需由用户进行指定。
# 可查阅 [这里](https://github.com/open-mmlab/mmcv#installation) 以参考不同版本的 MMCV 所兼容的 PyTorch 和 CUDA 版本。
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html
# 安装 mmpose
git clone [email protected]:open-mmlab/mmpose.git
cd mmpose
pip install -r requirements.txt
python setup.py develop
mkdir data
ln -s $COCO_ROOT data/coco
MMPose 提供一个 Dockerfile 用户创建 docker 镜像。
# 创建拥有 PyTorch 1.6.0, CUDA 10.1, CUDNN 7 配置的 docker 镜像.
docker build -f ./docker/Dockerfile --rm -t mmpose .
注意:用户需要确保已经安装了 nvidia-container-toolkit。
运行以下命令:
docker run --gpus all\
--shm-size=8g \
-it -v {DATA_DIR}:/mmpose/data mmpose
MMPose 的训练和测试脚本已经修改了 PYTHONPATH
变量,以确保其能够运行当前目录下的 MMPose。
如果想要运行环境下默认的 MMPose,用户需要在训练和测试脚本中去除这一行:
PYTHONPATH="$(dirname $0)/..":$PYTHONPATH