mirrors
/
mmsegmentation
mirror of https://github.com/open-mmlab/mmsegmentation.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mmsegmentation/README.md

111 lines
4.3 KiB
Markdown
Raw Normal View History

init commit
2020-07-07 20:52:19 +08:00
<div align="center">
<img src="resources/mmseg-logo.png" width="600"/>
</div>
Add Colab Tutorial (#7) * add badge * Created using Colaboratory * add read docs * Fixed readthedocs * fixed colab ref * add readthedocs.txt * add link * fixed modelzoo link * add missing reference * fixed docs * remove relative path in docs * add colab in README.md * update docker image * add newline * fixed br
2020-07-10 16:55:47 +08:00
<br />
fixed name in pypi, add badge (#15) * fixed name in pypi, add badge * fixed name in install.md * update install.md
2020-07-14 14:41:52 +08:00
[![PyPI](https://img.shields.io/pypi/v/mmsegmentation)](https://pypi.org/project/mmsegmentation)
Add Colab Tutorial (#7) * add badge * Created using Colaboratory * add read docs * Fixed readthedocs * fixed colab ref * add readthedocs.txt * add link * fixed modelzoo link * add missing reference * fixed docs * remove relative path in docs * add colab in README.md * update docker image * add newline * fixed br
2020-07-10 16:55:47 +08:00
[![docs](https://img.shields.io/badge/docs-latest-blue)](https://mmsegmentation.readthedocs.io/en/latest/)
[![badge](https://github.com/open-mmlab/mmsegmentation/workflows/build/badge.svg)](https://github.com/open-mmlab/mmsegmentation/actions)
[![codecov](https://codecov.io/gh/open-mmlab/mmsegmentation/branch/master/graph/badge.svg)](https://codecov.io/gh/open-mmlab/mmsegmentation)
[![license](https://img.shields.io/github/license/open-mmlab/mmsegmentation.svg)](https://github.com/open-mmlab/mmsegmentation/blob/master/LICENSE)
update docker (#149) * update docker * Update Dockerfile
2020-09-29 19:54:32 +08:00
[![issue resolution](https://isitmaintained.com/badge/resolution/open-mmlab/mmsegmentation.svg)](https://github.com/open-mmlab/mmsegmentation/issues)
[![open issues](https://isitmaintained.com/badge/open/open-mmlab/mmsegmentation.svg)](https://github.com/open-mmlab/mmsegmentation/issues)
Add Colab Tutorial (#7) * add badge * Created using Colaboratory * add read docs * Fixed readthedocs * fixed colab ref * add readthedocs.txt * add link * fixed modelzoo link * add missing reference * fixed docs * remove relative path in docs * add colab in README.md * update docker image * add newline * fixed br
2020-07-10 16:55:47 +08:00
Documentation: https://mmsegmentation.readthedocs.io/
init commit
2020-07-07 20:52:19 +08:00
## Introduction
MMSegmentation is an open source semantic segmentation toolbox based on PyTorch.
It is a part of the OpenMMLab project.
update docker (#149) * update docker * Update Dockerfile
2020-09-29 19:54:32 +08:00
The master branch works with **PyTorch 1.3 to 1.6**.
init commit
2020-07-07 20:52:19 +08:00
![demo image](resources/seg_demo.gif)
### Major features
- **Unified Benchmark**
We provide a unified benchmark toolbox for various semantic segmentation methods.
- **Modular Design**
We decompose the semantic segmentation framework into different components and one can easily construct a customized semantic segmentation framework by combining different modules.
- **Support of multiple methods out of box**
The toolbox directly supports popular and contemporary semantic segmentation frameworks, *e.g.* PSPNet, DeepLabV3, PSANet, DeepLabV3+, etc.
- **High efficiency**
The training speed is faster than or comparable to other codebases.
## License
This project is released under the [Apache 2.0 license](LICENSE).
Add pypi deployment (#11) * add pypi deployment * remove useless jobs * fixed typo and cleanup * delete build.tx * add change log Co-authored-by: Jiarui XU <xvjiarui0826@gmail.com>
2020-07-13 20:54:32 +08:00
## Changelog
Bump to v0.10 (#325) * Bump to v0.10 * change version
2021-01-03 07:29:56 +08:00
v0.10.0 was released in 01/01/2021.
Auto get version info and git hash (#55) * Auto get version info and git hash * bump 0.5.1 and update doc * fixed docs * Add change log
2020-08-11 19:23:35 +08:00
Please refer to [changelog.md](docs/changelog.md) for details and release history.
Add pypi deployment (#11) * add pypi deployment * remove useless jobs * fixed typo and cleanup * delete build.tx * add change log Co-authored-by: Jiarui XU <xvjiarui0826@gmail.com>
2020-07-13 20:54:32 +08:00
init commit
2020-07-07 20:52:19 +08:00
## Benchmark and model zoo
Results and models are available in the [model zoo](docs/model_zoo.md).
Supported backbones:
[Improvement] Add markdown linter and fix linting errors (#171) * [Improvement] Add markdown linter and fix linting errors * fixed pip
2020-10-07 19:50:16 +08:00
init commit
2020-07-07 20:52:19 +08:00
- [x] ResNet
- [x] ResNeXt
Support ResNeSt backbone (#47) * Support ResNeSt backbone * fixed avg_down * add docstring and test * update table * update docs and tests * fixed test * rename * refactor splits
2020-08-17 00:54:01 +08:00
- [x] [HRNet](configs/hrnet/README.md)
- [x] [ResNeSt](configs/resnest/README.md)
adding mobilenetv2 to docs/model_zoo.md and readme.md (#146) * updating the readme with mobilenet_v2 backbone * adding mobilenetv2 to model_zoo.md * placing mobilenetv2 after pointrend
2020-09-25 17:44:34 +08:00
- [x] [MobileNetV2](configs/mobilenet_v2/README.md)
[New model] Support MobileNetV3 (#268) * delete markdownlint * Support MobileNetV3 * fix import * add mobilenetv3 head and configs * Modify MobileNetV3 to semantic segmentation version * modify mobilenetv3 configs * add std configs * fix Conv2dAdaptivePadding bug * add configs * add unitest and fix bugs * fix lraspp unitest bugs * restore * fix unitest * add MobileNetV3 docstring * add mmcv * add mmcv * fix syntax bug * fix unitest bug * fix unitest bug * fix unitest bugs * fix docstring * add configs * restore * delete unnecessary assert * modify unitest * delete benchmark
2020-12-26 16:02:50 +08:00
- [x] [MobileNetV3](configs/mobilenet_v3/README.md)
init commit
2020-07-07 20:52:19 +08:00
Supported methods:
[Improvement] Add markdown linter and fix linting errors (#171) * [Improvement] Add markdown linter and fix linting errors * fixed pip
2020-10-07 19:50:16 +08:00
init commit
2020-07-07 20:52:19 +08:00
- [x] [FCN](configs/fcn)
- [x] [PSPNet](configs/pspnet)
- [x] [DeepLabV3](configs/deeplabv3)
- [x] [PSANet](configs/psanet)
- [x] [DeepLabV3+](configs/deeplabv3plus)
- [x] [UPerNet](configs/upernet)
- [x] [NonLocal Net](configs/nonlocal_net)
Add Colab Tutorial (#7) * add badge * Created using Colaboratory * add read docs * Fixed readthedocs * fixed colab ref * add readthedocs.txt * add link * fixed modelzoo link * add missing reference * fixed docs * remove relative path in docs * add colab in README.md * update docker image * add newline * fixed br
2020-07-10 16:55:47 +08:00
- [x] [EncNet](configs/encnet)
init commit
2020-07-07 20:52:19 +08:00
- [x] [CCNet](configs/ccnet)
- [x] [DANet](configs/danet)
Support APCNet (#299) * Support APCNet * code optimization * add apcnet configs * add benchmark * add readme and model zoo * fix doc
2020-12-18 15:23:45 +08:00
- [x] [APCNet](configs/apcnet)
init commit
2020-07-07 20:52:19 +08:00
- [x] [GCNet](configs/gcnet)
Support DMNet (#313) * Support DMNet * fix doc and delete norm_name
2020-12-24 14:16:34 +08:00
- [x] [DMNet](configs/dmnet)
init commit
2020-07-07 20:52:19 +08:00
- [x] [ANN](configs/ann)
- [x] [OCRNet](configs/ocrnet)
Sorry for forgetting to update README.md. (#74)
2020-08-19 15:52:46 +08:00
- [x] [Fast-SCNN](configs/fastscnn)
Add "disentangled non-local (DNL) neural networks" [ECCV2020] (#37) * Add DNLHead * add configs * add weight decay mult * add norm back * Update README.md * matched inference performance * Fixed shape * sep conv_out * no norm * add norm back * complete model zoo * add tests * Add test forward * Add more test Co-authored-by: Jiarui XU <xvjiarui0826@gmail.com>
2020-09-07 16:22:00 +08:00
- [x] [Semantic FPN](configs/sem_fpn)
[Feature] Support PointRend (#109) * [Feature] Support PointRend * add previous test * update modelzoo
2020-09-07 19:59:44 +08:00
- [x] [PointRend](configs/point_rend)
Add "disentangled non-local (DNL) neural networks" [ECCV2020] (#37) * Add DNLHead * add configs * add weight decay mult * add norm back * Update README.md * matched inference performance * Fixed shape * sep conv_out * no norm * add norm back * complete model zoo * add tests * Add test forward * Add more test Co-authored-by: Jiarui XU <xvjiarui0826@gmail.com>
2020-09-07 16:22:00 +08:00
- [x] [EMANet](configs/emanet)
- [x] [DNLNet](configs/dnlnet)
[New model] Support CGNet (#223) * added cgnet * added testing for cgnet * git test * add cgnet * fix __init__ * rename FGlo with GlobalContextExtractor * add readme.md and rename bn with norm * delete cg_head * fix a language mistake * rename cgnet_m3n21.py to cgnet.py * modify README.md * modify list to tuple * add fcn_head test * add assert to fcn_head * blank * fix fcn_head assert bug * add * add cgnet to README.md and model_zoo.md * modify cgnet README.md Co-authored-by: KID <wps_@mail.nankai.edu.cn>
2020-11-03 16:05:25 +08:00
- [x] [CGNet](configs/cgnet)
Support FP16 (#21) * Support FP16 * add miss folder * add tests * remove useless config * update memory * reduce config * migrate fp16 to mmcv * add model link
2020-07-20 15:17:18 +08:00
- [x] [Mixed Precision (FP16) Training](configs/fp16/README.md)
init commit
2020-07-07 20:52:19 +08:00
## Installation
Please refer to [INSTALL.md](docs/install.md) for installation and dataset preparation.
## Get Started
Please see [getting_started.md](docs/getting_started.md) for the basic usage of MMSegmentation.
There are also tutorials for [adding new dataset](docs/tutorials/new_dataset.md), [designing data pipeline](docs/tutorials/data_pipeline.md), and [adding new modules](docs/tutorials/new_modules.md).
Add Colab Tutorial (#7) * add badge * Created using Colaboratory * add read docs * Fixed readthedocs * fixed colab ref * add readthedocs.txt * add link * fixed modelzoo link * add missing reference * fixed docs * remove relative path in docs * add colab in README.md * update docker image * add newline * fixed br
2020-07-10 16:55:47 +08:00
A Colab tutorial is also provided. You may preview the notebook [here](demo/MMSegmentation_Tutorial.ipynb) or directly [run](https://colab.research.google.com/github/open-mmlab/mmsegmentation/blob/master/demo/MMSegmentation_Tutorial.ipynb) on Colab.
init commit
2020-07-07 20:52:19 +08:00
## Contributing
We appreciate all contributions to improve MMSegmentation. Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md) for the contributing guideline.
## Acknowledgement
MMSegmentation is an open source project that welcome any contribution and feedback.
We wish that the toolbox and benchmark could serve the growing research
community by providing a flexible as well as standardized toolkit to reimplement existing methods
and develop their own new semantic segmentation methods.