Skip to content
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

Various improvements #290

Merged
merged 12 commits into from
May 6, 2022
Merged

Various improvements #290

merged 12 commits into from
May 6, 2022

Conversation

bwohlberg
Copy link
Collaborator

Split admm and pgm modules into multiple source files for easier editing, and various other minor improvements.

@bwohlberg bwohlberg added documentation Improvements or additions to documentation standards Coding standards issues or violations typing Related to type annotations labels May 5, 2022
@codecov
Copy link

codecov bot commented May 5, 2022

Codecov Report

Merging #290 (2b35bde) into main (e2a9a4e) will increase coverage by 0.06%.
The diff coverage is 96.11%.

@@            Coverage Diff             @@
##             main     #290      +/-   ##
==========================================
+ Coverage   94.15%   94.21%   +0.06%     
==========================================
  Files          49       53       +4     
  Lines        3269     3303      +34     
==========================================
+ Hits         3078     3112      +34     
  Misses        191      191              
Flag Coverage Δ
unittests 94.21% <96.11%> (+0.06%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
scico/linop/_circconv.py 83.83% <0.00%> (ø)
scico/linop/_convolve.py 86.31% <ø> (ø)
scico/linop/_diff.py 92.68% <ø> (ø)
scico/linop/_matrix.py 95.86% <ø> (ø)
scico/optimize/_ladmm.py 98.86% <ø> (ø)
scico/optimize/_primaldual.py 100.00% <ø> (ø)
scico/optimize/_pgm.py 93.54% <93.54%> (ø)
scico/optimize/_admmaux.py 95.00% <95.00%> (ø)
scico/optimize/_admm.py 97.41% <97.41%> (ø)
scico/optimize/_pgmaux.py 99.12% <99.12%> (ø)
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e2a9a4e...2b35bde. Read the comment docs.

"Iter": "%d",
"Time": "%8.2e",
}
itstat_attrib = ["itnum", "timer.elapsed()"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This itstat initialization is always a stumbling block for me when reading the class. Could it be easily refactored into its own function/class?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps. It would probably have to be some sort of private auxiliary class rather than a general utility, but that's worth considering. I'll make a separate issue as a reminder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation standards Coding standards issues or violations typing Related to type annotations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants