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
API Deprecate average=0 in SGD #28582
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe mention that average=False should be used (rather than average=0) in the changelog.
Other than this LGTM
BTW I think you don't need |
it's already there :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. We can merge if the doc
CI does not complain.
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=0
prevents the confusion once and for all.