158 lines
5.9 KiB
Markdown
158 lines
5.9 KiB
Markdown
## 依赖
|
||
|
||
- Linux (Windows 目前尚不支持)
|
||
- Python 3.7+
|
||
- PyTorch 1.5+
|
||
- CUDA 9.2+
|
||
- GCC 5+
|
||
- [mmcv](https://mmcv.readthedocs.io/en/latest/#installation) 1.3.12+
|
||
- [mmdet](https://mmdetection.readthedocs.io/en/latest/#installation) 2.16.0+
|
||
- [mmcls](https://mmclassification.readthedocs.io/en/latest/#installation) 0.15.0+
|
||
|
||
|
||
MMFewShot 和 MMCV, MMCls, MMDet 版本兼容性如下所示，需要安装正确的版本以避免安装出现问题。
|
||
|
||
| MMFewShot 版本 | MMCV 版本 | MMClassification 版本 | MMDetection 版本 |
|
||
|:-------------------:|:-----------------:|:---------------------------------:|:----------------------------:|
|
||
| master | mmcv-full>=1.3.12 | mmdet >= 2.16.0 | mmcls >=0.15.0 |
|
||
|
||
**注意：**如果已经安装了 mmcv，首先需要使用 `pip uninstall mmcv` 卸载已安装的 mmcv，如果同时安装了 mmcv 和 mmcv-full，将会报 `ModuleNotFoundError` 错误。
|
||
|
||
## 安装流程
|
||
|
||
### 准备环境
|
||
|
||
1. 使用 conda 新建虚拟环境，并进入该虚拟环境；
|
||
|
||
```shell
|
||
conda create -n openmmlab python=3.7 -y
|
||
conda activate openmmlab
|
||
```
|
||
|
||
2. 基于 [PyTorch 官网](https://pytorch.org/)安装 PyTorch 和 torchvision，例如：
|
||
|
||
```shell
|
||
conda install pytorch torchvision -c pytorch
|
||
```
|
||
|
||
**注意**：需要确保 CUDA 的编译版本和运行版本匹配。可以在 [PyTorch 官网](https://pytorch.org/)查看预编译包所支持的 CUDA 版本。
|
||
|
||
`例 1` 例如在 `/usr/local/cuda` 下安装了 CUDA 10.1， 并想安装 PyTorch 1.7，则需要安装支持 CUDA 10.1 的预构建 PyTorch：
|
||
|
||
```shell
|
||
conda install pytorch==1.7.0 torchvision==0.8.0 torchaudio==0.7.0 cudatoolkit=10.1 -c pytorch
|
||
```
|
||
|
||
|
||
### 安装 MMFewShot
|
||
|
||
我们建议使用 [MIM](https://github.com/open-mmlab/mim) 来安装 MMFewShot：
|
||
|
||
``` shell
|
||
pip install openmim
|
||
mim install mmfewshot
|
||
```
|
||
MIM 能够自动地安装 OpenMMLab 的项目以及对应的依赖包。
|
||
|
||
|
||
或者，可以手动安装 MMFewShot：
|
||
|
||
1. 安装 mmcv-full，我们建议使用预构建包来安装：
|
||
|
||
```shell
|
||
# 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.10.0/index.html
|
||
```
|
||
|
||
PyTorch 在 1.x.0 和 1.x.1 之间通常是兼容的，故 mmcv-full 只提供 1.x.0 的编译包。如果你的 PyTorch 版本是 1.x.1，你可以放心地安装在 1.x.0 版本编译的 mmcv-full。
|
||
|
||
```
|
||
# 我们可以忽略 PyTorch 的小版本号
|
||
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu102/torch1.10/index.html
|
||
```
|
||
|
||
请参阅 [MMCV](https://github.com/open-mmlab/mmcv#install-with-pip) 了解不同版本的 MMCV 与不同版本的 PyTorch 和 CUDA 的兼容情况。同时，您可以使用以下命令从源码编译 MMCV：
|
||
|
||
2. 安装 MMClassification 和 MMDetection.
|
||
|
||
你可以直接通过如下命令从 pip 安装使用 mmclassification 和 mmdetection：
|
||
|
||
```shell
|
||
pip install mmcls mmdet
|
||
```
|
||
|
||
3. 安装 MMFewShot.
|
||
|
||
你可以直接通过如下命令从 pip 安装使用 mmfewshot：
|
||
|
||
```shell
|
||
pip install mmfewshot
|
||
```
|
||
|
||
或者从 git 仓库编译源码：
|
||
|
||
```shell
|
||
git clone https://github.com/open-mmlab/mmfewshot.git
|
||
cd mmfewshot
|
||
pip install -r requirements/build.txt
|
||
pip install -v -e . # or "python setup.py develop"
|
||
|
||
**Note:**
|
||
|
||
(1) 按照上述说明，MMDetection 安装在 `dev` 模式下，因此在本地对代码做的任何修改都会生效，无需重新安装；
|
||
|
||
(2) 如果希望使用 `opencv-python-headless` 而不是 `opencv-python`， 可以在安装 MMCV 之前安装；
|
||
|
||
(3) 一些安装依赖是可以选择的。例如只需要安装最低运行要求的版本，则可以使用 `pip install -v -e .` 命令。如果希望使用可选择的像 `albumentations` 和 `imagecorruptions` 这种依赖项，可以使用 `pip install -r requirements/optional.txt ` 进行手动安装，或者在使用 `pip` 时指定所需的附加功能（例如 `pip install -v -e .[optional]`），支持附加功能的有效键值包括 `all`、`tests`、`build` 以及 `optional` 。
|
||
|
||
|
||
### 另一种选择： Docker 镜像
|
||
|
||
我们提供了 [Dockerfile](https://github.com/open-mmlab/mmfewshot/blob/master/docker/Dockerfile) to build an image. Ensure that you are using [docker version](https://docs.docker.com/engine/install/) >=19.03.
|
||
|
||
```shell
|
||
# 基于 PyTorch 1.6, CUDA 10.1 生成镜像
|
||
docker build -t mmfewshot docker/
|
||
```
|
||
|
||
运行命令：
|
||
|
||
```shell
|
||
docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmfewshot/data mmfewshot
|
||
```
|
||
|
||
### 从零开始设置脚本
|
||
|
||
假设当前已经成功安装 CUDA 10.1，这里提供了一个完整的基于 conda 安装 MMDetection 的脚本：
|
||
|
||
```shell
|
||
conda create -n openmmlab python=3.7 -y
|
||
conda activate openmmlab
|
||
|
||
conda install pytorch==1.7.0 torchvision==0.8.0 torchaudio==0.7.0 cudatoolkit=10.1 -c pytorch
|
||
|
||
# 安装最新版本的 mmcv
|
||
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu101/torch1.7.0/index.html
|
||
|
||
# 安装 mmclassification mmdetection
|
||
pip install mmcls mmdet
|
||
|
||
# 安装 mmfewshot
|
||
git clone https://github.com/open-mmlab/mmfewshot.git
|
||
cd mmfewshot
|
||
pip install -r requirements/build.txt
|
||
pip install -v -e . # or "python setup.py develop"
|
||
```
|
||
|
||
|
||
## 验证
|
||
|
||
为了验证是否正确安装了 MMFewShot 和所需的环境，我们可以运行示例的 Python 代码在示例图像进行推理：
|
||
|
||
具体的细节可以参考 [few shot classification demo](https://github.com/open-mmlab/mmfewshot/tree/main/demo#few-shot-classification-demo)
|
||
以及 [few shot detection demo](https://github.com/open-mmlab/mmfewshot/tree/main/demo#few-shot-detection-demo) 。
|
||
如果成功安装 MMFewShot，则上面的代码可以完整地运行。
|
||
|
||
## 准备数据集
|
||
具体的细节可以参考 [准备数据](https://github.com/open-mmlab/mmfewshot/tree/main/tools/data) 下载并组织数据集。
|