Mmengine

Highlights

- Support PyTorch 2.0! Accelerate training by compiling models. See the tutorial [Model Compilation](https://mmengine.readthedocs.io/en/latest/common_usage/speed_up_training.html#model-compilation) for details
- Add `EarlyStoppingHook` to stop training when the metric does not improve

New Features & Enhancements

- Add configurations to support `torch.compile` in Runner by [C1rN09](https://github.com/C1rN09) in https://github.com/open-mmlab/mmengine/pull/976
- Support `EarlyStoppingHook` by [nijkah](https://github.com/nijkah) in https://github.com/open-mmlab/mmengine/pull/739
- Disable duplicated warning during distributed training by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/961
- Add `FUNCTIONS` root Registry by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/983
- Save the "memory" field to visualization backends by [enkilee](https://github.com/enkilee) in https://github.com/open-mmlab/mmengine/pull/974
- Enable bf16 in `AmpOptimWrapper` by [C1rN09](https://github.com/C1rN09) in https://github.com/open-mmlab/mmengine/pull/960
- Support writing data to `vis_backend` with prefix by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/972
- Support exporting logs of different ranks in debug mode by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/968
- Silence error when `ManagerMixin` built instance with duplicate name. by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/990

Bug fixes

- Fix optim_wrapper unittest for `pytorch < 1.10.0` by [C1rN09](https://github.com/C1rN09) in https://github.com/open-mmlab/mmengine/pull/975
- Support calculating the flops of `matmul` with single dimension matrix by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/970
- Fix repeated warning by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/992
- Fix lint by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/993
- Fix AMP in Ascend and support using NPUJITCompile environment by [luomaoling](https://github.com/luomaoling) in https://github.com/open-mmlab/mmengine/pull/994
- Fix inferencer gets wrong configs path by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/996

Docs

- Translate "Debug Tricks" to English by [enkilee](https://github.com/enkilee) in https://github.com/open-mmlab/mmengine/pull/953
- Translate "Model Analysis" document to English by [enkilee](https://github.com/enkilee) in https://github.com/open-mmlab/mmengine/pull/956
- Translate "Model Complexity Analysis" to Chinese. by [VoyagerXvoyagerx](https://github.com/VoyagerXvoyagerx) in https://github.com/open-mmlab/mmengine/pull/969
- Add a document about setting interval by [YuetianW](https://github.com/YuetianW) in https://github.com/open-mmlab/mmengine/pull/964
- Translate "how to set random seed" by [xin-li-67](https://github.com/xin-li-67) in https://github.com/open-mmlab/mmengine/pull/930
- Fix typo by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/965
- Fix typo in hook document by [acdart](https://github.com/acdart) in https://github.com/open-mmlab/mmengine/pull/980
- Fix changelog date by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/986

New Contributors
* YuetianW made their first contribution in https://github.com/open-mmlab/mmengine/pull/964
* enkilee made their first contribution in https://github.com/open-mmlab/mmengine/pull/953
* acdart made their first contribution in https://github.com/open-mmlab/mmengine/pull/980
* VoyagerXvoyagerx made their first contribution in https://github.com/open-mmlab/mmengine/pull/969

**Full Changelog**: https://github.com/open-mmlab/mmengine/compare/v0.6.0...v0.7.0

Highlights

- Support `Apex` with `ApexOptimWrapper`
- Support analyzing model complexity.
- Add `Lion` optimizer.
- Support using environment variable in the config file.

New Features & Enhancements

- Support model complexity computation by [tonysy](https://github.com/tonysy) in https://github.com/open-mmlab/mmengine/pull/779
- Add Lion optimizer by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/952
- Support using environment variable in config file. by [jbwang1997](https://github.com/jbwang1997) in https://github.com/open-mmlab/mmengine/pull/744
- Improve registry infer_scope by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/334
- Support configuring `timeout` in dist configuration by [apacha](https://github.com/apacha) in https://github.com/open-mmlab/mmengine/pull/877
- Beautify the print result of the registry by [Eiuyc](https://github.com/Eiuyc) in https://github.com/open-mmlab/mmengine/pull/922
- Refine the style of table by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/941
- Refine the `repr` of Registry by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/942
- Feature NPUProfilerHook by [luomaoling](https://github.com/luomaoling) in https://github.com/open-mmlab/mmengine/pull/925
- Refactor hooks unittest by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/946
- Temporarily fix `collect_env` raise errors and stops programs by [C1rN09](https://github.com/C1rN09) in https://github.com/open-mmlab/mmengine/pull/944
- Make sure Tensors to broadcast is contiguous by [XWHtorrentx](https://github.com/XWHtorrentx) in https://github.com/open-mmlab/mmengine/pull/948
- Clean the UT warning caused by pytest by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/947

Bug fixes

- Backend_args should not be modified by get_file_backend by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/897
- Support update `np.ScalarType` data in message_hub by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/898
- Support rendering Chinese character in `Visualizer` by [KevinNuNu](https://github.com/KevinNuNu) in https://github.com/open-mmlab/mmengine/pull/887
- Support `Apex` with `ApexOptimWrapper` by [xcnick](https://github.com/xcnick) in https://github.com/open-mmlab/mmengine/pull/742
- Fix the bug of `DefaultOptimWrapperConstructor` when the shared parameters do not require the grad by [HIT-cwh](https://github.com/HIT-cwh) in https://github.com/open-mmlab/mmengine/pull/903
- Support model complexity computation by [tonysy](https://github.com/tonysy) in https://github.com/open-mmlab/mmengine/pull/779

Docs

- Add the document for the transition between IterBasedTraining and EpochBasedTraining by [HAOCHENYE](https://github.com/HAOCHENYE) in https://github.com/open-mmlab/mmengine/pull/926
- Introduce how to set random seed by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/914
- Count FLOPs and parameters by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/939
- Enhance README by [Xiangxu-0103](https://github.com/Xiangxu-0103) in https://github.com/open-mmlab/mmengine/pull/835
- Add a document about debug tricks by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/938
- Refine the format of changelog and visualization document by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/906
- Move examples to a new directory by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/911
- Resolve warnings in sphinx build by [C1rN09](https://github.com/C1rN09) in https://github.com/open-mmlab/mmengine/pull/915
- Fix docstring by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/913
- How to set the interval parameter by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/917
- Temporarily skip errors in building pdf docs at readthedocs by [C1rN09](https://github.com/C1rN09) in https://github.com/open-mmlab/mmengine/pull/928
- Add the links of twitter, discord, medium, and youtube by [vansin](https://github.com/vansin) in https://github.com/open-mmlab/mmengine/pull/924
- Fix typo `shedule` by [Dai-Wenxun](https://github.com/Dai-Wenxun) in https://github.com/open-mmlab/mmengine/pull/936
- Fix failed URL by [zhouzaida](https://github.com/zhouzaida) in https://github.com/open-mmlab/mmengine/pull/943

New Contributors
* apacha made their first contribution in https://github.com/open-mmlab/mmengine/pull/877
* KevinNuNu made their first contribution in https://github.com/open-mmlab/mmengine/pull/887
* xcnick made their first contribution in https://github.com/open-mmlab/mmengine/pull/742
* Eiuyc made their first contribution in https://github.com/open-mmlab/mmengine/pull/922
* tonysy made their first contribution in https://github.com/open-mmlab/mmengine/pull/779
* luomaoling made their first contribution in https://github.com/open-mmlab/mmengine/pull/925
* XWHtorrentx made their first contribution in https://github.com/open-mmlab/mmengine/pull/948

**Full Changelog**: https://github.com/open-mmlab/mmengine/compare/v0.5.0...v0.6.0

Highlights

- Add `BaseInferencer` to provide a general inference interface
- Provide `ReduceOnPlateauParamScheduler` to adjust learning rate by metric
- Deprecate support for Python3.6

New Features & Enhancements

- Deprecate support for Python3.6 by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/863
- Support non-scalar type metric value by mzr1996 in https://github.com/open-mmlab/mmengine/pull/827
- Remove unnecessary calls and lazily import to speed import performance by zhouzaida in https://github.com/open-mmlab/mmengine/pull/837
- Support `ReduceOnPlateauParamScheduler` by LEFTeyex in https://github.com/open-mmlab/mmengine/pull/819
- Disable warning of subprocess launched by dataloader by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/870
- Add `BaseInferencer` to provide general interface by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/874

Bug Fixes

- Fix support for Ascend device by wangjiangben-hw in https://github.com/open-mmlab/mmengine/pull/847
- Fix `Config` cannot parse base config when there is `.` in tmp path, etc. `tmp/a.b/c` by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/856
- Fix unloaded weights will not be initialized when using `PretrainedIinit` by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/764
- Fix error package name defined in `PKG2PROJECT` by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/872

Docs

- Fix typos in `advanced_tutorials/logging.md` by RangeKing in https://github.com/open-mmlab/mmengine/pull/861
- Translate CN `train_a_gan` to EN by yaqi0510 in https://github.com/open-mmlab/mmengine/pull/860
- Update `fileio.md` by Xiangxu-0103 in https://github.com/open-mmlab/mmengine/pull/869
- Add Chinese documentation for `inferencer`. by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/884

Contributors

A total of 8 developers contributed to this release. Thanks LEFTeyex, RangeKing, yaqi0510, Xiangxu-0103, wangjiangben-hw, mzr1996, zhouzaida, HAOCHENYE.

New Contributors
* yaqi0510 made their first contribution in https://github.com/open-mmlab/mmengine/pull/860
* LEFTeyex made their first contribution in https://github.com/open-mmlab/mmengine/pull/819

**Full Changelog**: https://github.com/open-mmlab/mmengine/compare/v0.4.0...v0.5.0

Highlights

- Registry supports importing modules automatically
- Upgrade the documentation and provide the **English documentation**
- Provide `ProfileHook` to profile the running process

New Features & Enhancements

- Add `conf_path` in PetrelBackend by sunyc11 in https://github.com/open-mmlab/mmengine/pull/774
- Support multiple `--cfg-options`. by mzr1996 in https://github.com/open-mmlab/mmengine/pull/759
- Support passing arguments to `OptimWrapper.update_params` by twmht in https://github.com/open-mmlab/mmengine/pull/796
- Make `get_torchvision_model` compatible with torch 1.13 by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/793
- Support `flat_decay_mult` and fix `bias_decay_mult` of depth-wise-conv in `DefaultOptimWrapperConstructor` by RangiLyu in https://github.com/open-mmlab/mmengine/pull/771
- Registry supports importing modules automatically. by RangiLyu in https://github.com/open-mmlab/mmengine/pull/643
- Add profiler hook functionality by BayMaxBHL in https://github.com/open-mmlab/mmengine/pull/768
- Make TTAModel compatible with FSDP. by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/611

Bug Fixes

- `hub.get_model` fails on some MMCls models by C1rN09 in https://github.com/open-mmlab/mmengine/pull/784
- Fix `BaseModel.to` and `BaseDataPreprocessor.to` to make them consistent with `torch.nn.Module` by C1rN09 in https://github.com/open-mmlab/mmengine/pull/783
- Fix creating a new logger at PretrainedInit by xiexinch in https://github.com/open-mmlab/mmengine/pull/791
- Fix `ZeroRedundancyOptimizer` ambiguous error with param groups when PyTorch \< 1.12.0 by C1rN09 in https://github.com/open-mmlab/mmengine/pull/818
- Fix MessageHub set resumed key repeatedly by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/839
- Add `progress` argument to `load_from_http` by austinmw in https://github.com/open-mmlab/mmengine/pull/770
- Ensure metrics is not empty when saving best checkpoint by zhouzaida in https://github.com/open-mmlab/mmengine/pull/849

Docs

- Add `contributing.md` by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/754
- Add gif to 15 min tutorial by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/748
- Refactor documentations and translate them to English by zhouzaida in https://github.com/open-mmlab/mmengine/pull/786
- Fix document link by MambaWong in https://github.com/open-mmlab/mmengine/pull/775
- Fix typos in EN `contributing.md` by RangeKing in https://github.com/open-mmlab/mmengine/pull/792
- Translate data transform docs. by mzr1996 in https://github.com/open-mmlab/mmengine/pull/737
- Replace markdown table with html table by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/800
- Fix wrong example in `Visualizer.draw_polygons` by lyviva in https://github.com/open-mmlab/mmengine/pull/798
- Fix docstring format and rescale the images by zhouzaida in https://github.com/open-mmlab/mmengine/pull/802
- Fix failed link in registry by zhouzaida in https://github.com/open-mmlab/mmengine/pull/811
- Fix typos by shanmo in https://github.com/open-mmlab/mmengine/pull/814
- Fix wrong links and typos in docs by shanmo in https://github.com/open-mmlab/mmengine/pull/815
- Translate `save_gpu_memory.md` by xin-li-67 in https://github.com/open-mmlab/mmengine/pull/803
- Translate the documentation of hook design by zhouzaida in https://github.com/open-mmlab/mmengine/pull/780
- Fix docstring format by zhouzaida in https://github.com/open-mmlab/mmengine/pull/816
- Translate `registry.md` by xin-li-67 in https://github.com/open-mmlab/mmengine/pull/817
- Update docstring of `BaseDataElement` by Xiangxu-0103 in https://github.com/open-mmlab/mmengine/pull/836
- Fix typo by Xiangxu-0103 in https://github.com/open-mmlab/mmengine/pull/841
- Update docstring of `structures` by Xiangxu-0103 in https://github.com/open-mmlab/mmengine/pull/840
- Translate `optim_wrapper.md` by xin-li-67 in https://github.com/open-mmlab/mmengine/pull/833
- Fix link error in initialize tutorial. by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/843
- Fix table in `initialized.md` by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/844

Contributors

A total of 16 developers contributed to this release. Thanks BayMaxBHL, RangeKing, Xiangxu-0103, xin-li-67, twmht, shanmo, sunyc11, lyviva, austinmw, xiexinch, mzr1996, RangiLyu, MambaWong, C1rN09, zhouzaida, HAOCHENYE

New Contributors
* sunyc11 made their first contribution in https://github.com/open-mmlab/mmengine/pull/774
* RangeKing made their first contribution in https://github.com/open-mmlab/mmengine/pull/792
* lyviva made their first contribution in https://github.com/open-mmlab/mmengine/pull/798
* twmht made their first contribution in https://github.com/open-mmlab/mmengine/pull/796
* shanmo made their first contribution in https://github.com/open-mmlab/mmengine/pull/814
* xiexinch made their first contribution in https://github.com/open-mmlab/mmengine/pull/791

**Full Changelog**: https://github.com/open-mmlab/mmengine/compare/v0.3.2...v0.4.0

New Features & Enhancements

- Send git errors to subprocess.PIPE by austinmw in https://github.com/open-mmlab/mmengine/pull/717
- Add a common `TestRunnerTestCase` to build a Runner instance. by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/631
- Align the log by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/436
- Log the called order of hooks during training process by songyuc in https://github.com/open-mmlab/mmengine/pull/672
- Support setting `eta_min_ratio` in `CosineAnnealingParamScheduler` by cir7 in https://github.com/open-mmlab/mmengine/pull/725
- Enhance compatibility of `revert_sync_batchnorm` by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/695

Bug Fixes

- Fix `distributed_training.py` in examples by PingHGao in https://github.com/open-mmlab/mmengine/pull/700
- Format the log of `CheckpointLoader.load_checkpoint` by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/685
- Fix bug of CosineAnnealingParamScheduler by fangyixiao18 in https://github.com/open-mmlab/mmengine/pull/735
- Fix `add_graph` is not called bug by shenmishajing in https://github.com/open-mmlab/mmengine/pull/632
- Fix .pre-commit-config-zh-cn.yaml pyupgrade-repo github->gitee by BayMaxBHL in https://github.com/open-mmlab/mmengine/pull/756

Docs

- Add English docs of BaseDataset by GT9505 in https://github.com/open-mmlab/mmengine/pull/713
- Fix `BaseDataset` typo about lazy initialization by MengzhangLI in https://github.com/open-mmlab/mmengine/pull/733
- Fix typo by zhouzaida in https://github.com/open-mmlab/mmengine/pull/734
- Translate visualization docs by xin-li-67 in https://github.com/open-mmlab/mmengine/pull/692

Contributors

austinmw BayMaxBHL shenmishajing xin-li-67 songyuc PingHGao MengzhangLI cir7 GT9505 fangyixiao18 zhouzaida HAOCHENYE

Highlights

**Fix error when saving best checkpoint in ddp-training**

New Features & Enhancements

- Replace `print` with `print_log` for those functions called by runner by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/686

Docs

- Refine Chinese tutorials by Xiangxu-0103 in https://github.com/open-mmlab/mmengine/pull/694
- Add MMEval in README by sanbuphy in https://github.com/open-mmlab/mmengine/pull/669
- Fix error URL in runner docstring by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/668
- Fix error evaluator type name in `evaluator.md` by sanbuphy in https://github.com/open-mmlab/mmengine/pull/675
- Fix typo in `utils.md` sanbuphy in https://github.com/open-mmlab/mmengine/pull/702

Bug Fixes

- Fix error when saving best checkpoint in ddp-training by HAOCHENYE in https://github.com/open-mmlab/mmengine/pull/682

Contributors

Xiangxu-0103 sanbuphy HAOCHENYE

**Full Changelog**: https://github.com/open-mmlab/mmengine/compare/v0.3.0...v0.3.1