-
Notifications
You must be signed in to change notification settings - Fork 706
Make optimizer docstrings consistent #7891
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
Conversation
|
Hello. You may have forgotten to update the changelog!
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #7891 +/- ##
=======================================
Coverage 99.68% 99.68%
=======================================
Files 544 544
Lines 55413 55413
=======================================
Hits 55236 55236
Misses 177 177 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Looks good, thanks!
The only comment I have is that we might still be missing some default values for the parameters. Also, I noticed that sometimes we do e.g. stepsize=0.1 (float): ... while in other cases we do stepsize (float): ... (default: 0.1).
Don't know if it's worth to fix but it would be nice for consistency :)
|
@SimoneGasperini good catch! I updated the docstrings with your recommendation :) |
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.
Thanks @isaacdevlugt!
Co-authored-by: ANTH0NY <[email protected]>
Co-authored-by: ANTH0NY <[email protected]>
Context: Came up in discussing #7606
Description of the Change: Reorders the docstrings of each optimizer: (1) brief description of optimizer (2) theory if needed (3) Parameters (4) examples if needed.
Benefits: consistency
Possible Drawbacks: 🤷
Related GitHub Issues: