Skip to content

Commit f8e7f6a

Browse files
Merge pull request #1169 from moble/patch-1
Correctly format signatures in docstrings
2 parents 617d025 + cf9293f commit f8e7f6a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/sensitivity_interface.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,9 +492,11 @@ function _adjoint_sensitivities(sol, sensealg::SteadyStateAdjoint, alg;
492492
end
493493

494494
@doc doc"""
495+
```julia
495496
H = second_order_sensitivities(loss,prob,alg,args...;
496497
sensealg=ForwardDiffOverAdjoint(InterpolatingAdjoint(autojacvec=ReverseDiffVJP())),
497498
kwargs...)
499+
```
498500
499501
Second order sensitivity analysis is used for the fast calculation of Hessian
500502
matrices.
@@ -547,9 +549,11 @@ function second_order_sensitivities(loss, prob, alg, args...;
547549
end
548550

549551
@doc doc"""
552+
```julia
550553
Hv = second_order_sensitivity_product(loss,v,prob,alg,args...;
551554
sensealg=ForwardDiffOverAdjoint(InterpolatingAdjoint(autojacvec=ReverseDiffVJP())),
552555
kwargs...)
556+
```
553557
554558
Second order sensitivity analysis product is used for the fast calculation of
555559
Hessian-vector products ``Hv`` without requiring the construction of the Hessian

0 commit comments

Comments
 (0)