API Deprecate average=0 in SGD #28582
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lesteve
approved these changes
Mar 6, 2024
|
BTW I think you don't need |
it's already there :) |
glemaitre
approved these changes
Mar 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #28389
Makes it consistent with the rest of the code base where we require true boolean for boolean parameters.
Based on the param description: "If set to an int greater than 1, averaging will begin once the total number of samples seen reaches average". When not paying enough attention, one might consider that average=0 means start averaging right away, but it's only valid for strictly positive integers. Deprecating
average=0prevents the confusion once and for all.