Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix] _save_to_state_dict #542

Merged
merged 1 commit into from
Sep 22, 2022

Conversation

HAOCHENYE
Copy link
Collaborator

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

In OpenMMLab 1.0, mmcv should be compatible with Pytorch1.5. Since nn.Module of Pytorch1.5 does not have _non_persistent_buffers_set attribute, therefore _save_to_state_dict will save registered buffer regardless of whether persistent=True or persistent=False.

Pytorch 1.6:

    def _save_to_state_dict(self, destination, prefix, keep_vars):
        for name, param in self._parameters.items():
            if param is not None:
                destination[prefix + name] = param if keep_vars else param.detach()
        for name, buf in self._buffers.items():
            if buf is not None and name not in self._non_persistent_buffers_set:
                destination[prefix + name] = buf if keep_vars else buf.detach()
       ...

MMCV :

    def _save_to_state_dict(module, destination, prefix, keep_vars):
        for name, param in module._parameters.items():
            if param is not None:
                destination[prefix + name] = param if keep_vars else param.detach()
        for name, buf in module._buffers.items():
            if buf is not None:  # Does not check `_non_persistent_buffers_set` for compatible with pytorch1.5
                destination[prefix + name] = buf if keep_vars else buf.detach()

This leads to the runner saving unexpected buffers like data_preprocessor.std and data_preprocessor.mean.

Since the lowest supported PyTorch version of MMEngine is Pytorch1.6, we should consistent with the PyTorch implementation

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 repos?
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

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@ZwwWayne ZwwWayne merged commit 2e99ea3 into open-mmlab:main Sep 22, 2022
xcnick pushed a commit to xcnick/mmengine that referenced this pull request Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants