2021-12-15 19:06:36 +08:00
# Changelog
## MMSelfSup
2022-06-01 09:59:05 +08:00
### v0.9.1 (31/05/2022)
#### Highlight
- Update **BYOL** model and results ([#319 ](https://github.com/open-mmlab/mmselfsup/pull/319 ))
- Refine some documentation
#### New Features
- Update **BYOL** models and results ([#319 ](https://github.com/open-mmlab/mmselfsup/pull/319 ))
#### Bug Fixes
- Set qkv bias to False for cae and True for mae ([#303 ](https://github.com/open-mmlab/mmselfsup/pull/303 ))
- Fix spelling errors in MAE config ([#307 ](https://github.com/open-mmlab/mmselfsup/pull/307 ))
#### Improvements
- Change the file name of cosine annealing hook ([#304 ](https://github.com/open-mmlab/mmselfsup/pull/304 ))
- Replace markdownlint with mdformat ([#311 ](https://github.com/open-mmlab/mmselfsup/pull/311 ))
#### Docs
- Fix typo in tutotial ([#308 ](https://github.com/open-mmlab/mmselfsup/pull/308 ))
- Configure Myst-parser to parse anchor tag ([#309 ](https://github.com/open-mmlab/mmselfsup/pull/309 ))
- Update readthedocs algorithm README ([#310 ](https://github.com/open-mmlab/mmselfsup/pull/310 ))
- Rewrite install.md ([#317 ](https://github.com/open-mmlab/mmselfsup/pull/317 ))
- refine README.md file ([#318 ](https://github.com/open-mmlab/mmselfsup/pull/318 ))
2022-04-29 20:01:30 +08:00
### v0.9.0 (29/04/2022)
#### Highlight
2022-06-01 09:59:05 +08:00
- Support **CAE** ([#284 ](https://github.com/open-mmlab/mmselfsup/pull/284 ))
- Support **Barlow Twins** ([#207 ](https://github.com/open-mmlab/mmselfsup/pull/207 ))
2022-04-29 20:01:30 +08:00
#### New Features
2022-06-01 09:59:05 +08:00
- Support CAE ([#284 ](https://github.com/open-mmlab/mmselfsup/pull/284 ))
- Support Barlow twins ([#207 ](https://github.com/open-mmlab/mmselfsup/pull/207 ))
- Add SimMIM 192 pretrain and 224 fine-tuning results ([#280 ](https://github.com/open-mmlab/mmselfsup/pull/280 ))
- Add MAE pretrain with fp16 ([#271 ](https://github.com/open-mmlab/mmselfsup/pull/271 ))
2022-04-29 20:01:30 +08:00
#### Bug Fixes
2022-06-01 09:59:05 +08:00
- Fix args error ([#290 ](https://github.com/open-mmlab/mmselfsup/pull/290 ))
- Change imgs_per_gpu to samples_per_gpu in MAE config ([#278 ](https://github.com/open-mmlab/mmselfsup/pull/278 ))
- Avoid GPU memory leak with prefetch dataloader ([#277 ](https://github.com/open-mmlab/mmselfsup/pull/277 ))
- Fix key error bug when registering custom hooks ([#273 ](https://github.com/open-mmlab/mmselfsup/pull/273 ))
2022-04-29 20:01:30 +08:00
#### Improvements
2022-06-01 09:59:05 +08:00
- Update SimCLR models and results ([#295 ](https://github.com/open-mmlab/mmselfsup/pull/295 ))
- Reduce memory usage while running unit test ([#291 ](https://github.com/open-mmlab/mmselfsup/pull/291 ))
- Remove pytorch1.5 test ([#288 ](https://github.com/open-mmlab/mmselfsup/pull/288 ))
- Rename linear probing config file names ([#281 ](https://github.com/open-mmlab/mmselfsup/pull/281 ))
- add unit test for apis ([#276 ](https://github.com/open-mmlab/mmselfsup/pull/276 ))
2022-04-29 20:01:30 +08:00
#### Docs
2022-06-01 09:59:05 +08:00
- Fix SimMIM config link, and add SimMIM to model_zoo ([#272 ](https://github.com/open-mmlab/mmselfsup/pull/272 ))
2022-04-29 20:01:30 +08:00
2022-03-31 18:47:54 +08:00
### v0.8.0 (31/03/2022)
2022-03-10 09:32:09 +08:00
2022-03-31 18:47:54 +08:00
#### Highlight
2022-06-01 09:59:05 +08:00
- Support **SimMIM** ([#239 ](https://github.com/open-mmlab/mmselfsup/pull/239 ))
- Add **KNN** benchmark, support KNN test with checkpoint and extracted backbone weights ([#243 ](https://github.com/open-mmlab/mmselfsup/pull/243 ))
- Support ImageNet-21k dataset ([#225 ](https://github.com/open-mmlab/mmselfsup/pull/225 ))
2022-03-31 18:47:54 +08:00
#### New Features
2022-06-01 09:59:05 +08:00
- Support SimMIM ([#239 ](https://github.com/open-mmlab/mmselfsup/pull/239 ))
- Add KNN benchmark, support KNN test with checkpoint and extracted backbone weights ([#243 ](https://github.com/open-mmlab/mmselfsup/pull/243 ))
- Support ImageNet-21k dataset ([#225 ](https://github.com/open-mmlab/mmselfsup/pull/225 ))
- Resume latest checkpoint automatically ([#245 ](https://github.com/open-mmlab/mmselfsup/pull/245 ))
2022-03-31 18:47:54 +08:00
#### Bug Fixes
2022-06-01 09:59:05 +08:00
- Add seed to distributed sampler ([#250 ](https://github.com/open-mmlab/mmselfsup/pull/250 ))
- Fix positional parameter error in dist_test_svm_epoch.sh ([#260 ](https://github.com/open-mmlab/mmselfsup/pull/260 ))
- Fix 'mkdir' error in prepare_voc07_cls.sh ([#261 ](https://github.com/open-mmlab/mmselfsup/pull/261 ))
2022-03-31 18:47:54 +08:00
#### Improvements
2022-06-01 09:59:05 +08:00
- Update args format from command line ([#253 ](https://github.com/open-mmlab/mmselfsup/pull/253 ))
2022-03-31 18:47:54 +08:00
#### Docs
2022-06-01 09:59:05 +08:00
- Fix command errors in 6_benchmarks.md ([#263 ](https://github.com/open-mmlab/mmselfsup/pull/263 ))
- Translate 6_benchmarks.md to Chinese ([#262 ](https://github.com/open-mmlab/mmselfsup/pull/262 ))
2022-03-10 09:32:09 +08:00
2022-03-04 13:43:49 +08:00
### v0.7.0 (03/03/2022)
#### Highlight
2022-06-01 09:59:05 +08:00
- Support MAE ([#221 ](https://github.com/open-mmlab/mmselfsup/pull/221 ))
- Add Places205 benchmarks ([#210 ](https://github.com/open-mmlab/mmselfsup/pull/210 ))
- Add test Windows in workflows ([#215 ](https://github.com/open-mmlab/mmselfsup/pull/215 ))
2022-03-04 13:43:49 +08:00
#### New Features
2022-06-01 09:59:05 +08:00
- Support MAE ([#221 ](https://github.com/open-mmlab/mmselfsup/pull/221 ))
- Add Places205 benchmarks ([#210 ](https://github.com/open-mmlab/mmselfsup/pull/210 ))
2022-03-04 13:43:49 +08:00
#### Bug Fixes
2022-06-01 09:59:05 +08:00
- Fix config typos for rotation prediction and deepcluster ([#200 ](https://github.com/open-mmlab/mmselfsup/pull/200 ))
- Fix image channel bgr/rgb bug and update benchmarks ([#210 ](https://github.com/open-mmlab/mmselfsup/pull/210 ))
- Fix the bug when using prefetch under multi-view methods ([#218 ](https://github.com/open-mmlab/mmselfsup/pull/218 ))
- Fix tsne 'no init_cfg' error ([#222 ](https://github.com/open-mmlab/mmselfsup/pull/222 ))
2022-03-04 13:43:49 +08:00
#### Improvements
2022-06-01 09:59:05 +08:00
- Deprecate `imgs_per_gpu` and use `samples_per_gpu` ([#204 ](https://github.com/open-mmlab/mmselfsup/pull/204 ))
- Update the installation of MMCV ([#208 ](https://github.com/open-mmlab/mmselfsup/pull/208 ))
- Add pre-commit hook for algo-readme and copyright ([#213 ](https://github.com/open-mmlab/mmselfsup/pull/213 ))
- Add test Windows in workflows ([#215 ](https://github.com/open-mmlab/mmselfsup/pull/215 ))
2022-03-04 13:43:49 +08:00
#### Docs
2022-06-01 09:59:05 +08:00
- Translate 0_config.md into Chinese ([#216 ](https://github.com/open-mmlab/mmselfsup/pull/216 ))
- Reorganizing OpenMMLab projects and update algorithms in readme ([#219 ](https://github.com/open-mmlab/mmselfsup/pull/219 ))
2022-03-04 13:43:49 +08:00
2022-02-02 11:16:06 +08:00
### v0.6.0 (02/02/2022)
#### Highlight
2022-06-01 09:59:05 +08:00
- Support vision transformer based MoCo v3 ([#194 ](https://github.com/open-mmlab/mmselfsup/pull/194 ))
- Speed up training and start time ([#181 ](https://github.com/open-mmlab/mmselfsup/pull/181 ))
- Support cpu training ([#188 ](https://github.com/open-mmlab/mmselfsup/pull/188 ))
2022-02-02 11:16:06 +08:00
#### New Features
2022-06-01 09:59:05 +08:00
- Support vision transformer based MoCo v3 ([#194 ](https://github.com/open-mmlab/mmselfsup/pull/194 ))
- Support cpu training ([#188 ](https://github.com/open-mmlab/mmselfsup/pull/188 ))
2022-02-02 11:16:06 +08:00
#### Bug Fixes
2022-06-01 09:59:05 +08:00
- Fix issue ([#159 ](https://github.com/open-mmlab/mmselfsup/issues/159 ), [#160 ](https://github.com/open-mmlab/mmselfsup/issues/160 )) related bugs ([#161 ](https://github.com/open-mmlab/mmselfsup/pull/161 ))
- Fix missing prob assignment in `RandomAppliedTrans` ([#173 ](https://github.com/open-mmlab/mmselfsup/pull/173 ))
- Fix bug of showing k-means losses ([#182 ](https://github.com/open-mmlab/mmselfsup/pull/182 ))
- Fix bug in non-distributed multi-gpu training/testing ([#189 ](https://github.com/open-mmlab/mmselfsup/pull/189 ))
- Fix bug when loading cifar dataset ([#191 ](https://github.com/open-mmlab/mmselfsup/pull/191 ))
- Fix `dataset.evaluate` args bug ([#192 ](https://github.com/open-mmlab/mmselfsup/pull/192 ))
2022-02-02 11:16:06 +08:00
#### Improvements
2022-06-01 09:59:05 +08:00
- Cancel previous runs that are not completed in CI ([#145 ](https://github.com/open-mmlab/mmselfsup/pull/145 ))
- Enhance MIM function ([#152 ](https://github.com/open-mmlab/mmselfsup/pull/152 ))
- Skip CI when some specific files were changed ([#154 ](https://github.com/open-mmlab/mmselfsup/pull/154 ))
- Add `drop_last` when building eval optimizer ([#158 ](https://github.com/open-mmlab/mmselfsup/pull/158 ))
- Deprecate the support for "python setup.py test" ([#174 ](https://github.com/open-mmlab/mmselfsup/pull/174 ))
- Speed up training and start time ([#181 ](https://github.com/open-mmlab/mmselfsup/pull/181 ))
- Upgrade `isort` to 5.10.1 ([#184 ](https://github.com/open-mmlab/mmselfsup/pull/184 ))
2022-02-02 11:16:06 +08:00
#### Docs
2022-06-01 09:59:05 +08:00
- Refactor the directory structure of docs ([#146 ](https://github.com/open-mmlab/mmselfsup/pull/146 ))
- Fix readthedocs ([#148 ](https://github.com/open-mmlab/mmselfsup/pull/148 ), [#149 ](https://github.com/open-mmlab/mmselfsup/pull/149 ), [#153 ](https://github.com/open-mmlab/mmselfsup/pull/153 ))
- Fix typos and dead links in some docs ([#155 ](https://github.com/open-mmlab/mmselfsup/pull/155 ), [#180 ](https://github.com/open-mmlab/mmselfsup/pull/180 ), [#195 ](https://github.com/open-mmlab/mmselfsup/pull/195 ))
- Update training logs and benchmark results in model zoo ([#157 ](https://github.com/open-mmlab/mmselfsup/pull/157 ), [#165 ](https://github.com/open-mmlab/mmselfsup/pull/165 ), [#195 ](https://github.com/open-mmlab/mmselfsup/pull/195 ))
- Update and translate some docs into Chinese ([#163 ](https://github.com/open-mmlab/mmselfsup/pull/163 ), [#164 ](https://github.com/open-mmlab/mmselfsup/pull/164 ), [#165 ](https://github.com/open-mmlab/mmselfsup/pull/165 ), [#166 ](https://github.com/open-mmlab/mmselfsup/pull/166 ), [#167 ](https://github.com/open-mmlab/mmselfsup/pull/167 ), [#168 ](https://github.com/open-mmlab/mmselfsup/pull/168 ), [#169 ](https://github.com/open-mmlab/mmselfsup/pull/169 ), [#172 ](https://github.com/open-mmlab/mmselfsup/pull/172 ), [#176 ](https://github.com/open-mmlab/mmselfsup/pull/176 ), [#178 ](https://github.com/open-mmlab/mmselfsup/pull/178 ), [#179 ](https://github.com/open-mmlab/mmselfsup/pull/179 ))
- Update algorithm README with the new format ([#177 ](https://github.com/open-mmlab/mmselfsup/pull/177 ))
2022-02-02 11:16:06 +08:00
2021-12-16 10:12:58 +08:00
### v0.5.0 (16/12/2021)
2021-12-15 19:06:36 +08:00
#### Highlight
2022-06-01 09:59:05 +08:00
- Released with code refactor.
- Add 3 new self-supervised learning algorithms.
- Support benchmarks with MMDet and MMSeg.
- Add comprehensive documents.
2021-12-15 19:06:36 +08:00
#### Refactor
2022-06-01 09:59:05 +08:00
- Merge redundant dataset files.
- Adapt to new version of MMCV and remove old version related codes.
- Inherit MMCV BaseModule.
- Optimize directory.
- Rename all config files.
2021-12-15 19:06:36 +08:00
#### New Features
2022-06-01 09:59:05 +08:00
- Add SwAV, SimSiam, DenseCL algorithms.
- Add t-SNE visualization tools.
- Support MMCV version fp16.
2021-12-15 19:06:36 +08:00
#### Benchmarks
2022-06-01 09:59:05 +08:00
- More benchmarking results, including classification, detection and segmentation.
- Support some new datasets in downstream tasks.
- Launch MMDet and MMSeg training with MIM.
2021-12-15 19:06:36 +08:00
#### Docs
2022-06-01 09:59:05 +08:00
- Refactor README, getting_started, install, model_zoo files.
- Add data_prepare file.
- Add comprehensive tutorials.
2021-12-15 19:06:36 +08:00
## OpenSelfSup (History)
### v0.3.0 (14/10/2020)
#### Highlight
2022-06-01 09:59:05 +08:00
- Support Mixed Precision Training
- Improvement of GaussianBlur doubles the training speed
- More benchmarking results
2021-12-15 19:06:36 +08:00
#### Bug Fixes
2022-06-01 09:59:05 +08:00
- Fix bugs in moco v2, now the results are reproducible.
- Fix bugs in byol.
2021-12-15 19:06:36 +08:00
#### New Features
2022-06-01 09:59:05 +08:00
- Mixed Precision Training
- Improvement of GaussianBlur doubles the training speed of MoCo V2, SimCLR, BYOL
- More benchmarking results, including Places, VOC, COCO
2021-12-15 19:06:36 +08:00
### v0.2.0 (26/6/2020)
#### Highlights
2022-06-01 09:59:05 +08:00
- Support BYOL
- Support semi-supervised benchmarks
2021-12-15 19:06:36 +08:00
#### Bug Fixes
2022-06-01 09:59:05 +08:00
- Fix hash id in publish_model.py
2021-12-15 19:06:36 +08:00
#### New Features
2022-06-01 09:59:05 +08:00
- Support BYOL.
- Separate train and test scripts in linear/semi evaluation.
- Support semi-supevised benchmarks: benchmarks/dist_train_semi.sh.
- Move benchmarks related configs into configs/benchmarks/.
- Provide benchmarking results and model download links.
- Support updating network every several iterations.
- Support LARS optimizer with nesterov.
- Support excluding specific parameters from LARS adaptation and weight decay required in SimCLR and BYOL.
