Skip to content

Remove Literate.jl deprecation from docs/generate.jl#1245

Merged
pkofod merged 4 commits into
JuliaNLSolvers:masterfrom
abhro:generate
May 12, 2026
Merged

Remove Literate.jl deprecation from docs/generate.jl#1245
pkofod merged 4 commits into
JuliaNLSolvers:masterfrom
abhro:generate

Conversation

@abhro
Copy link
Copy Markdown
Contributor

@abhro abhro commented Apr 12, 2026

Running julia with --depwarn=error for unrelated reasons, but figured I'd clean up this deprecation while I'm at it.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 12, 2026

Benchmark Results (Julia vlts)

Time benchmarks
master 4cacb2f... master / 4cacb2f...
multivariate/solvers/first_order/AdaMax 0.545 ± 0.01 ms 0.546 ± 0.0096 ms 0.998 ± 0.026
multivariate/solvers/first_order/Adam 0.544 ± 0.01 ms 0.544 ± 0.0099 ms 1 ± 0.026
multivariate/solvers/first_order/BFGS 0.0937 ± 0.0011 ms 0.0943 ± 0.0011 ms 0.994 ± 0.016
multivariate/solvers/first_order/ConjugateGradient 0.296 ± 0.011 ms 0.296 ± 0.01 ms 1 ± 0.05
multivariate/solvers/first_order/GradientDescent 0.784 ± 0.0051 ms 0.781 ± 0.0053 ms 1 ± 0.0094
multivariate/solvers/first_order/LBFGS 0.11 ± 0.0016 ms 0.11 ± 0.0018 ms 0.999 ± 0.021
multivariate/solvers/first_order/MomentumGradientDescent 1.47 ± 0.014 ms 1.47 ± 0.012 ms 0.997 ± 0.012
multivariate/solvers/first_order/NGMRES 0.452 ± 0.014 ms 0.454 ± 0.014 ms 0.996 ± 0.043
time_to_load 0.286 ± 0.0027 s 0.29 ± 0.00087 s 0.984 ± 0.0096
Memory benchmarks
master 4cacb2f... master / 4cacb2f...
multivariate/solvers/first_order/AdaMax 0.34 k allocs: 7.28 kB 0.34 k allocs: 7.28 kB 1
multivariate/solvers/first_order/Adam 0.34 k allocs: 7.28 kB 0.34 k allocs: 7.28 kB 1
multivariate/solvers/first_order/BFGS 0.165 k allocs: 8.92 kB 0.165 k allocs: 8.92 kB 1
multivariate/solvers/first_order/ConjugateGradient 0.497 k allocs: 25 kB 0.497 k allocs: 25 kB 1
multivariate/solvers/first_order/GradientDescent 1.31 k allocs: 0.0693 MB 1.31 k allocs: 0.0693 MB 1
multivariate/solvers/first_order/LBFGS 0.236 k allocs: 14.4 kB 0.236 k allocs: 14.4 kB 1
multivariate/solvers/first_order/MomentumGradientDescent 1.7 k allocs: 0.0752 MB 1.7 k allocs: 0.0752 MB 1
multivariate/solvers/first_order/NGMRES 1.7 k allocs: 0.143 MB 1.7 k allocs: 0.143 MB 1
time_to_load 0.153 k allocs: 14.5 kB 0.153 k allocs: 14.5 kB 1

A plot of the benchmark results has been uploaded as an artifact at .

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 12, 2026

Benchmark Results (Julia v1)

Time benchmarks
master 4cacb2f... master / 4cacb2f...
multivariate/solvers/first_order/AdaMax 0.585 ± 0.01 ms 0.586 ± 0.0097 ms 0.999 ± 0.024
multivariate/solvers/first_order/Adam 0.585 ± 0.0099 ms 0.586 ± 0.01 ms 0.999 ± 0.024
multivariate/solvers/first_order/BFGS 0.106 ± 0.0013 ms 0.107 ± 0.0013 ms 0.993 ± 0.017
multivariate/solvers/first_order/ConjugateGradient 0.176 ± 0.0035 ms 0.178 ± 0.0035 ms 0.989 ± 0.028
multivariate/solvers/first_order/GradientDescent 0.773 ± 0.0065 ms 0.78 ± 0.0089 ms 0.992 ± 0.014
multivariate/solvers/first_order/LBFGS 0.122 ± 0.002 ms 0.121 ± 0.0019 ms 1 ± 0.023
multivariate/solvers/first_order/MomentumGradientDescent 1.5 ± 0.017 ms 1.5 ± 0.017 ms 1 ± 0.016
multivariate/solvers/first_order/NGMRES 0.848 ± 0.0076 ms 0.849 ± 0.0089 ms 0.999 ± 0.014
time_to_load 0.304 ± 0.01 s 0.301 ± 0.00091 s 1.01 ± 0.034
Memory benchmarks
master 4cacb2f... master / 4cacb2f...
multivariate/solvers/first_order/AdaMax 0.354 k allocs: 7.19 kB 0.354 k allocs: 7.19 kB 1
multivariate/solvers/first_order/Adam 0.354 k allocs: 7.19 kB 0.354 k allocs: 7.19 kB 1
multivariate/solvers/first_order/BFGS 0.237 k allocs: 9.14 kB 0.237 k allocs: 9.14 kB 1
multivariate/solvers/first_order/ConjugateGradient 0.405 k allocs: 16.3 kB 0.405 k allocs: 16.3 kB 1
multivariate/solvers/first_order/GradientDescent 1.62 k allocs: 0.0654 MB 1.62 k allocs: 0.0654 MB 1
multivariate/solvers/first_order/LBFGS 0.333 k allocs: 14.4 kB 0.333 k allocs: 14.4 kB 1
multivariate/solvers/first_order/MomentumGradientDescent 1.99 k allocs: 0.0707 MB 1.99 k allocs: 0.0707 MB 1
multivariate/solvers/first_order/NGMRES 3.51 k allocs: 0.167 MB 3.51 k allocs: 0.167 MB 1
time_to_load 0.145 k allocs: 11 kB 0.145 k allocs: 11 kB 1

A plot of the benchmark results has been uploaded as an artifact at .

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.09%. Comparing base (1795512) to head (4cacb2f).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1245      +/-   ##
==========================================
- Coverage   86.15%   86.09%   -0.06%     
==========================================
  Files          44       44              
  Lines        3597     3597              
==========================================
- Hits         3099     3097       -2     
- Misses        498      500       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@abhro abhro mentioned this pull request Apr 12, 2026
@abhro abhro changed the title Update docs/generate.jl Remove Literate.jl deprecation from docs/generate.jl Apr 15, 2026
@pkofod
Copy link
Copy Markdown
Member

pkofod commented May 11, 2026

@abhro as you predicted it conflicts

@pkofod pkofod merged commit 2f86017 into JuliaNLSolvers:master May 12, 2026
13 of 14 checks passed
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