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

[Refactor] Change the meaning of momentum in EMA #1581

Merged
merged 13 commits into from Jan 18, 2023

Conversation

plyfager
Copy link
Collaborator

@plyfager plyfager commented Jan 6, 2023

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

For aligning with MMEngine, we change the meaning of momentum in EMA. In past, we set momentum a number close to 1. and use it to multiply with ema_weights/ average_params.
Now we set momentum to a number close to 0., and use it to multiply with source_weights/ source_params.
This will cause the following changes:

  1. The default value of momentum will be changed.
  2. The momentum in configs will be changed.
  3. The codes of EMAHook and AverageModel will be changed.

Notion:
Since RamupEMA's momentum won't be set in configs, so we only need to change the codes.

Modification

Please briefly describe what modification is made in this PR.

Who can help? @ them here!

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.
  • CLA has been signed and all committers have signed the CLA in this PR.

Copy link
Collaborator

@zengyh1900 zengyh1900 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please also add the warning in the initialize function of average_model.py

mmedit/engine/hooks/ema.py Outdated Show resolved Hide resolved
@Z-Fran Z-Fran assigned plyfager and unassigned Z-Fran Jan 9, 2023
plyfager and others added 3 commits January 9, 2023 14:38
LeoXing1996
LeoXing1996 previously approved these changes Jan 16, 2023
Copy link
Collaborator

@zengyh1900 zengyh1900 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@plyfager please fix ut.

@codecov
Copy link

codecov bot commented Jan 17, 2023

Codecov Report

Base: 87.92% // Head: 87.93% // Increases project coverage by +0.00% 🎉

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

Additional details and impacted files
@@           Coverage Diff            @@
##           dev-1.x    #1581   +/-   ##
========================================
  Coverage    87.92%   87.93%           
========================================
  Files          399      399           
  Lines        26051    26059    +8     
  Branches      4048     4051    +3     
========================================
+ Hits         22906    22914    +8     
  Misses        2240     2240           
  Partials       905      905           
Flag Coverage Δ
unittests 87.93% <100.00%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
mmedit/engine/hooks/ema.py 96.66% <100.00%> (+0.23%) ⬆️
mmedit/models/base_models/average_model.py 100.00% <100.00%> (ø)

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.

@zengyh1900 zengyh1900 merged commit 6ed0f25 into open-mmlab:dev-1.x Jan 18, 2023
@Z-Fran Z-Fran mentioned this pull request Mar 2, 2023
7 tasks
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.

None yet

4 participants