You are reading the documentation for MMSelfSup 0.x, which will soon be deprecated by the end of 2022. We recommend you upgrade to MMSelfSup 1.0.0rc versions to enjoy fruitful new features and better performance brought by OpenMMLab 2.0. Check out the changelog, code and documentation of MMSelfSup 1.0.0rc for more details.
Differences between MMSelfSup and OpenSelfSup¶
This file records differences between the newest version of MMSelfSup with older versions and OpenSelfSup.
MMSelfSup goes through a refactoring and addresses many legacy issues. It is not compatitible with OpenSelfSup, i.e. the old config files are supposed to be updated as some arguments of the class or names of the components have been modified.
The major differences are in two folds: codebase conventions, modular design.
In order to build more clear directory structure, MMSelfSup redesigns some of the modules.
MMSelfSup merges some datasets to reduce some redundant codes.
Classification, Extraction, NPID -> OneViewDataset
BYOL, Contrastive -> MultiViewDataset
data_sourcesfolder has been refactored, thus the loading function is more robust.
In addition, this part is still under refactoring, it will be released in following version.
The registry mechanism is updated. Currently, the parts under the
modelsfolder are built with a parent called
MMCV_MODELSthat is imported from
MMCV. Please check mmselfsup/models/builder.py and refer to mmcv/utils/registry.py for more details.
memoriesand some required utils. The
algorithmsintegrates the other main components to build the self-supervised learning algorithms, which is like
In OpenSelfSup, the names of
necksare kind of confused and all in one file. Now, the
necksare refactored, managed with one folder and renamed for easier understanding. Please check
mmselfsup/models/necksfor more details.
MMSelfSup renews codebase conventions as OpenSelfSup has not been updated for some time.
MMSelfSup renames all config files to use new name convention. Please refer to 0_config for more details.
In the configs, some arguments of the class or names of the components have been modified.
One algorithm name has been modified: MOCO -> MoCo
As all models’ components inherit
MMCV, the models are initialized with
init_cfg. Please use it to set your initialization. Besides,
init_weightscan also be used.
Please use new neck names to compose your algorithms, check it before write your own configs.
The normalization layers are all built with arguments
The directory of
toolsis modified, thus it has more clear structure. It has several folders to manage different scripts. For example, it has two converter folders for models and data format. Besides, the benchmark related scripts are all in
benchmarksfolder, which has the same structure as
The arguments in
train.pyhas been updated. Two major modifications are listed below.
--cfg-optionsto modify the config from cmd arguments.
--cfg-optionsto set the pretrained models.