-
Notifications
You must be signed in to change notification settings - Fork 26
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
Update API docs #920
Update API docs #920
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #920 +/- ##
=======================================
Coverage 94.71% 94.71%
=======================================
Files 86 86
Lines 21207 21207
=======================================
Hits 20086 20086
Misses 1121 1121
|
| benchmark_name | dt(%) | dt(s) | t_new(s) | t_old(s) |
| -------------------------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
test_build_transform_fft_lowres | +0.39 +/- 2.09 | +7.27e-03 +/- 3.86e-02 | 1.85e+00 +/- 3.0e-02 | 1.84e+00 +/- 2.4e-02 |
test_build_transform_fft_midres | +0.07 +/- 1.91 | +1.51e-03 +/- 3.88e-02 | 2.03e+00 +/- 3.0e-02 | 2.03e+00 +/- 2.5e-02 |
test_build_transform_fft_highres | +0.03 +/- 1.49 | +6.96e-04 +/- 3.59e-02 | 2.41e+00 +/- 2.7e-02 | 2.41e+00 +/- 2.4e-02 |
test_equilibrium_init_lowres | +0.68 +/- 0.89 | +6.83e-02 +/- 8.88e-02 | 1.01e+01 +/- 6.2e-02 | 9.99e+00 +/- 6.3e-02 |
test_equilibrium_init_medres | -1.07 +/- 2.34 | -1.15e-01 +/- 2.51e-01 | 1.06e+01 +/- 1.9e-01 | 1.07e+01 +/- 1.6e-01 |
test_equilibrium_init_highres | +0.92 +/- 1.29 | +1.15e-01 +/- 1.61e-01 | 1.26e+01 +/- 1.3e-01 | 1.25e+01 +/- 1.0e-01 |
test_objective_compile_dshape_current | +0.56 +/- 10.11 | +2.25e-02 +/- 4.04e-01 | 4.02e+00 +/- 2.8e-01 | 4.00e+00 +/- 2.9e-01 |
test_objective_compile_atf | +0.44 +/- 5.53 | +3.32e-02 +/- 4.19e-01 | 7.62e+00 +/- 3.2e-01 | 7.58e+00 +/- 2.7e-01 |
test_objective_compute_dshape_current | -1.01 +/- 4.22 | -5.45e-05 +/- 2.28e-04 | 5.36e-03 +/- 1.8e-04 | 5.42e-03 +/- 1.5e-04 |
test_objective_compute_atf | +0.50 +/- 2.88 | +1.01e-04 +/- 5.74e-04 | 2.00e-02 +/- 4.0e-04 | 1.99e-02 +/- 4.1e-04 |
test_objective_jac_dshape_current | +2.58 +/- 6.71 | +1.07e-03 +/- 2.78e-03 | 4.25e-02 +/- 1.9e-03 | 4.14e-02 +/- 2.0e-03 |
test_objective_jac_atf | -1.59 +/- 3.22 | -3.00e-02 +/- 6.08e-02 | 1.86e+00 +/- 5.2e-02 | 1.89e+00 +/- 3.1e-02 |
test_perturb_1 | -0.77 +/- 3.51 | -1.25e-01 +/- 5.68e-01 | 1.61e+01 +/- 4.2e-01 | 1.62e+01 +/- 3.8e-01 |
test_perturb_2 | +0.15 +/- 0.87 | +3.24e-02 +/- 1.84e-01 | 2.12e+01 +/- 1.0e-01 | 2.12e+01 +/- 1.5e-01 |
test_proximal_jac_atf | -1.22 +/- 1.04 | -8.84e-02 +/- 7.50e-02 | 7.16e+00 +/- 5.1e-02 | 7.25e+00 +/- 5.5e-02 |
test_proximal_freeb_compute | +1.02 +/- 0.83 | +1.27e-03 +/- 1.03e-03 | 1.26e-01 +/- 7.8e-04 | 1.24e-01 +/- 6.7e-04 |
test_proximal_freeb_jac | +1.61 +/- 2.63 | +1.11e-01 +/- 1.83e-01 | 7.05e+00 +/- 1.6e-01 | 6.94e+00 +/- 8.7e-02 | |
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.
I added a bit more detail to coils
desc.optimize.register_optimizer | ||
|
||
|
||
Grids |
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.
Do the grids belong in the "objectives" file?
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.
I figured that's how most users will interact with them - by picking a grid to evaluate an objective on. Not sure where else to put them. I deliberately didn't include Basis/Transform stuff in any of the new ones since those are more internal (though still documented in the alphabetical listing)
Resolves #907