IPOPT wrapper improvement to get more iteration information #459

kanekosh · 2025-10-02T20:40:17Z

Purpose

Modified IPOPT wrapper to get information like optimality, feasibility, barrier parameters, etc. at each iteration using cyipopt's intermediate callback
Introduced a major iteration flag to IPOPT (previously it was always set to True even for line search iterations). Note that I think the "major iteration" is the SNOPT terminology so not sure if it is appropriate to use the same for IPOPT. In the current IPOPT wrapper, I set major=True for the top-level iterations that compute new search iterations, and the line search iterations are not flagged as major.
Added an example to plot SNOPT and IPOPT's optimality and feasibility history on the hs015 problem.

Expected time until merged

No rush

Type of change

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (non-backwards-compatible fix or feature)
Code style update (formatting, renaming)
Refactoring (no functional changes, no API changes)
Documentation update
Maintenance update
Other (please describe)

Testing

Checklist

I have run ruff check and ruff format to make sure the Python code adheres to PEP-8 and is consistently formatted
I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
I have run unit and regression tests which pass locally with my changes
I have added new tests that prove my fix is effective or that my feature works
I have added necessary documentation

codecov · 2025-10-02T20:57:18Z

Codecov Report

❌ Patch coverage is 90.90909% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.70%. Comparing base (19ad2c8) to head (c8e03d2).

Files with missing lines	Patch %	Lines
pyoptsparse/pyIPOPT/pyIPOPT.py	88.88%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #459      +/-   ##
==========================================
- Coverage   86.72%   86.70%   -0.02%     
==========================================
  Files          24       24              
  Lines        3435     3460      +25     
==========================================
+ Hits         2979     3000      +21     
- Misses        456      460       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

marcomangano · 2025-10-03T16:08:32Z

@kanekosh looks like the tests are failing on stable because the Ipopt version we pin does not support one of the wrapper calls:

RuntimeError: get_current_violations only supports Ipopt version >=3.14.0 CyIpopt is compiled with version 3.13.4

I will take a look at the PR in the next few days, but this sounds like a welcome improvement!

…popt-get-conv

kanekosh · 2025-10-03T23:03:48Z

@kanekosh looks like the tests are failing on stable because the Ipopt version we pin does not support one of the wrapper calls:
RuntimeError: get_current_violations only supports Ipopt version >=3.14.0 CyIpopt is compiled with version 3.13.4
I will take a look at the PR in the next few days, but this sounds like a welcome improvement!

Thanks, I added a check on the IPOPT version so this is fixed now.

ewu63 · 2025-10-11T04:08:36Z

tests/test_hs015.py

-        optOptions = self.optOptions.pop(self.optName, None)
+        store_vars = ["alg_mod", "d_norm", "regularization_size", "ls_trials"]
+        # check IPOPT version and add more variables to save_major_iteration_variables if IPOPT>=3.14
+        ipopt_314 = False


IMO we do not need to support IPOPT<3.14 in tests, because 3.14.0 came out in 2021. We can just make sure we're installing sufficiently new versions of IPOPT in tests (I guess in Docker which we already do, and maybe we can pin in conda-forge)

I agree, but our stable Docker image still uses IPOPT 3.13.4, so we'll need to update that on the Docker side for the tests here to pass. I'll bring this up in the Docker repo.

doc/optimizers/IPOPT_options.yaml

ewu63 · 2025-10-11T04:12:49Z

tests/test_hs015.py

 from parameterized import parameterized

+try:
+    # External modules


Similarly we can get rid of this import

ewu63 · 2025-10-11T04:13:49Z

Also feel free to bump the patch version

marcomangano

I think it's fair to drop support for IPOPT 3.13 at this point, although that might count as a downstream breaking change?

marcomangano · 2025-10-13T15:58:34Z

pyoptsparse/pyOpt_optimizer.py

-        if self.name == "SNOPT":
-            hist["isMajor"] = False  # this will be updated in _snstop if it is major
+        # Save information about major iteration counting (only matters for SNOPT and IPOPT).
+        if self.name in ["SNOPT", "IPOPT"]:


Just a curiosity for the moment.. do you think intermediate could be used in the same way _snstop is used? #420 is stalled now but I wonder if we could extend similar features to IPOPT.

Yes, I think so

Yep, eventually we can reorganize and refactor that part of the logic, it's a fairly common feature for optimizers to provide a per-iteration callback functionality.

examples/hs015VarPlot.py

kanekosh · 2025-10-20T16:46:27Z

I opened a PR to update the IPOPT version in our stable docker image (https://github.com/mdolab/docker/pull/298), so once that's merged I'll remove the IPOPT 3.13 support from this PR.

kanekosh added 6 commits October 2, 2025 15:00

save IPOPT iteration histories

fc14cc5

optional parameters

8b174c6

introduce major iteration flag to IPOPT

6bd9961

docs

85c370a

test and example

a3566cd

improve error handling

efd4cac

kanekosh requested a review from a team as a code owner October 2, 2025 20:40

kanekosh requested review from ArshSaja and sanjan98 October 2, 2025 20:40

Merge branch 'main' into ipopt-get-conv

ea0d6f9

kanekosh added 3 commits October 3, 2025 18:08

check if IPOPT>=3.14

1840b5e

Merge branch 'ipopt-get-conv' of github.com:mdolab/pyoptsparse into i…

2a5f543

…popt-get-conv

remove unnecessary get_current_iterate

c688021

kanekosh and others added 2 commits October 6, 2025 10:11

Merge branch 'main' into ipopt-get-conv

90f3cf0

isort and pre-commit fixes

b7e039b

ewu63 reviewed Oct 11, 2025

View reviewed changes

kanekosh and others added 3 commits October 12, 2025 15:24

rename iter variables to follow IPOPT

a51a734

fix variable names in test

d47913e

Merge branch 'main' into ipopt-get-conv

bd940ca

marcomangano reviewed Oct 13, 2025

View reviewed changes

ewu63 reviewed Oct 19, 2025

View reviewed changes

examples/hs015VarPlot.py Outdated Show resolved Hide resolved

rename variables in hs015 plotting example

57869c6

ewu63 mentioned this pull request Oct 22, 2025

Support calling addObjective on subset of procs #465

Merged

13 tasks

kanekosh added 2 commits October 23, 2025 11:03

drop ipopt 3.13 support

dd146c6

patch version bump

fcd3708

Merge branch 'main' of github.com:mdolab/pyoptsparse into ipopt-get-conv

c8e03d2

IPOPT wrapper improvement to get more iteration information #459

Are you sure you want to change the base?

IPOPT wrapper improvement to get more iteration information #459

Uh oh!

Conversation

kanekosh commented Oct 2, 2025

Purpose

Expected time until merged

Type of change

Testing

Checklist

Uh oh!

codecov bot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

marcomangano commented Oct 3, 2025

Uh oh!

kanekosh commented Oct 3, 2025

Uh oh!

ewu63 Oct 11, 2025

Choose a reason for hiding this comment

Uh oh!

kanekosh Oct 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ewu63 Oct 11, 2025

Choose a reason for hiding this comment

Uh oh!

ewu63 commented Oct 11, 2025

Uh oh!

marcomangano left a comment

Choose a reason for hiding this comment

Uh oh!

marcomangano Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

kanekosh Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

ewu63 Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kanekosh commented Oct 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Oct 2, 2025 •

edited

Loading