Skip to content

GDPopt docstring advertises unimplemented algorithms and omits implemented ones #4017

Description

@bernalde

Summary

The GDPopt meta-solver docstring (surfaced in the online docs and in SolverFactory('gdpopt') help output) still advertises two algorithms that have never been implemented, and omits most of the algorithms that do exist.

pyomo/contrib/gdpopt/GDPopt.py:78-84:

These approaches include:

- Logic-based outer approximation (LOA)
- Logic-based branch-and-bound (LBB)
- Partial surrogate cuts [pending]
- Generalized Bender decomposition [pending]

Neither "partial surrogate cuts" nor "Generalized Benders decomposition" exists anywhere in pyomo/contrib/gdpopt/, and the two [pending] markers date back to ~2018. Meanwhile GLOA, RIC, enumerate, and LD-SDA (#3331) are implemented but not listed.

Expected behavior

The docstring lists exactly the implemented algorithms (LOA, GLOA, LBB, RIC, enumerate, LD-SDA) and drops the [pending] entries — or moves them to a roadmap/issue reference. If Benders-style decomposition for GDP is still on the roadmap, that belongs in an issue rather than in user-facing solver help.

(Minor, same file: the "Questions" pointer in the docstring may also deserve a refresh.)

Found during a GDP/MINLP roadmap audit tracked at bernalde#2; happy to submit the doc PR.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions