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

[Enhancement] Deprecate _save_to_state_dict implemented in mmengine #610

Merged
merged 5 commits into from
Oct 28, 2022

Conversation

HAOCHENYE
Copy link
Collaborator

@HAOCHENYE HAOCHENYE commented Oct 14, 2022

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

Make get_state_dict directly call nn.Module._save_to_state_dict. Since #542 has been merged, there is no different between nn.Module._save_to_state_dict and mmengine.runner.checkpoint._save_to_state_dict.

After merging this PR, downstream repos can override ._save_to_state_dict to customize how to save checkpoint

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.

@HAOCHENYE HAOCHENYE changed the title [Refine] Make get_state_dict directly call nn.Module._save_to_state_dict. [Refine] Make get_state_dict directly call nn.Module._save_to_state_dict rather than mmengine.runner.checkpoint._save_to_state_dict. Oct 14, 2022
@C1rN09
Copy link
Collaborator

C1rN09 commented Oct 17, 2022

Should we remove _save_to_state_dict function? Or maybe add a deprecation warning?

@HAOCHENYE HAOCHENYE added this to the 0.3.0 milestone Oct 27, 2022
@HAOCHENYE HAOCHENYE added the enhancement New feature or request label Oct 27, 2022
@codecov
Copy link

codecov bot commented Oct 27, 2022

Codecov Report

Base: 78.45% // Head: 78.43% // Decreases project coverage by -0.02% ⚠️

Coverage data is based on head (60b84e1) compared to base (bf369da).
Patch coverage: 100.00% of modified lines in pull request are covered.

❗ Current head 60b84e1 differs from pull request most recent head d3c4554. Consider uploading reports for the commit d3c4554 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #610      +/-   ##
==========================================
- Coverage   78.45%   78.43%   -0.03%     
==========================================
  Files         126      126              
  Lines        9141     9141              
  Branches     1818     1818              
==========================================
- Hits         7172     7170       -2     
- Misses       1656     1660       +4     
+ Partials      313      311       -2     
Flag Coverage Δ
unittests 78.43% <100.00%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mmengine/utils/__init__.py 100.00% <ø> (ø)
mmengine/runner/checkpoint.py 43.95% <100.00%> (-0.68%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

zhouzaida
zhouzaida previously approved these changes Oct 27, 2022
@zhouzaida
Copy link
Collaborator

Suggest updating the PR message to describe that some downstream repos need to override this method to custom how to save checkpoints.

@zhouzaida zhouzaida changed the title [Refine] Make get_state_dict directly call nn.Module._save_to_state_dict rather than mmengine.runner.checkpoint._save_to_state_dict. [Enhancement] Deprecate _save_to_state_dict in mmengine Oct 28, 2022
@zhouzaida zhouzaida changed the title [Enhancement] Deprecate _save_to_state_dict in mmengine [Enhancement] Deprecate _save_to_state_dict implemented in mmengine Oct 28, 2022
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
@zhouzaida zhouzaida merged commit 4aad15d into open-mmlab:main Oct 28, 2022
ly015 pushed a commit to ly015/mmengine that referenced this pull request Nov 9, 2022
…pen-mmlab#610)

* [Refine] Make get_state_dict directly call nn.Module._save_to_state_dict

* deprecate _save_to_state_dict

* deprecate _save_to_state_dict in 0.5.0

* deprecate in 0.3.0

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants