GET STARTED¶
Prerequisites¶
In this section, we demonstrate how to prepare an environment with PyTorch.
MMSegmentation works on Linux, Windows, and macOS. It requires Python 3.10+, CUDA 11.8+, and PyTorch 2.0+.
Note
If you are experienced with PyTorch and have already installed it, just skip this part and jump to the next section. Otherwise, you can follow these steps for the preparation.
Step 0. Download and install Miniconda from the official website.
Step 1. Create a conda environment and activate it.
conda create --name onedllab python=3.10 -y
conda activate onedllab
Step 2. Install PyTorch following official instructions. Make sure to install a version that is supported in the released mmwheels, e.g.
On GPU platforms:
pip install torch==2.8.0 torchvision==0.23.0 --index-url https://download.pytorch.org/whl/cu129
On CPU platforms:
pip install torch==2.8.0 torchvision==0.23.0 --index-url https://download.pytorch.org/whl/cpu
Installation¶
We recommend that users follow our best practices to install MMSegmentation. However, the whole process is highly customizable. See Customize Installation section for more information.
Best Practices¶
Step 0. Install MMEngine and MMCV using MIM.
pip install onedl-mim
mim install onedl-mmengine
mim install onedl-mmcv
Step 1. Install MMSegmentation.
Case a: If you develop and run onedl-mmsegmentation directly, install it from source:
git clone https://github.com/vbti-development/onedl-mmsegmentation.git
cd onedl-mmsegmentation
pip install -v -e .
# "-v" means verbose, or more output
# "-e" means installing a project in editable mode,
# thus any local modifications made to the code will take effect without reinstallation.
# if you want all optional dependencies, use:
# pip install -v -e ".[optional]"
Case b: If you use onedl-mmsegmentation as a dependency or third-party package, install it with MIM:
mim install onedl-mmsegmentation
# if you want all optional dependencies, use:
# mim install onedl-mmsegmentation[optional]
Verify the installation¶
To verify whether MMSegmentation is installed correctly, we provide some sample codes to run an inference demo.
Step 1. We need to download config and checkpoint files.
mim download onedl-mmsegmentation --config rtmdet_tiny_8xb32-300e_coco --dest .
The downloading will take several seconds or more, depending on your network environment. When it is done, you will find two files pspnet_r50-d8_4xb2-40k_cityscapes-512x1024.py and pspnet_r50-d8_512x1024_40k_cityscapes_20200605_003338-2966598c.pth in your current folder.
Step 2. Verify the inference demo.
Case a: If you install MMSegmentation from source, just run the following command.
python demo/image_demo.py demo/demo.png configs/pspnet/pspnet_r50-d8_4xb2-40k_cityscapes-512x1024.py pspnet_r50-d8_512x1024_40k_cityscapes_20200605_003338-2966598c.pth --device cuda:0 --out-file result.jpg
You will see a new image result.jpg on your current folder, where segmentation masks are covered on all objects.
Case b: If you install MMSegmentation with MIM, open your python interpreter and copy&paste the following codes.
from mmseg.apis import inference_model, init_model, show_result_pyplot
import mmcv
config_file = 'pspnet_r50-d8_4xb2-40k_cityscapes-512x1024.py'
checkpoint_file = 'pspnet_r50-d8_512x1024_40k_cityscapes_20200605_003338-2966598c.pth'
# build the model from a config file and a checkpoint file
model = init_model(config_file, checkpoint_file, device='cuda:0')
# test a single image and show the results
img = 'demo/demo.png' # or img = mmcv.imread(img), which will only load it once
result = inference_model(model, img)
# visualize the results in a new window
show_result_pyplot(model, img, result, show=True)
# or save the visualization results to image files
# you can change the opacity of the painted segmentation map in (0, 1].
show_result_pyplot(model, img, result, show=True, out_file='result.jpg', opacity=0.5)
# test a video and show the results
video = mmcv.VideoReader('video.mp4')
for frame in video:
result = inference_model(model, frame)
show_result_pyplot(model, frame, result, wait_time=1)
You can modify the code above to test a single image or a video, both of these options can verify that the installation was successful.
Customize Installation¶
CUDA versions¶
When installing PyTorch, you need to specify the version of CUDA. If you are not clear on which to choose, follow our recommendations:
For Ampere-based NVIDIA GPUs, such as GeForce 30 series and NVIDIA A100, CUDA 11 is a must.
For older NVIDIA GPUs, CUDA 11 is backward compatible, but CUDA 10.2 offers better compatibility and is more lightweight.
Please make sure the GPU driver satisfies the minimum version requirements. See this table for more information.
Note
Installing CUDA runtime libraries is enough if you follow our best practices, because no CUDA code will be compiled locally. However, if you hope to compile MMCV from source or develop other CUDA operators, you need to install the complete CUDA toolkit from NVIDIA’s website, and its version should match the CUDA version of PyTorch. i.e., the specified version of cudatoolkit in the conda install command.
Install MMEngine without MIM¶
To install MMEngine with pip instead of MIM, please follow MMEngine installation guides.
For example, you can install MMEngine by the following command.
pip install onedl-mmengine
Install MMCV without MIM¶
MMCV contains C++ and CUDA extensions, thus depending on PyTorch in a complex way. MIM solves such dependencies automatically and makes the installation easier. However, it is not a must.
To install MMCV with pip instead of MIM, please follow MMCV installation guides. This requires manually specifying a find-url based on the PyTorch version and its CUDA version.
For example, the following command installs MMCV built for PyTorch 2.8.x and CUDA 12.8.
pip install onedl-mmcv -f https://mmwheels.onedl.ai/cu128-torch280/simple/
Install on CPU-only platforms¶
MMSegmentation can be built for CPU-only environment. In CPU mode you can train (requires MMCV version >= 2.0.0), test, or infer a model.
Install on Google Colab¶
Google Colab usually has PyTorch installed, thus we only need to install MMEngine, MMCV, and MMSegmentation with the following commands.
Step 1. Install MMEngine and MMCV using MIM.
!pip3 install onedl-mim
!mim install onedl-mmengine
!mim install onedl-mmcv
Step 2. Install MMSegmentation from the source.
!git clone https://github.com/vbti-development/onedl-mmsegmentation.git
%cd onedl-mmsegmentation
!pip install -e .
Step 3. Verification.
import mmseg
print(mmseg.__version__)
# Example output: 1.0.0
Note
Within Jupyter, the exclamation mark ! is used to call external executables and %cd is a magic command to change the current working directory of Python.
Use MMSegmentation with Docker¶
We provide a Dockerfile to build an image. Ensure that your docker version >=19.03.
# build an image with PyTorch 2.8, CUDA 12.9
# If you prefer other versions, just modify the Dockerfile
docker build -t mmsegmentation docker/
Run it with
docker run --gpus all --shm-size=8g -it -v {DATA_DIR}:/mmsegmentation/data mmsegmentation
Optional Dependencies¶
Install GDAL¶
GDAL is a translator library for raster and vector geospatial data formats. Install GDAL to read complex formats and extremely large remote sensing images.
conda install GDAL
Troubleshooting¶
If you have some issues during the installation, please first view the FAQ page. You may open an issue on GitHub if no solution is found.