mmcv
mmcv copied to clipboard
[Refactor] Use MODELS registry in `mmengine`, delete basemodule
Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.
Motivation
MMCV uses MODELS
registry defined in mmengine to register convolution, padding, upsample norm layers .etc.
The following registry will be removed in mmcv:
-
CONV_LAYERS
-
NORM_LAYERS
-
ACTIVATION_LAYERS
-
PADDING_LAYERS
-
UPSAMPLE_LAYERS
-
PLUGIN_LAYERS
-
DROPOUT_LAYERS
-
POSITIONAL_ENCODING
-
ATTENTION
-
FEEDFORWARD_NETWORK
-
TRANSFORMER_LAYER
-
TRANSFORMER_LAYER_SEQUENCE
All registries mentioned above will be removed,please use mmegine.MODELS
to register your module instead.
The original usage:
from mmcv.cnn import CONV_LAYERS
import torch.nn as nn
@CONV_LAYERS.register_module(nn.Module)
class CustomModule:
...
Now we should use MODELS
like this:
from mmengine import MODELS
@MODELS.register_module(nn.Module)
class CustomModule:
...
Modification
Please briefly describe what modification is made in this PR.
BC-breaking (Optional)
Does the modification introduce changes that break the backward-compatibility of the downstream repositories? If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.
Use cases (Optional)
If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.
Checklist
Before PR:
- [ ] I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
- [ ] Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
- [ ] Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
- [ ] New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
- [ ] The documentation has been modified accordingly, including docstring or example tutorials.
After PR:
- [ ] If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects, like MMDet or MMCls.
- [ ] CLA has been signed and all committers have signed the CLA in this PR.