Skip to content

Commit 61b2485

Browse files
committed
docs(advanced-jsosolvers): add migration note and Krylov.jl docs link for complete #145 fix
- Add migration note at top explaining subsolver_type => subsolver API change - Link to Krylov.jl documentation for subsolver algorithm details - Ensures users understand the new API and can find detailed subsolver info
1 parent cb27216 commit 61b2485

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

tutorials/advanced-jsosolvers/index.jmd

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ author: "Tangi Migot"
66

77
# Comparing subsolvers for nonlinear least squares in JSOSolvers
88

9+
Migration note (JSOSolvers ≥ 0.11): subsolvers are now selected with a Symbol via the `subsolver` keyword. Replace any old usages like `trunk(nlp, subsolver_type = CglsSolver)` with `trunk(nlp; subsolver = :cgls)`. See `JSOSolvers.trunkls_allowed_subsolvers` and `JSOSolvers.tronls_allowed_subsolvers` for the list of accepted symbols.
10+
911
This tutorial showcases some advanced features of solvers in JSOSolvers.
1012

1113
```julia
@@ -45,6 +47,7 @@ JSOSolvers.tronls_allowed_subsolvers
4547
```
4648

4749
These linear least squares solvers are implemented in the package [Krylov.jl](https://github.com/JuliaSmoothOptimizers/Krylov.jl).
50+
For detailed descriptions of each subsolver's algorithm and when to use it, see the [Krylov.jl documentation](https://jso.dev/Krylov.jl/stable/).
4851

4952
```julia
5053
using Krylov

0 commit comments

Comments
 (0)