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

Fixing typo in SplineProfile documentation. #1041

Merged
merged 1 commit into from
Jun 1, 2024

Conversation

tmqian
Copy link
Collaborator

@tmqian tmqian commented May 31, 2024

The function takes arguments (values, knots). The documentation says to use (params, knots). Changing params to values in docstring.

The function takes arguments (values, knots). The documentation says to
use (params, knots). Changing params to values in docstring.
@tmqian tmqian requested a review from dpanici May 31, 2024 20:57
Copy link

codecov bot commented May 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.96%. Comparing base (83f76bc) to head (339d249).
Report is 1370 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1041   +/-   ##
=======================================
  Coverage   94.96%   94.96%           
=======================================
  Files          87       87           
  Lines       21770    21770           
=======================================
  Hits        20674    20674           
  Misses       1096     1096           
Files with missing lines Coverage Δ
desc/profiles.py 97.21% <ø> (ø)

Copy link
Contributor

|             benchmark_name             |         dt(%)          |         dt(s)          |        t_new(s)        |        t_old(s)        | 
| -------------------------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
 test_build_transform_fft_lowres         |     -1.44 +/- 6.01     | -7.31e-03 +/- 3.05e-02 |  5.00e-01 +/- 2.8e-02  |  5.08e-01 +/- 1.1e-02  |
 test_build_transform_fft_midres         |     -3.73 +/- 2.48     | -2.22e-02 +/- 1.48e-02 |  5.74e-01 +/- 5.1e-03  |  5.96e-01 +/- 1.4e-02  |
 test_build_transform_fft_highres        |     -3.86 +/- 1.38     | -3.90e-02 +/- 1.40e-02 |  9.71e-01 +/- 5.6e-03  |  1.01e+00 +/- 1.3e-02  |
 test_equilibrium_init_lowres            |     -2.17 +/- 4.88     | -8.32e-02 +/- 1.87e-01 |  3.75e+00 +/- 6.4e-02  |  3.83e+00 +/- 1.8e-01  |
 test_equilibrium_init_medres            |     +5.59 +/- 8.50     | +2.38e-01 +/- 3.62e-01 |  4.50e+00 +/- 3.5e-01  |  4.26e+00 +/- 1.0e-01  |
 test_equilibrium_init_highres           |     +5.28 +/- 2.20     | +3.24e-01 +/- 1.35e-01 |  6.45e+00 +/- 9.9e-02  |  6.13e+00 +/- 9.1e-02  |
 test_objective_compile_dshape_current   |     +3.65 +/- 5.15     | +1.31e-01 +/- 1.85e-01 |  3.72e+00 +/- 3.9e-02  |  3.59e+00 +/- 1.8e-01  |
 test_objective_compile_atf              |     -0.40 +/- 3.47     | -2.86e-02 +/- 2.46e-01 |  7.06e+00 +/- 2.2e-01  |  7.09e+00 +/- 1.1e-01  |
 test_objective_compute_dshape_current   |     +1.20 +/- 2.03     | +4.28e-05 +/- 7.25e-05 |  3.62e-03 +/- 3.5e-05  |  3.58e-03 +/- 6.3e-05  |
 test_objective_compute_atf              |     -0.83 +/- 2.52     | -1.30e-04 +/- 3.94e-04 |  1.55e-02 +/- 3.6e-04  |  1.56e-02 +/- 1.6e-04  |
 test_objective_jac_dshape_current       |     -2.09 +/- 6.61     | -8.64e-04 +/- 2.73e-03 |  4.05e-02 +/- 2.4e-03  |  4.13e-02 +/- 1.4e-03  |
 test_objective_jac_atf                  |     +1.06 +/- 2.91     | +2.03e-02 +/- 5.56e-02 |  1.93e+00 +/- 3.1e-02  |  1.91e+00 +/- 4.6e-02  |
 test_perturb_1                          |     -2.62 +/- 2.68     | -3.34e-01 +/- 3.40e-01 |  1.24e+01 +/- 5.9e-02  |  1.27e+01 +/- 3.4e-01  |
 test_perturb_2                          |     +0.91 +/- 3.01     | +1.56e-01 +/- 5.18e-01 |  1.74e+01 +/- 3.2e-01  |  1.72e+01 +/- 4.0e-01  |
 test_proximal_jac_atf                   |     +0.36 +/- 0.92     | +2.65e-02 +/- 6.80e-02 |  7.40e+00 +/- 3.9e-02  |  7.38e+00 +/- 5.6e-02  |
 test_proximal_freeb_compute             |     -0.05 +/- 1.04     | -9.77e-05 +/- 1.97e-03 |  1.90e-01 +/- 1.6e-03  |  1.90e-01 +/- 1.1e-03  |
 test_proximal_freeb_jac                 |     +0.71 +/- 1.33     | +5.21e-02 +/- 9.72e-02 |  7.37e+00 +/- 7.4e-02  |  7.32e+00 +/- 6.2e-02  |

@rahulgaur104 rahulgaur104 merged commit af1951b into master Jun 1, 2024
18 checks passed
@unalmis unalmis deleted the bugfix/Spline-doc-typo branch June 4, 2024 21:04
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.

2 participants