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
Improve readability by packing frequently used variables into namedtuples. #99
Conversation
3f74ae4
to
40e5160
Compare
@rlouf could you please help diagnose the one failed test |
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #99 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 13 13
Lines 544 565 +21
Branches 31 31
=========================================
+ Hits 544 565 +21
☔ View full report in Codecov by Sentry. |
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.
These changes look great!
da_state.iterates, # log_step_size | ||
da_state.iterates_avg, # log_step_size_avg | ||
da_state.gradient_avg, | ||
da_state.shrinkage_pts, # mu |
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.
What are these comments indicating?
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.
The dual averaging state's "iterates" is represented by the log_step_size
variable and the "shrinkage_pts" is represented by the mu
variable in the context of this function. Is this correct, @rlouf ?
These updates look great; I'm ready to move forward with them. |
I will still need to look into updating the docstrings. @rlouf any thoughts on these changes? |
Merged, because these changes are already very helpful. We can add follow-ups for the docstrings and anything else. |
closes #67
Here are a few important guidelines and requirements to check before your PR can be merged:
pre-commit
is installed and set up.Don't worry, your PR doesn't need to be in perfect order to submit it. As development progresses and/or reviewers request changes, you can always rewrite the history of your feature/PR branches.
If your PR is an ongoing effort and you would like to involve us in the process, simply make it a draft PR.