• Introduction
• • Major features
• What's New
• • 🌟 Preview of 1.x version
  • 💎 Stable version
• Installation
• Getting Started
• Model Zoo
• Contributing
• Acknowledgement
• Citation
• License
• Projects in OpenMMLab 2.0

 

OpenMMLab website ^HOT      OpenMMLab platform ^{TRY IT OUT}

 

📘Documentation |
🛠️Installation |
👀Model Zoo |
🆕Update News |
🚀Ongoing Projects |
🤔Reporting Issues

English | 简体中文

Introduction

MMEditing is an open-source image and video editing&generating toolbox based on PyTorch. It is a part of the OpenMMLab project.

Currently, MMEditing support the following tasks:

The master branch works with PyTorch 1.5+.

Some Demos:

https://user-images.githubusercontent.com/12756472/158972852-be5849aa-846b-41a8-8687-da5dee968ac7.mp4

https://user-images.githubusercontent.com/12756472/158972813-d8d0f19c-f49c-4618-9967-52652726ef19.mp4

GAN Interpolation	GAN Projector	GAN Manipulation

Major features

• Modular design

  We decompose the editing framework into different components and one can easily construct a customized editor framework by combining different modules.

• Support of multiple tasks

  The toolbox directly supports popular and contemporary inpainting, matting, super-resolution, interpolation and generation tasks.

• Efficient Distributed Training for Generative Models:

  With support of MMSeparateDistributedDataParallel, distributed training for dynamic architectures can be easily implemented.

• State of the art

  The toolbox provides state-of-the-art methods in inpainting/matting/super-resolution/interpolation/generation.

Note that MMSR has been merged into this repo, as a part of MMEditing.
With elaborate designs of the new framework and careful implementations,
hope MMEditing could provide better experience.

What's New

🌟 Preview of 1.x version

A brand new version of MMEditing v1.0.0rc4 was released in 05/12/2022:

• Support Text2Image Task! Disco-Diffusion
• Support 3D-aware Generation Task! EG3D
• Support all the tasks, models, metrics, and losses in MMGeneration 😍.
• Unifies interfaces of all components based on MMEngine.
• Support patch-based and slider-based image and video comparison viewer.
• Support image colorization.

Find more new features in 1.x branch. Issues and PRs are welcome!

💎 Stable version

0.16.0 was released in 31/10/2022:

• VisualizationHook is deprecated. Users should use MMEditVisualizationHook instead.
• Fix FLAVR register.
• Fix the number of channels in RDB.

Please refer to changelog.md for details and release history.

Installation

MMEditing depends on PyTorch, MMEngine and MMCV.
Below are quick steps for installation.

Step 1.
Install PyTorch following official instructions.

Step 2.
Install MMCV with MIM.

pip3 install openmim
# wait for more pre-compiled pkgs to release
mim install 'mmcv>=2.0.0rc1'

Step 3.
Install MMEditing from source.

git clone -b 1.x https://github.com/open-mmlab/mmediting.git
cd mmediting
pip3 install -e .

Please refer to get_started.md for more detailed instruction.

Getting Started

Please see get_started.md and inference.md for the basic usage of MMEditing.

Model Zoo

Supported algorithms:

Inpainting

• ✅ Global&Local (ToG'2017)
• ✅ DeepFillv1 (CVPR'2018)
• ✅ PConv (ECCV'2018)
• ✅ DeepFillv2 (CVPR'2019)
• ✅ AOT-GAN (TVCG'2021)

Matting

• ✅ DIM (CVPR'2017)
• ✅ IndexNet (ICCV'2019)
• ✅ GCA (AAAI'2020)

Image-Super-Resolution

• ✅ SRCNN (TPAMI'2015)
• ✅ SRResNet&SRGAN (CVPR'2016)
• ✅ EDSR (CVPR'2017)
• ✅ ESRGAN (ECCV'2018)
• ✅ RDN (CVPR'2018)
• ✅ DIC (CVPR'2020)
• ✅ TTSR (CVPR'2020)
• ✅ GLEAN (CVPR'2021)
• ✅ LIIF (CVPR'2021)
• ✅ Real-ESRGAN (ICCVW'2021)

Video-Super-Resolution

• ✅ EDVR (CVPR'2019)
• ✅ TOF (IJCV'2019)
• ✅ TDAN (CVPR'2020)
• ✅ BasicVSR (CVPR'2021)
• ✅ IconVSR (CVPR'2021)
• ✅ BasicVSR++ (CVPR'2022)
• ✅ RealBasicVSR (CVPR'2022)

Video Interpolation

• ✅ TOFlow (IJCV'2019)
• ✅ CAIN (AAAI'2020)
• ✅ FLAVR (CVPR'2021)

Image Colorization

• ✅ InstColorization (CVPR'2020)

Unconditional GANs

• ✅ DCGAN (ICLR'2016)
• ✅ WGAN-GP (NeurIPS'2017)
• ✅ LSGAN (ICCV'2017)
• ✅ GGAN (ArXiv'2017)
• ✅ PGGAN (ICLR'2018)
• ✅ StyleGANV1 (CVPR'2019)
• ✅ StyleGANV2 (CVPR'2020)
• ✅ StyleGANV3 (NeurIPS'2021)

Conditional GANs

• ✅ SNGAN (ICLR'2018)
• ✅ Projection GAN (ICLR'2018)
• ✅ SAGAN (ICML'2019)
• ✅ BIGGAN/BIGGAN-DEEP (ICLR'2019)

Image2Image Translation

• ✅ Pix2Pix (CVPR'2017)
• ✅ CycleGAN (ICCV'2017)

Internal Learning

• ✅ SinGAN (ICCV'2019)

Text2Image

• ✅ Disco-Diffusion

3D-aware Generation

• ✅ EG3D

Please refer to model_zoo for more details.

Contributing

We appreciate all contributions to improve MMEditing. Please refer to CONTRIBUTING.md in MMCV and CONTRIBUTING.md in MMEngine for more details about the contributing guideline.

Acknowledgement

MMEditing is an open source project that is contributed by researchers and engineers from various colleges and companies. We appreciate all the contributors who implement their methods or add new features, as well as users who give valuable feedbacks. We wish that the toolbox and benchmark could serve the growing research community by providing a flexible toolkit to reimplement existing methods and develop their own new methods.

Citation

If MMEditing is helpful to your research, please cite it as below.

@misc{mmediting2022,
    title = {{MMEditing}: {OpenMMLab} Image and Video Editing Toolbox},
    author = {{MMEditing Contributors}},
    howpublished = {\url{https://github.com/open-mmlab/mmediting}},
    year = {2022}
}

License

This project is released under the Apache 2.0 license. Please refer to LICENSES.md for the careful check, if you are using our code for commercial matters.

Projects in OpenMMLab 2.0

• MMEngine: OpenMMLab foundational library for training deep learning models.
• MMCV: OpenMMLab foundational library for computer vision.
• MIM: MIM installs OpenMMLab packages.
• MMClassification: OpenMMLab image classification toolbox and benchmark.
• MMDetection: OpenMMLab detection toolbox and benchmark.
• MMDetection3D: OpenMMLab's next-generation platform for general 3D object detection.
• MMRotate: OpenMMLab rotated object detection toolbox and benchmark.
• MMSegmentation: OpenMMLab semantic segmentation toolbox and benchmark.
• MMOCR: OpenMMLab text detection, recognition, and understanding toolbox.
• MMPose: OpenMMLab pose estimation toolbox and benchmark.
• MMHuman3D: OpenMMLab 3D human parametric model toolbox and benchmark.
• MMSelfSup: OpenMMLab self-supervised learning toolbox and benchmark.
• MMRazor: OpenMMLab model compression toolbox and benchmark.
• MMFewShot: OpenMMLab fewshot learning toolbox and benchmark.
• MMAction2: OpenMMLab's next-generation action understanding toolbox and benchmark.
• MMTracking: OpenMMLab video perception toolbox and benchmark.
• MMFlow: OpenMMLab optical flow toolbox and benchmark.
• MMEditing: OpenMMLab image and video editing toolbox.
• MMGeneration: OpenMMLab image and video generative models toolbox.
• MMDeploy: OpenMMLab model deployment framework.