Table of Contents
Shortcuts

Note

You are reading the documentation for MMEditing 0.x, which will soon be deprecated by the end of 2022. We recommend you upgrade to MMEditing 1.0 to enjoy fruitful new features and better performance brought by OpenMMLab 2.0. Check out the changelog, code and documentation of MMEditing 1.0 for more details.

Changelog

v0.16.1 (24/02/2023)

New Features & Improvements

  • Support FID and KID metrics. #775

  • Support groups parameter in ResidualBlockNoBN. #1510

Bug Fixes

  • Fix bug of TTSR configuration file. #1435

  • Fix RealESRGAN test dataset. #1489

  • Fix dump config in train scrips. #1584

  • Fix dynamic exportable ONNX of pixel-unshuffle. #1637

Contributors

A total of 10 developers contributed to this release. Thanks @LeoXing1996, @Z-Fran, @zengyh1900, @liuky74, @KKIEEK, @zeakey, @Sqhttwl, @yhna940, @gihwan-kim, @vansin

New Contributors

  • @liuky74 made their first contribution in https://github.com/open-mmlab/mmediting/pull/1435

  • @KKIEEK made their first contribution in https://github.com/open-mmlab/mmediting/pull/775

  • @zeakey made their first contribution in https://github.com/open-mmlab/mmediting/pull/1584

  • @Sqhttwl made their first contribution in https://github.com/open-mmlab/mmediting/pull/1627

  • @yhna940 made their first contribution in https://github.com/open-mmlab/mmediting/pull/1637

  • @gihwan-kim made their first contribution in https://github.com/open-mmlab/mmediting/pull/1510

v0.16.0 (31/10/2022)

Deprecations

VisualizationHook is deprecated. Users should use MMEditVisualizationHook instead. (#1375)

Old Version Current Version 
visual_config = dict(  # config to register visualization hook
  type='VisualizationHook',
  output_dir='visual',
  interval=1000,
  res_name_list=[
      'gt_img', 'masked_img', 'fake_res', 'fake_img', 'fake_gt_local'
  ],
)

visual_config = dict(  # config to register visualization hook
  type='MMEditVisualizationHook',
  output_dir='visual',
  interval=1000,
  res_name_list=[
      'gt_img', 'masked_img', 'fake_res', 'fake_img', 'fake_gt_local'
  ],
)

New Features & Improvements

  • Improve arguments type in preprocess_div2k_dataset.py. (#1381)

  • Update docstring of RDN. (#1326)

  • Update the introduction in readme. (#)

Bug Fixes

  • Fix FLAVR register in mmedit/models/video_interpolators when importing FLAVR. (#1186)

  • Fix data path processing in restoration_video_inference.py. (#1262)

  • Fix the number of channels in RDB. (#1292, #1311)

Contributors

A total of 5 developers contributed to this release. Thanks @LeoXing1996, @Z-Fran, @zengyh1900, @ryanxingql, @ruoningYu.

v0.15.2 (09/09/2022)

Improvements

  • [Docs] Fix typos in docs. by @Yulv-git in https://github.com/open-mmlab/mmediting/pull/1079

  • [Docs] fix model_zoo and datasets docs link by @Z-Fran in https://github.com/open-mmlab/mmediting/pull/1043

  • [Docs] fix typos in readme. by @arch-user-france1 in https://github.com/open-mmlab/mmediting/pull/1078

  • [Improve] FLAVR demo by @Yshuo-Li in https://github.com/open-mmlab/mmediting/pull/954

  • [Fix] Update MMCV_MAX to 1.7 by @wangruohui in https://github.com/open-mmlab/mmediting/pull/1001

  • [Improve] Fix niqe_pris_params.npz path when installed as package by @ychfan in https://github.com/open-mmlab/mmediting/pull/995

  • [CI] update github workflow, circleci and github templates by @zengyh1900 in https://github.com/open-mmlab/mmediting/pull/1087

Contributors

@wangruohui @Yshuo-Li @zengyh1900 @Z-Fran @ychfan @arch-user-france1 @Yulv-git

v0.15.1 (04/07/2022)

Bug Fixes

  • [Fix] Update cain_b5_g1b32_vimeo90k_triplet.py (#929)

  • [Docs] Fix link to OST dataset (#933)

Improvements

  • [Docs] Update instruction to OST dataset (#937)

  • [CI] No actual execution in CUDA envs (#921)

  • [Docs] Add watermark to demo video (#935)

  • [Tests] Add mim ci (#928)

  • [Docs] Update README.md of FLAVR (#919)

  • [Improve] Update md-format in .pre-commit-config.yaml (#917)

  • [Improve] Add miminstall.txt in setup.py (#916)

  • [Fix] Fix clutter in dim/README.md (#913)

  • [Improve] Skip problematic opencv-python versions (#833)

Contributors

@wangruohui @Yshuo-Li

v0.15.0 (01/06/2022)

Highlights

  1. Support FLAVR

  2. Support AOT-GAN

  3. Support CAIN with ReduceLROnPlateau Scheduler

New Features

  • Add configs for AOT-GAN (#681)

  • Support Vimeo90k-triplet dataset (#810)

  • Add default config for mm-assistant (#827)

  • Support CPU demo (#848)

  • Support use_cache and backend in LoadImageFromFileList (#857)

  • Support VFIVimeo90K7FramesDataset (#858)

  • Support ColorJitter for VFI (#859)

  • Support ReduceLrUpdaterHook (#860)

  • Support after_val_epoch in IterBaseRunner (#861)

  • Support FLAVR Net (#866, #867, #897)

  • Support MAE metric (#871)

  • Use mdformat (#888)

  • Support CAIN with ReduceLROnPlateau Scheduler (#906)

Bug Fixes

  • Change - to _ for restoration_demo.py (#834)

  • Remove recommonmark in requirements/docs.txt (#844)

  • Move EDVR to VSR category in README.md (#849)

  • Remove , in multi-line F-string in crop.py (#855)

  • Modify double lq_path to gt_path in test_pipeline (#862)

  • Fix unittest of TOF-VFI (#873)

  • Fix wrong frames in VFI demo (#891)

  • Fix logo & contrib guideline on README (#898)

  • Normalizing trimap in indexnet_dimaug_mobv2_1x16_78k_comp1k.py (#901)

Improvements

  • Add --cfg-options in train/test scripts (#826)

  • Update MMCV_MAX to 1.6 (#829)

  • Update TOFlow in README (#835)

  • Recover beirf installation steps & merge optional requirements (#836)

  • Use {MMEditing Contributors} in citation (#838)

  • Add tutorial for customizing losses (#839)

  • Add installation guide (wiki ver) in README (#845)

  • Add a ‘need help to traslate’ note on Chinese documentation (#850)

  • Add wechat QR code in README_zh-CN.md (#851)

  • Support non-zero frame index for SRFolderVideoDataset & Fix Typos (#853)

  • Create README.md for docker (#856)

  • Optimize IO for flow_warp (#881)

  • Move wiki/installation to docs (#883)

  • Add myst_heading_anchors (#887)

  • Use checkpoint link in inpainting demo (#892)

Contributors

@wangruohui @quincylin1 @nijkah @jayagami @ckkelvinchan @ryanxingql @NK-CS-ZZL @Yshuo-Li

v0.14.0 (01/04/2022)

Highlights

  1. Support TOFlow in video frame interpolation

New Features

  • Support AOT-GAN (#677)

  • Use --diff-seed to set different torch seed on different rank (#781)

  • Support streaming reading of frames in video interpolation demo (#790)

  • Support dist_train without slurm (#791)

  • Put LQ into CPU for restoration_video_demo (#792)

  • Support gray normalization constant in EDSR (#793)

  • Support TOFlow in video frame interpolation (#806, #811)

  • Support seed in DistributedSampler and sync seed across ranks (#815)

Bug Fixes

  • Update link in README files (#782, #786, #819, #820)

  • Fix matting tutorial, and fix links to colab (#795)

  • Invert flip_ratio in RandomAffine pipeline (#799)

  • Update preprocess_div2k_dataset.py (#801)

  • Update SR Colab Demo Installation Method and Set5 link (#807)

  • Fix Y/GRB mistake in EDSR README (#812)

  • Replace pytorch install command to conda in README(_zh-CN).md (#816)

Improvements

  • Update CI (#650)

  • Update requirements.txt (#725, #817)

  • Add Tutorial of dataset (#758), pipeline (#779), model (#766)

  • Update index and TOC tree (#767)

  • Make update_model_index.py compatible on windows (#768)

  • Update doc build system (#769)

  • Update keyword and classifier for setuptools (#773)

  • Renovate installation (#776, #800)

  • Update BasicVSR++ and RealBasicVSR docs (#778)

  • Update citation (#785, #787)

  • Regroup docs (#788)

  • Use full name of config as ‘Name’ in metafile (#798)

  • Update figure and video demo in README (#802)

  • Add clamp(0, 1) in test of video frame interpolation (#805)

  • Use hyphen for command line args in demo & tools (#808), and keep underline for required arguments in python files (#822)

  • Make dataset.pipeline a dedicated section in doc (#813)

  • Update mmcv-full>=1.3.13 to support DCN on CPU (#823)

Contributors

@wangruohui @ckkelvinchan @Yshuo-Li @nijkah @wdmwhh @freepoet @quincylin1

v0.13.0 (01/03/2022)

Highlights

  1. Support CAIN

  2. Support EDVR-L

  3. Support running in Windows

New Features

  • Add test-time ensemble for images and videos and support ensemble in BasicVSR series (#585)

  • Support AOT-GAN (work in progress) (#674, #675, #676)

  • Support CAIN (#683, #691, #709, #713)

  • Add basic interpolater (#687)

  • Add BaseVFIDataset and VFIVimeo90KDataset (#695, #697)

  • Add video interpolation demo (#688, #717)

  • Support various scales in RRDBNet (#699)

  • Support Ref-SR inference (#716)

  • Support EDVR-L on REDS (#719)

  • Support CPU training (#720)

  • Support running in Windows (#732, #738)

  • Support DCN on CPU (#735)

Bug Fixes

  • Fix link address in docs (#703, #704)

  • Fix ARG MMCV in Dockerfile (#708)

  • Fix file permission of non-executable files (#718)

  • Fix some deprecation warning related to numpy (#728)

  • Delete __init__ in TestVFIDataset (#731)

  • Fix data type in docstring of several Datasets (#739)

  • Fix math notation in docstring (#741)

  • Fix missing folders in copyright commit hook (#754)

  • Delete duplicate test in loading (#756)

Improvements

  • Update Pillow from 6.2.2 to 8.4 in CI (#693)

  • Add argument ‘repeat’ to SRREDSMultipleGTDataset (#672)

  • Deprecate the support for “python setup.py test” (#701)

  • Add setup multi-processing both in train and test (#707)

  • Add OpenMMLab website and platform links (#710)

  • Refact README files of all methods (#712)

  • Replace string version comparison with package.version.parse (#723)

  • Add docs of Ref-SR demo and video frame interpolation demo (#724)

  • Add interpolation and refact README.md (#726)

  • Update isort version in pre-commit hook (#727)

  • Redesign CI for Linux (#734)

  • Update install.md (#763)

  • Reorganizing OpenMMLab projects in readme (#764)

  • Add deprecation message for deploy tools (#765)

Contributors

@wangruohui @ckkelvinchan @Yshuo-Li @quincylin1 @Juggernaut93 @anse3832 @nijkah

v0.12.0 (31/12/2021)

Highlights

  1. Support RealBasicVSR

  2. Support Real-ESRGAN checkpoint

New Features

  • Support video input and output in restoration demo (#622)

  • Support RealBasicVSR (#632, #633, #647, #680)

  • Support Real-ESRGAN checkpoint (#635)

  • Support conversion to y-channel when loading images (643)

  • Support random video compression during training (#646)

  • Support crop sequence (#648)

  • Support pixel_unshuffle (#684)

Bug Fixes

  • Change ‘target_size’ for RandomResize from list to tuple (#617)

  • Fix folder creation in preprocess_df2k_ost_dataset.py (#623)

  • Change TDAN config path in README (#625)

  • Change ‘radius’ to ‘kernel_size’ for UnsharpMasking in Real-ESRNet config (#626)

  • Fix bug in MATLABLikeResize (#630)

  • Fix ‘flow_warp’ comment (#655)

  • Fix the error of Model Zoo and Datasets in docs (#664)

  • Fix bug in ‘random_degradations’ (#673)

  • Limit opencv-python version (#689)

Improvements

  • Translate docs to Chinese (#576, #577, #578, #579, #581, #582, #584, #587, #588, #589, #590, #591, #592, #593, #594, #595, #596, #641, #647, #656, #665, #666)

  • Add UNetDiscriminatorWithSpectralNorm (#605)

  • Use PyTorch sphinx theme (#607, #608)

  • Update mmcv (#609), mmflow (#621), mmfewshot (#634) and mmhuman3d (#649) in docs

  • Convert minimum GCC version to 5.4 (#612)

  • Add tiff in SRDataset IMG_EXTENSIONS (#614)

  • Update metafile and update_model_index.py (#615)

  • Update preprocess_df2k_ost_dataset.py (#624)

  • Add Abstract to README (#628, #636)

  • Align NIQE to MATLAB results (#631)

  • Add official markdown lint hook (#639)

  • Skip CI when some specific files were changed (#640)

  • Update docs/conf.py (#644, #651)

  • Try to create a symbolic link on windows (#645)

  • Cancel previous runs that are not completed (#650)

  • Update path of configs in demo.md and getting_started.md (#658, #659)

  • Use mmcv root model registry (#660)

  • Update README.md (#654, #663)

  • Refactor the structure of documentation (#668)

  • Add script to crop REDS images into sub-images for faster IO (#669)

  • Capitalize the first letter of the task name in the metafile (#678)

  • Update FixedCrop for cropping image sequence (#682)

v0.11.0 (03/11/2021)

Highlights

  • GLEAN for blind face image restoration #530

  • Real-ESRGAN model #546

New Features

  • Exponential Moving Average Hook #542

  • Support DF2K_OST dataset #566

Improvements

  • Add MATLAB-like bicubic interpolation #507

  • Support random degradations during training #504

  • Support torchserve #568

v0.10.0 (12/08/2021).

Highlights

  1. Support LIIF-RDN (CVPR’2021)

  2. Support BasicVSR++ (NTIRE’2021)

New Features

  • Support loading annotation from file for video SR datasets (#423)

  • Support persistent worker (#426)

  • Support LIIF-RDN (#428, #440)

  • Support BasicVSR++ (#451, #467)

  • Support mim (#455)

Bug Fixes

  • Fix bug in stat.py (#420)

  • Fix astype error in function tensor2img (#429)

  • Fix device error caused by torch.new_tensor when pytorch >= 1.7 (#465)

  • Fix _non_dist_train in .mmedit/apis/train.py (#473)

  • Fix multi-node distributed test (#478)

Breaking Changes

  • Refactor LIIF for pytorch2onnx (#425)

Improvements

  • Update Chinese docs (#415, #416, #418, #421, #424, #431, #442)

  • Add CI of pytorch 1.9.0 (#444)

  • Refactor README.md of configs (#452)

  • Avoid loading pretrained VGG in unittest (#466)

  • Support specifying scales in preprocessing div2k dataset (#472)

  • Support all formats in readthedocs (#479)

  • Use version_info of mmcv (#480)

  • Remove unnecessary codes in restoration_video_demo.py (#484)

  • Change priority of DistEvalIterHook to ‘LOW’ (#489)

  • Reset resource limit (#491)

  • Update QQ QR code in README_CN.md (#494)

  • Add myst_parser (#495)

  • Add license header (#496)

  • Fix typo of StyleGAN modules (#427)

  • Fix typo in docs/demo.md (#453, #454)

  • Fix typo in tools/data/super-resolution/reds/README.md (#469)

v0.9.0 (30/06/2021).

Highlights

  1. Support DIC and DIC-GAN (CVPR’2020)

  2. Support GLEAN Cat 8x (CVPR’2021)

  3. Support TTSR-GAN (CVPR’2020)

  4. Add colab tutorial for super-resolution

New Features

Bug Fixes

  • Fix bug in restoration_video_inference.py (#379)

  • Fix Config of LIIF (#368)

  • Change the path to pre-trained EDVR-M (#396)

  • Fix normalization in restoration_video_inference (#406)

  • Fix [brush_stroke_mask] error in unittest (#409)

Breaking Changes

  • Change mmcv minimum version to v1.3 (#378)

Improvements

  • Correct Typos in code (#371)

  • Add Custom_hooks (#362)

  • Refactor unittest folder structure (#386)

  • Add documents and download link for Vid4 (#399)

  • Update model zoo for documents (#400)

  • Update metafile (407)

v0.8.0 (31/05/2021).

Highlights

  1. Support GLEAN (CVPR’2021)

  2. Support TTSR (CVPR’2020)

  3. Support TDAN (CVPR’2020)

New Features

Bug Fixes

  • Fix find_unused_parameters in PyTorch 1.8 for BasicVSR (#290)

  • Fix error in publish_model.py for pt>=1.6 (#291)

  • Fix PSNR when input is uint8 (#294)

Improvements

  • Support backend in LoadImageFromFile (#293, #303)

  • Update metric_average_mode of video SR dataset (#319)

  • Add error message in restoration_demo.py (324)

  • Minor correction in getting_started.md (#339)

  • Update description for Vimeo90K (#349)

  • Support start_index in GenerateSegmentIndices (#338)

  • Support different filename templates in GenerateSegmentIndices (#325)

  • Support resize by scale-factor (#295, #310)

v0.7.0 (30/04/2021).

Highlights

  1. Support BasicVSR (CVPR’2021)

  2. Support IconVSR (CVPR’2021)

  3. Support RDN (CVPR’2018)

  4. Add onnx evaluation tool

New Features

Bug Fixes

  • Fix onnx conversion of maxunpool2d (#243)

  • Fix inpainting in demo.md (#248)

  • Tiny fix of config file of EDSR (#251)

  • Fix link in README (#256)

  • Fix restoration_inference key missing bug (#270)

  • Fix the usage of channel_order in loading.py (#271)

  • Fix the command of inpainting (#278)

  • Fix preprocess_vimeo90k_dataset.py args name (#281)

Improvements

  • Support empty_cache option in test.py (#261)

  • Update projects in README (#249, #276)

  • Support Y-channel PSNR and SSIM (#250)

  • Add zh-CN README (#262)

  • Update pytorch2onnx doc (#265)

  • Remove extra quotation in English readme (#268)

  • Change tags to comment (#269)

  • List model zoo in README (#284, #285, #286)

v0.6.0 (08/04/2021).

Highlights

  1. Support Local Implicit Image Function (LIIF)

  2. Support exporting DIM and GCA from Pytorch to ONNX

New Features

  • Add readthedocs config files and fix docstring (#92)

  • Add github action file (#94)

  • Support exporting DIM and GCA from Pytorch to ONNX (#105)

  • Support concatenating datasets (#106)

  • Support non_dist_train validation (#110)

  • Add matting colab tutorial (#111)

  • Support niqe metric (#114)

  • Support PoolDataLoader for parrots (#134)

  • Support collect-env (#137, #143)

  • Support pt1.6 cpu/gpu in CI (#138)

  • Support fp16 (139, #144)

  • Support publishing to pypi (#149)

  • Add modelzoo statistics (#171, #182, #186)

  • Add doc of datasets (194)

  • Support extended foreground option. (#195, #199, #200, #210)

  • Support nn.MaxUnpool2d (#196)

  • Add some FBA components (#203, #209, #215, #220)

  • Support random down sampling in pipeline (#222)

  • Support SR folder GT Dataset (#223)

  • Support Local Implicit Image Function (LIIF) (#224, #226, #227, #234, #239)

Bug Fixes

  • Fix _non_dist_train in train api (#104)

  • Fix setup and CI (#109)

  • Fix redundant loop bug in Normalize (#121)

  • Fix get_hash in setup.py (#124)

  • Fix tool/preprocess_reds_dataset.py (#148)

  • Fix slurm train tutorial in getting_started.md (#162)

  • Fix pip install bug (#173)

  • Fix bug in config file (#185)

  • Fix broken links of datasets (#236)

  • Fix broken links of model zoo (#242)

Breaking Changes

  • Refactor data loader configs (#201)

Improvements

  • Updata requirements.txt (#95, #100)

  • Update teaser (#96)

  • Updata README (#93, #97, #98, #152)

  • Updata model_zoo (#101)

  • Fix typos (#102, #188, #191, #197, #208)

  • Adopt adjust_gamma from skimage and reduce dependencies (#112)

  • remove .gitlab-ci.yml (#113)

  • Update import of first party (#115)

  • Remove citation and contact (#122)

  • Update version file (#136)

  • Update download url (#141)

  • Update setup.py (#150)

  • Update the highest version of supported mmcv (#153, #154)

  • modify Crop to handle a sequence of video frames (#164)

  • Add links to other mm projects (#179, #180)

  • Add config type (#181)

  • Refactor docs (#184)

  • Add config link (#187)

  • Update file structure (#192)

  • Update config doc (#202)

  • Update slurm_train.md script (#204)

  • Improve code style (#206, #207)

  • Use file_client in CompositeFg (#212)

  • Replace random with numpy.random (#213)

  • Refactor loader_cfg (#214)

v0.5.0 (09/07/2020).

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.

Read the Docs v: latest
Versions
latest
stable
1.x
0.16.1
v0.16.0
v0.15.2
v0.15.1
v0.15.0
v0.14.0
v0.13.0
v0.12.0
docs
dev-1.x
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.