This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
Make docblocks for Gluon BatchNorm and SyncBatchNorm consistent with the code #14840
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Regarding #12681 we should now write running_mean and running_var in the docblocks. The current code is using running_mean and running_var in Gluon BatchNorm and SyncBatchNorm object constructor, but the current docblock is using moving_mean and moving_var, so the docblock should be changed to be consistent with the code to avoid user confusion.
Although we should use moving_xxx for BatchNorm according the original BatchNorm paper and our backend, we should not break our old Gluon API in minor release. I have put this into MXNet 2.0 roadmap #9686 (comment), and we will make a complete fix down the line.
Checklist
Essentials
Please feel free to remove inapplicable items for your PR.
Changes
Comments