Skip to content

Commit 7696041

Browse files
arnavk23tmigot
andcommitted
Fix/update subsolver api docs (JuliaSmoothOptimizers#149)
* docs(advanced-jsosolvers): update TRUNK subsolver usage to new keyword API and add note on allowed subsolvers and tolerances (fixes JuliaSmoothOptimizers#145) * docs(advanced-jsosolvers): add concise migration note (old subsolver_type => new subsolver=:symbol) * docs(intro): add migration note for subsolver API (subsolver_type => subsolver = :symbol) * docs(intro): show how to list allowed subsolvers for trunk/tron least-squares variants * docs(intro): add example of trunk with explicit subsolver and tolerances * docs(advanced-jsosolvers): add explicit trunk call with subsolver and tolerances * docs(advanced-jsosolvers): mention TRON uses same subsolver keyword pattern with example * docs: copy edits and grammar fixes in advanced and intro tutorials * test: make tutorial checks robust (require index.jmd and Project.toml only); docs: minor copy edits * docs(advanced-jsosolvers): add link to Krylov.jl docs for subsolver algorithm details * Update tutorials/advanced-jsosolvers/index.jmd Co-authored-by: Tangi Migot <[email protected]> * Update tutorials/advanced-jsosolvers/index.jmd Co-authored-by: Tangi Migot <[email protected]> * Update tutorials/introduction-to-jsosolvers/index.jmd Co-authored-by: Tangi Migot <[email protected]> * Update runtests.jl * Update index.jmd * Update index.jmd * Update index.jmd --------- Co-authored-by: Tangi Migot <[email protected]>
1 parent dbcedb2 commit 7696041

File tree

1 file changed

+8
-1
lines changed
  • tutorials/introduction-to-jsosolvers

1 file changed

+8
-1
lines changed

tutorials/introduction-to-jsosolvers/index.jmd

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ The solvers `tron` and `trunk` both have a specialized implementation for input
4444

4545
The following examples illustrate this specialization.
4646

47+
To list the allowed least-squares subsolvers for these specializations:
48+
49+
```julia
50+
JSOSolvers.trunkls_allowed_subsolvers
51+
JSOSolvers.tronls_allowed_subsolvers
52+
```
53+
4754
```julia
4855
using JSOSolvers, ADNLPModels
4956
f(x) = (x[1] - 1)^2 + 4 * (x[2] - x[1]^2)^2
@@ -111,7 +118,7 @@ solver = LBFGSSolver(nlp; mem = 5);
111118
stats = solve!(solver, nlp)
112119
```
113120

114-
The following table provides the correspondance between the solvers and the solvers structures:
121+
The following table provides the correspondence between the algorithms and their solver structures:
115122

116123
| Algorithm | Solver structure |
117124
| ------------------- | ---------------- |

0 commit comments

Comments
 (0)