Skip to content

Conversation

@arnavk23
Copy link
Contributor

@arnavk23 arnavk23 commented Oct 18, 2025

(fixes #145)

  • Add migration note showing old subsolver_type => new subsolver=:symbol API
  • Update solver dictionary examples to use subsolver = :cgls, :crls, :lsqr, :lsmr
  • Add explicit TRUNK and TRON examples with subsolver, rtol, atol, max_time
  • Add reference to JSOSolvers allowed_subsolvers lists
  • Link to Krylov.jl docs for subsolver algorithm details
  • Fix grammar and copy edits (heading, wording, plurals)

New tutorial
Updates to tutorial

…eyword API (fixes JuliaSmoothOptimizers#145)

- Add migration note showing old subsolver_type => new subsolver=:symbol API
- Update solver dictionary examples to use subsolver = :cgls, :crls, :lsqr, :lsmr
- Add explicit TRUNK and TRON examples with subsolver, rtol, atol, max_time
- Add reference to JSOSolvers allowed_subsolvers lists
- Link to Krylov.jl docs for subsolver algorithm details
- Fix grammar and copy edits (heading, wording, plurals)
@arnavk23
Copy link
Contributor Author

@tmigot please review.

@arnavk23 arnavk23 changed the title docs(advanced-jsosolvers): update TRUNK/TRON subsolver usage to new keyword API update TRUNK/TRON subsolver usage to new keyword API Oct 18, 2025
@arnavk23
Copy link
Contributor Author

@tmigot please see the checks below.

@tmigot tmigot closed this Oct 20, 2025
@tmigot tmigot reopened this Oct 20, 2025
… for complete JuliaSmoothOptimizers#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
- Filter out non-directory items (like files in scripts/)
- Only check for index.jmd and Project.toml (not generated files)
- Fixes test suite that was failing on both main and fix branches
@arnavk23
Copy link
Contributor Author

@tmigot worked on the failing test of the previous pr.

arnavk23 and others added 3 commits October 21, 2025 16:25
The previous changes attempted to use `subsolver = :symbol` API which doesn't exist in JSOSolvers 0.11.
Testing confirmed that JSOSolvers 0.11 uses `subsolver_type = Type` (e.g., CglsSolver, LsmrSolver).
This commit reverts to the correct working API that is compatible with JSOSolvers 0.11.2.
- Update JSOSolvers from 0.11 to 0.14 in Project.toml files
- Update Krylov from 0.9 to 0.10 (required by JSOSolvers 0.14)
- Replace Type-based subsolver API with Symbol-based API:
  * subsolver_type = CglsSolver → subsolver = :cgls
  * subsolver_type = LsmrSolver → subsolver = :lsmr
  * etc.
- Remove Krylov.jl import (no longer needed for subsolver types)
- Remove compatibility note about JSOSolvers 0.11

This addresses issue JuliaSmoothOptimizers#145 by updating to the new subsolver API
introduced in JSOSolvers 0.14.0.

Affected tutorials:
- tutorials/advanced-jsosolvers/
- tutorials/introduction-to-jsosolvers/

Tests: All package tests pass ✓
@arnavk23 arnavk23 requested a review from tmigot October 21, 2025 11:36
Copy link
Member

@tmigot tmigot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arnavk23 have you tested that the scripts work?

@arnavk23 arnavk23 force-pushed the fix/advanced-jsosolvers-subsolver-api branch from d00a69b to e8cb911 Compare October 21, 2025 22:33
The version badge on the site is derived from the local Project.toml,
so we test against tutorials/introduction-to-jsosolvers/Project.toml.
This change guarantees the constants are referenced after importing
JSOSolvers (v0.14+ Symbol subsolver API).
@tmigot tmigot changed the title update TRUNK/TRON subsolver usage to new keyword API Bump JSOSolvers to 0.14 and Krylov to 0.10 in jso solvers tutorials Oct 21, 2025
Removed unnecessary code block delimiters from documentation.
Updated import statements to include ADNLPModels with JSOSolvers.
@arnavk23 arnavk23 requested a review from tmigot October 21, 2025 22:53
@tmigot tmigot changed the title Bump JSOSolvers to 0.14 and Krylov to 0.10 in jso solvers tutorials Bump JSOSolvers to 0.14 and in JSOSolvers tutorials Oct 23, 2025
@tmigot tmigot merged commit 431abfd into JuliaSmoothOptimizers:main Oct 23, 2025
7 of 8 checks passed
@arnavk23 arnavk23 deleted the fix/advanced-jsosolvers-subsolver-api branch October 23, 2025 22:01
tmigot added a commit that referenced this pull request Oct 24, 2025
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.

Update advanced-jsosolvers tutorial to reflect new solver calls

2 participants