Skip to content

Commit e613fad

Browse files
committed
docs(advanced-jsosolvers): mention TRON uses same subsolver keyword pattern with example
1 parent 221fdac commit e613fad

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

tutorials/advanced-jsosolvers/index.jmd

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,12 @@ stats = trunk(nls; subsolver = :cgls, rtol = RTOL, atol = ATOL, max_time = max_t
6262
We define a dictionary of the different solvers that will be benchmarked.
6363
We consider here four variants of TRUNK using the different subsolvers.
6464

65+
The same subsolver selection pattern applies to TRON’s least-squares specialization:
66+
67+
```julia
68+
stats_tron = tron(nls; subsolver = :lsmr, rtol = RTOL, atol = ATOL, max_time = max_time)
69+
```
70+
6571
Note on API updates: since JSOSolvers v0.11, subsolvers are selected using the keyword argument `subsolver` with a Symbol, for example `subsolver = :lsmr`. The previous form using `subsolver_type = CglsSolver` (and similar types) has been removed. The lists returned by `JSOSolvers.trunkls_allowed_subsolvers` and `JSOSolvers.tronls_allowed_subsolvers` enumerate the valid symbols you can pass.
6672

6773
```julia

0 commit comments

Comments
 (0)