mmdetection 安装
论文
- 《MMDetection: Open MMLab Detection Toolbox and Benchmark》
- https://arxiv.org/abs/1906.07155
安装
如果你装了 cuda10.1, 可以使用下列命令安装
1 |
|
验证
写入如下代码,验证单张照片是否能够跑通:
1 |
|
注意点
- conda 安装时,会先检查 base 环境有没有安装相应的 python 包,所以需要保证 base 未安装相应的 python 包
- conda install 安装不成功时,可以使用 pip install 安装,安装位置一样,只是安装来源不一样,
- conda install 和 pip install 安装的包名可能不一样
- 如 conda 安装 cv2 需要安装 opencv3, 并且满足 python <= 3.6
- 如 pip 安装 cv2 需要安装 opencv-python, python 版本不要求
github
- https://github.com/open-mmlab/mmdetection
- 安装地址:https://github.com/open-mmlab/mmdetection/blob/master/docs/get_started.md
以下为 github 原文
Prerequisites
- Linux or macOS (Windows is in experimental support)
- Python 3.6+
- PyTorch 1.3+
- CUDA 9.2+ (If you build PyTorch from source, CUDA 9.0 is also compatible)
- GCC 5+
- MMCV
Compatible MMDetection and MMCV versions are shown as below. Please install the correct version of MMCV to avoid installation issues.
MMDetection version | MMCV version |
---|---|
master | mmcv-full>=1.3.8, <1.4.0 |
2.17.0 | mmcv-full>=1.3.8, <1.4.0 |
2.16.0 | mmcv-full>=1.3.8, <1.4.0 |
2.15.1 | mmcv-full>=1.3.8, <1.4.0 |
2.15.0 | mmcv-full>=1.3.8, <1.4.0 |
2.14.0 | mmcv-full>=1.3.8, <1.4.0 |
2.13.0 | mmcv-full>=1.3.3, <1.4.0 |
2.12.0 | mmcv-full>=1.3.3, <1.4.0 |
2.11.0 | mmcv-full>=1.2.4, <1.4.0 |
2.10.0 | mmcv-full>=1.2.4, <1.4.0 |
2.9.0 | mmcv-full>=1.2.4, <1.4.0 |
2.8.0 | mmcv-full>=1.2.4, <1.4.0 |
2.7.0 | mmcv-full>=1.1.5, <1.4.0 |
2.6.0 | mmcv-full>=1.1.5, <1.4.0 |
2.5.0 | mmcv-full>=1.1.5, <1.4.0 |
2.4.0 | mmcv-full>=1.1.1, <1.4.0 |
2.3.0 | mmcv-full==1.0.5 |
2.3.0rc0 | mmcv-full>=1.0.2 |
2.2.1 | mmcv==0.6.2 |
2.2.0 | mmcv==0.6.2 |
2.1.0 | mmcv>=0.5.9, <=0.6.1 |
2.0.0 | mmcv>=0.5.1, <=0.5.8 |
Note: You need to run pip uninstall mmcv
first if you have mmcv installed.
If mmcv and mmcv-full are both installed, there will be ModuleNotFoundError
.
Installation
Prepare environment
Create a conda virtual environment and activate it.
1
2conda create -n openmmlab python=3.7 -y
conda activate openmmlabInstall PyTorch and torchvision following the official instructions, e.g.,
1
conda install pytorch torchvision -c pytorch
Note: Make sure that your compilation CUDA version and runtime CUDA version match.
You can check the supported CUDA version for precompiled packages on the PyTorch website.E.g.1
If you have CUDA 10.1 installed under/usr/local/cuda
and would like to install
PyTorch 1.5, you need to install the prebuilt PyTorch with CUDA 10.1.1
conda install pytorch cudatoolkit=10.1 torchvision -c pytorch
E.g. 2
If you have CUDA 9.2 installed under/usr/local/cuda
and would like to install
PyTorch 1.3.1., you need to install the prebuilt PyTorch with CUDA 9.2.1
conda install pytorch=1.3.1 cudatoolkit=9.2 torchvision=0.4.2 -c pytorch
If you build PyTorch from source instead of installing the prebuilt package,
you can use more CUDA versions such as 9.0.
Install MMDetection
It is recommended to install MMDetection with MIM,
which automatically handle the dependencies of OpenMMLab projects, including mmcv and other python packages.
1 |
|
Or you can still install MMDetection manually:
Install mmcv-full.
1
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/{cu_version}/{torch_version}/index.html
Please replace
{cu_version}
and{torch_version}
in the url to your desired one. For example, to install the latestmmcv-full
withCUDA 11.0
andPyTorch 1.7.0
, use the following command:1
pip install mmcv-full -f https://download.openmmlab.com/mmcv/dist/cu110/torch1.7.0/index.html
See here for different versions of MMCV compatible to different PyTorch and CUDA versions.
Optionally you can compile mmcv from source if you need to develop both mmcv and mmdet. Refer to the guide for details.
Install MMDetection.
You can simply install mmdetection with the following command:
1
pip install mmdet
or clone the repository and then install it:
1
2
3
4git clone https://github.com/open-mmlab/mmdetection.git
cd mmdetection
pip install -r requirements/build.txt
pip install -v -e . # or "python setup.py develop"Install extra dependencies for Instaboost, Panoptic Segmentation, LVIS dataset, or Albumentations.
1
2
3
4
5
6
7
8# for instaboost
pip install instaboostfast
# for panoptic segmentation
pip install git+https://github.com/cocodataset/panopticapi.git
# for LVIS dataset
pip install git+https://github.com/lvis-dataset/lvis-api.git
# for albumentations
pip install albumentations>=0.3.2 --no-binary imgaug,albumentations
Note:
a. When specifying -e
or develop
, MMDetection is installed on dev mode
, any local modifications made to the code will take effect without reinstallation.
b. If you would like to use opencv-python-headless
instead of opencv-python
,
you can install it before installing MMCV.
c. Some dependencies are optional. Simply running pip install -v -e .
will
only install the minimum runtime requirements. To use optional dependencies like albumentations
and imagecorruptions
either install them manually with pip install -r requirements/optional.txt
or specify desired extras when calling pip
(e.g. pip install -v -e .[optional]
). Valid keys for the extras field are: all
, tests
, build
, and optional
.
d. If you would like to use albumentations
, we suggest usingpip install albumentations>=0.3.2 --no-binary imgaug,albumentations
. If you simply usepip install albumentations>=0.3.2
, it will install opencv-python-headless
simultaneously (even though you have already installed opencv-python
). We should not allow opencv-python
and opencv-python-headless
installed at the same time, because it might cause unexpected issues. Please refer to official documentation for more details.
Install without GPU support
MMDetection can be built for CPU only environment (where CUDA isn’t available).
In CPU mode you can run the demo/webcam_demo.py for example.
However some functionality is gone in this mode:
- Deformable Convolution
- Modulated Deformable Convolution
- ROI pooling
- Deformable ROI pooling
- CARAFE: Content-Aware ReAssembly of FEatures
- SyncBatchNorm
- CrissCrossAttention: Criss-Cross Attention
- MaskedConv2d
- Temporal Interlace Shift
- nms_cuda
- sigmoid_focal_loss_cuda
- bbox_overlaps
If you try to run inference with a model containing above ops, an error will be raised.
The following table lists affected algorithms.
Operator | Model |
---|---|
Deformable Convolution/Modulated Deformable Convolution | DCN、Guided Anchoring、RepPoints、CentripetalNet、VFNet、CascadeRPN、NAS-FCOS、DetectoRS |
MaskedConv2d | Guided Anchoring |
CARAFE | CARAFE |
SyncBatchNorm | ResNeSt |
Notice: MMDetection does not support training with CPU for now.
Another option: Docker Image
We provide a Dockerfile to build an image. Ensure that you are using docker version >=19.03.
1 |
|
Run it with
1 |
|
A from-scratch setup script
Assuming that you already have CUDA 10.1 installed, here is a full script for setting up MMDetection with conda.
1 |
|
Developing with multiple MMDetection versions
The train and test scripts already modify the PYTHONPATH
to ensure the script use the MMDetection in the current directory.
To use the default MMDetection installed in the environment rather than that you are working with, you can remove the following line in those scripts
1 |
|
Verification
To verify whether MMDetection is installed correctly, we can run the following sample code to initialize a detector and inference a demo image.
1 |
|
The above code is supposed to run successfully upon you finish the installation.