[Depends on #3701] Add tests for trivial constraints in pyomo/contrib/solver #3703

michaelbynum · 2025-08-14T00:08:48Z

Summary/Motivation:

This PR adds a test for trivial constraints (both feasible and infeasible) to the new solver tests. It also fixes some related bugs.

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

I agree my contributions are submitted under the BSD license.
I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

…into solver_api

…into observer_gurobi_refactor

codecov · 2025-08-14T05:41:41Z

Codecov Report

❌ Patch coverage is 88.79813% with 192 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.94%. Comparing base (2ca7dfb) to head (ecd602d).
⚠️ Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
...contrib/solver/solvers/gurobi/gurobi_persistent.py	89.25%	86 Missing ⚠️
pyomo/contrib/observer/model_observer.py	90.08%	49 Missing ⚠️
pyomo/contrib/solver/common/solution_loader.py	72.30%	18 Missing ⚠️
...ontrib/solver/solvers/gurobi/gurobi_direct_base.py	89.58%	15 Missing ⚠️
...omo/contrib/solver/solvers/gurobi/gurobi_direct.py	93.54%	8 Missing ⚠️
pyomo/contrib/solver/solvers/sol_reader.py	63.15%	7 Missing ⚠️
pyomo/contrib/solver/solvers/highs.py	70.58%	5 Missing ⚠️
pyomo/contrib/observer/component_collector.py	94.28%	2 Missing ⚠️
pyomo/contrib/solver/solvers/ipopt.py	77.77%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #3703    +/-   ##
========================================
  Coverage   85.94%   85.94%            
========================================
  Files         892      895     +3     
  Lines      103018   103738   +720     
========================================
+ Hits        88535    89158   +623     
- Misses      14483    14580    +97

Flag	Coverage Δ
builders	`26.76% <23.80%> (+0.02%)`	⬆️
default	`85.77% <88.79%> (?)`
expensive	`34.04% <23.92%> (?)`
linux	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

eminyouskn · 2025-08-14T13:25:36Z

pyomo/contrib/solver/solvers/gurobi/gurobi_persistent.py

+        return self.var_map[self.v2id]
+
+
+class GurobiDirectQuadratic(GurobiDirectBase):


Shouldn't this class be named GurobiConsistentQuadratic? In GurobiObserver this is the used name.

I'm confused. Can you point me to to the place in GurobiObserver you are referring to?

I was referring to the field opt of the class _GurobiObserver.

This class does not use the observer. This one is not persistent. Maybe I am missing something?

Sorry, maybe I wasn’t clear enough. From what I see, in _GurobiObserver you are requesting opt as a GurobiPersistantQuadratic, but this class doesn’t appear to be defined. However, GurobiPersistant inherits from GurobiDirectQuadratic and is what gets passed to _GurobiObserver. So either I’m missing something, or there’s a naming issue.

Good catch! Thank you. The observer is expecting GurobiPersistent not GurobiPersistentQuadratic. I will fix that.

eminyouskn · 2025-08-14T14:04:33Z

pyomo/contrib/solver/solvers/gurobi/gurobi_persistent.py

+        self._solver_model.setObjective(gurobi_expr + repn_constant, sense=sense)
+
+
+class _GurobiObserver(Observer):


Since this class is just calling the "same" functions on the opt field. Why not just inherits Observer in GurobiPersistantSolver?

It has to be done this way in order for "manual mode" of the persistent solvers to work. If someone calls opt.add_constraint directly on the solver interface, we need the observer to be updated so things stay synchronized.

You’re probably right, and I might be missing something. However, I don’t see why adding Observer as a superclass of GurobiPersistent wouldn't mean the observer is always updated, since it’s essentially the same as the persistent object.

The important thing is that the _change_detector methods get called. This makes my head hurt a little. Let me think on it.

So if we did something like

class GurobiPersistent(GurobiDirectQuadratic, Observer): def add_constraints(self, cons): self._change_detector.add_constraints(cons)

Then there would not be a way to call _add_constraints. It would just be an infinte loop. If GurobiPersistent.add_constraints gets called, it would call the _change_detector, and the _change_detector would again call add_constraints on the observer, which is GurobiPersistent.add_constraints.

That is convoluted, but did it make any sense?

With the current design, this will always happen: the solver calls the detector, which calls the observer, which in turn calls the solver (Opt) again. Or am I missing something?

If GurobiPersistent.add_constraints gets called, then that will call ModelChangeDetector.add_constraints, which will then call _GurobiObserver.add_constraints, which then calls GurobiPersistent._add_constraints and not GurobiPersistent.add_constraints. Very subtle but important difference there. However, this conversation is making me realize how convoluted this is. Maybe someone has a better idea?

Okay, understood! One possible fix would be to give all Observer functions a common prefix (e.g., on_*) and make GurobiPersistantSolver a subclass of Observer. We could then reimplement the functions accordingly.

eminyouskn · 2025-08-17T13:14:49Z

pyomo/contrib/solver/common/solution_loader.py

+        raise NoSolutionError()
+
+    def load_vars(
+        self, vars_to_load: Sequence[VarData] | None = None, solution_id=None


Shouldn't we use Optional here?

michaelbynum and others added 30 commits May 18, 2025 09:14

working on a model observer

f2066ea

Merge remote-tracking branch 'origin/main' into observer

897c0ef

working on a model observer

97aeb31

working on model change detector

a69d5e6

observer

9763e9a

working on a model observer

ff635b8

updating solution loader

b57ab07

refactoring gurobi interfaces

070811d

Merge branch 'main' into observer_gurobi_refactor

27a3a14

revert_gurobi_persistent

d70dbb5

refactoring gurobi interfaces

5b1d3f9

refactoring gurobi interfaces

4818130

Apply black

db0fda4

Merge remote-tracking branch 'origin/main' into observer

149ab06

adding copyright statements

42c8cc8

refactoring gurobi interfaces

7998fda

Merge branch 'main' into observer

ccb6de4

refactoring gurobi interfaces

909be88

bugs

862c387

refactoring gurobi interfaces

8f7a61e

remove unused imports

92fa4f5

run black

8a9fc46

update solution loader

7249b19

Merge remote-tracking branch 'origin/main' into solver_api

710807b

Merge branch 'main' into observer_gurobi_refactor

25c48e7

Merge remote-tracking branch 'michaelbynum/observer_gurobi_refactor' …

438b9b5

…into solver_api

Merge branch 'main' into observer

d718e9a

updating solution loader

ac42345

Merge remote-tracking branch 'origin/main' into observer_gurobi_refactor

df56887

run black

275d848

michaelbynum added 15 commits August 12, 2025 17:43

Merge remote-tracking branch 'michaelbynum/observer_gurobi_refactor' …

cfa8633

…into observer_gurobi_refactor

updating solution loader

70ca6e7

dont free gurobi models twice

1788ff3

Merge branch 'observer_gurobi_refactor' into solver_api

5ec0421

update solution loader

2885f42

typo

23ba4d9

Merge remote-tracking branch 'michaelbynum/observer' into observer

14f928b

update observer tests

d7b9918

run black

c313fe5

adding tests for trivial constraints and fixing bugs

d16bee5

merge observer

873f176

Merge branch 'observer_gurobi_refactor' into solver_api

c62a7b3

run black

a4e2b81

Merge branch 'solver_api' into trivial_constraints

2001d15

run black

d25e721

eminyouskn reviewed Aug 14, 2025

View reviewed changes

michaelbynum added 6 commits August 16, 2025 09:30

forgot to inherit from PersistentSolverBase

a43a38b

merge in observer_gurobi_refactor

1750fc5

Merge branch 'solver_api' into trivial_constraints

02f383d

bug

e76baae

Merge branch 'observer_gurobi_refactor' into solver_api

413d63d

Merge branch 'solver_api' into trivial_constraints

3d302a1

eminyouskn reviewed Aug 17, 2025

View reviewed changes

michaelbynum added 3 commits August 18, 2025 09:13

bug

c2a0177

Merge branch 'observer_gurobi_refactor' into solver_api

0bbdd70

Merge branch 'solver_api' into trivial_constraints

ecd602d

		return self.var_map[self.v2id]


		class GurobiDirectQuadratic(GurobiDirectBase):

		self._solver_model.setObjective(gurobi_expr + repn_constant, sense=sense)


		class _GurobiObserver(Observer):

[Depends on #3701] Add tests for trivial constraints in pyomo/contrib/solver #3703

Are you sure you want to change the base?

[Depends on #3701] Add tests for trivial constraints in pyomo/contrib/solver #3703

Conversation

michaelbynum commented Aug 14, 2025

Summary/Motivation:

Legal Acknowledgement

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Aug 14, 2025 •

edited

Loading