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

Add coil objectives to docs #1125

Merged
merged 4 commits into from
Jul 12, 2024
Merged

Add coil objectives to docs #1125

merged 4 commits into from
Jul 12, 2024

Conversation

f0uriest
Copy link
Member

Adds new objectives for coil optimization to public docs.

Also fixes some minor formatting issues.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

codecov bot commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.24%. Comparing base (ac10970) to head (c0826dd).
Report is 1982 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1125   +/-   ##
=======================================
  Coverage   95.24%   95.24%           
=======================================
  Files          87       87           
  Lines       21659    21659           
=======================================
  Hits        20630    20630           
  Misses       1029     1029           
Files with missing lines Coverage Δ
desc/coils.py 97.06% <100.00%> (ø)
desc/objectives/__init__.py 100.00% <ø> (ø)
desc/objectives/_coils.py 99.13% <100.00%> (ø)

Copy link
Contributor

github-actions bot commented Jul 12, 2024

|             benchmark_name             |         dt(%)          |         dt(s)          |        t_new(s)        |        t_old(s)        | 
| -------------------------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
 test_build_transform_fft_lowres         |     -2.85 +/- 5.55     | -1.54e-02 +/- 3.00e-02 |  5.25e-01 +/- 1.5e-02  |  5.41e-01 +/- 2.6e-02  |
 test_build_transform_fft_midres         |     -1.86 +/- 2.93     | -1.14e-02 +/- 1.81e-02 |  6.05e-01 +/- 7.8e-03  |  6.16e-01 +/- 1.6e-02  |
 test_build_transform_fft_highres        |     -0.15 +/- 4.02     | -1.53e-03 +/- 4.04e-02 |  1.00e+00 +/- 3.5e-02  |  1.00e+00 +/- 2.0e-02  |
 test_equilibrium_init_lowres            |     +1.10 +/- 3.83     | +4.15e-02 +/- 1.45e-01 |  3.81e+00 +/- 1.3e-01  |  3.77e+00 +/- 5.9e-02  |
 test_equilibrium_init_medres            |     +0.10 +/- 3.48     | +4.43e-03 +/- 1.49e-01 |  4.28e+00 +/- 1.0e-01  |  4.27e+00 +/- 1.1e-01  |
 test_equilibrium_init_highres           |     -0.24 +/- 1.83     | -1.33e-02 +/- 1.04e-01 |  5.65e+00 +/- 5.2e-02  |  5.67e+00 +/- 9.0e-02  |
 test_objective_compile_dshape_current   |     -5.46 +/- 3.09     | -2.22e-01 +/- 1.25e-01 |  3.84e+00 +/- 6.6e-02  |  4.06e+00 +/- 1.1e-01  |
 test_objective_compile_atf              |     -5.08 +/- 3.36     | -4.46e-01 +/- 2.94e-01 |  8.32e+00 +/- 1.8e-01  |  8.77e+00 +/- 2.3e-01  |
 test_objective_compute_dshape_current   |     +2.25 +/- 6.16     | +2.83e-05 +/- 7.77e-05 |  1.29e-03 +/- 5.5e-05  |  1.26e-03 +/- 5.5e-05  |
 test_objective_compute_atf              |    -12.76 +/- 6.86     | -6.40e-04 +/- 3.44e-04 |  4.37e-03 +/- 1.6e-04  |  5.01e-03 +/- 3.0e-04  |
 test_objective_jac_dshape_current       |     -4.48 +/- 7.72     | -1.76e-03 +/- 3.03e-03 |  3.75e-02 +/- 2.0e-03  |  3.93e-02 +/- 2.2e-03  |
 test_objective_jac_atf                  |     -0.98 +/- 3.94     | -1.87e-02 +/- 7.48e-02 |  1.88e+00 +/- 3.1e-02  |  1.90e+00 +/- 6.8e-02  |
 test_perturb_1                          |     -6.71 +/- 2.50     | -9.80e-01 +/- 3.65e-01 |  1.36e+01 +/- 1.8e-01  |  1.46e+01 +/- 3.2e-01  |
 test_perturb_2                          |     -7.11 +/- 3.88     | -1.41e+00 +/- 7.70e-01 |  1.84e+01 +/- 2.5e-01  |  1.99e+01 +/- 7.3e-01  |
 test_proximal_jac_atf                   |     -0.12 +/- 1.08     | -8.89e-03 +/- 8.01e-02 |  7.39e+00 +/- 5.5e-02  |  7.39e+00 +/- 5.9e-02  |
 test_proximal_freeb_compute             |     -0.18 +/- 1.25     | -3.26e-04 +/- 2.24e-03 |  1.79e-01 +/- 1.6e-03  |  1.79e-01 +/- 1.6e-03  |
 test_proximal_freeb_jac                 |     -0.57 +/- 1.29     | -4.22e-02 +/- 9.61e-02 |  7.42e+00 +/- 6.4e-02  |  7.46e+00 +/- 7.2e-02  |
 test_solve_fixed_iter                   |     +0.81 +/- 9.00     | +1.22e-01 +/- 1.35e+00 |  1.52e+01 +/- 7.5e-01  |  1.50e+01 +/- 1.1e+00  |

@f0uriest f0uriest merged commit ce394ef into master Jul 12, 2024
18 checks passed
@f0uriest f0uriest deleted the rc/coil_objective_docs branch July 12, 2024 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants