安装教程

在本节中，你将了解到：

• 安装教程
• 安装
  • 前提条件
  • 最佳实践
  • 自定义安装
  • CUDA版本
  • 不使用MIM安装MMCV
  • 在Docker中使用MMagic
  • 问题解决
  • 使用多个MMagic版本开发

安装

我们建议用户按照我们的最佳实践来安装MMagic。 然而，整个过程是高度可定制的。更多信息请参阅自定义安装部分。

前提条件

在本节中，我们将演示如何使用PyTorch准备环境。

MMagic可以在Linux, Windows, 和macOS上运行。它要求：

• Python >= 3.7
• PyTorch >= 1.8
• MMCV >= 2.0.0

如果您对PyTorch有经验并且已经安装了它，直接跳过这一部分，跳到下一节。否则, 您可以按照以下步骤来准备环境。

Step 0. 从官方网站下载和安装Miniconda.

Step 1. 创建一个conda虚拟环境并激活它

conda create --name mmagic python=3.8 -y
conda activate mmagic

Step 2. 按照官方说明安装PyTorch，例如

• 在GPU平台上：

conda install pytorch torchvision cudatoolkit=11.3 -c pytorch

• 在CPU平台上：

conda install pytorch=1.10 torchvision cpuonly -c pytorch

最佳实践

Step 0. 使用MIM安装MMCV。

pip install -U openmim
mim install 'mmcv>=2.0.0'

Step 1. 安装MMEngine。

mim install 'mmengine'

或者

pip install mmengine

或者

pip install git+https://github.com/open-mmlab/mmengine.git

Step 2. 安装MMagic。

mim install 'mmagic'

或者

pip install mmagic

或者从源代码安装MMagic。

git clone https://github.com/open-mmlab/mmagic.git
cd mmagic
pip3 install -e . -v

Step 5. 检查MMagic是否安装成功。

cd ~
python -c "import mmagic; print(mmagic.__version__)"
# 示例输出: 1.0.0

显示正确的版本号，则表示安装成功。

你可能想知道附加在`pip install`后面的`-e .`是什么意思。
下面是说明:

- `-e`表示[可编辑模式](https://pip.pypa.io/en/latest/cli/pip_install/#cmdoption-e).
  当`import mmagic`时，将导入克隆目录下的模块。
  如果`pip install`没有附加`-e`, pip会将克隆的代码复制到类似`lib/python/site-package`的地方。
  因此，除非再次执行`pip install`命令，否则在克隆目录下修改后的代码不会生效。
  因此，`pip install`命令附带`-e`对于开发人员来说特别方便。如果修改了一些代码，下次导入新的代码时不需要重新安装。
- `.`表示此目录中的代码。

你也可以使用`pip install -e .[all]`命令，这将安装更多的依赖项，特别是对于预提交hooks和单元测试。

自定义安装

CUDA版本

安装PyTorch时,您需要指定CUDA的版本。如果您不清楚该选择哪一个，请遵循我们的建议:

• 对于基于Ampere的NVIDIA GPUs，如GeForce 30系列和NVIDIA A100，必须使用CUDA 11。
• 对于较老的NVIDIA GPUs，是向后兼容的，但CUDA 10.2提供了更好的兼容性，更轻量。

请确保GPU驱动程序满足最低版本要求。 更多信息请参见此表。

注意 如果遵循我们的最佳实践，安装CUDA runtime库就足够了，因为不会在本地编译CUDA代码。 但是，如果您希望从源代码编译MMCV或开发其他CUDA算子，则需要从NVIDIA的开发者网站安装完整的CUDA工具包，其版本应与PyTorch的CUDA版本匹配。即，在 conda install 命令中指定的cudatoolkit版本。

不使用MIM安装MMCV

MMCV包含c++和CUDA扩展，因此以一种复杂的方式依赖于PyTorch。MIM自动解决了这种依赖关系，并使安装更容易。然而，这并不是必须的。

要使用pip而不是MIM安装MMCV，请遵循MMCV安装指南。这需要根据PyTorch版本及其CUDA版本手动指定find-url。

例如，以下命令install mmcv-full是针对PyTorch 1.10.x和CUDA 11.3构建的。

pip install 'mmcv>=2.0.0' -f https://download.openmmlab.com/mmcv/dist/cu113/torch1.10/index.html

在Docker中使用MMagic

我们提供一个Dockerfile来构建一个镜像。请确保您的docker版本>=19.03。

# 使用PyTorch 1.8, CUDA 11.1构建一个镜像
# 如果您喜欢其他版本，只需修改Dockerfile
docker build -t mmagic docker/

使用如下命令运行

docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmagic/data mmagic

问题解决

如果在安装过程中遇到问题，请先查看FAQ页面。如果找不到解决方案，可以在GitHub上open an issue。

使用多个MMagic版本开发

训练和测试脚本已经修改了PYTHONPATH，以确保脚本使用当前目录中的MMagic。

要使用环境中安装的默认MMagic，而不是您正在使用的MMagic，可以删除这些脚本中的以下行

PYTHONPATH="$(dirname $0)/..":$PYTHONPATH

---

最后更新: November 27, 2023
创建日期: November 27, 2023