DESC icon indicating copy to clipboard operation
DESC copied to clipboard

Add uv project install instructions to docs

Open cfe316 opened this issue 7 months ago • 2 comments

Resolves #1680 .

This method is under the On Your Local Machine section but it also works on clusters.

I'm not sure how to preview any documentation. Is there a way?

cfe316 avatar Apr 28 '25 20:04 cfe316

running the command make html in the docs folder should make the docs locally and you can view them in the docs/_build folder (I think)

but you can a so just wait for the docs action to complete here and check it there

dpanici avatar Apr 28 '25 20:04 dpanici

Memory benchmark result

|               Test Name                |      %Δ      |    Master (MB)     |      PR (MB)       |    Δ (MB)    |    Time PR (s)     |  Time Master (s)   |
| -------------------------------------- | ------------ | ------------------ | ------------------ | ------------ | ------------------ | ------------------ |
  test_objective_jac_w7x                 |    4.70 %    |     3.778e+03      |     3.955e+03      |    177.40    |       31.94        |       29.43        |
  test_proximal_jac_w7x_with_eq_update   |    0.29 %    |     6.677e+03      |     6.696e+03      |    19.25     |       161.55       |       159.94       |
  test_proximal_freeb_jac                |   -0.23 %    |     1.328e+04      |     1.325e+04      |    -30.83    |       77.14        |       72.31        |
  test_proximal_freeb_jac_blocked        |   -0.61 %    |     8.046e+03      |     7.996e+03      |    -49.40    |       66.69        |       66.29        |
  test_proximal_freeb_jac_batched        |    0.26 %    |     8.022e+03      |     8.042e+03      |    20.77     |       66.09        |       68.12        |
  test_proximal_jac_ripple               |   -0.87 %    |     7.571e+03      |     7.505e+03      |    -65.88    |       69.61        |       71.13        |
  test_proximal_jac_ripple_spline        |    0.38 %    |     3.504e+03      |     3.517e+03      |    13.45     |       74.53        |       77.47        |
  test_eq_solve                          |   -0.70 %    |     1.996e+03      |     1.982e+03      |    -13.98    |       124.00       |       124.69       |

For the memory plots, go to the summary of Memory Benchmarks workflow and download the artifact.

github-actions[bot] avatar May 07 '25 19:05 github-actions[bot]

@cfe316 I have some minor comments, but since uv is relatively new, I think it is worth having some additional explanations.

YigitElma avatar May 20 '25 02:05 YigitElma