Python API documentation

Python API documentation#

Release:

1.3.4

Date:

September 04, 2026

This section references the Python API of OptiProfiler. It contains the detailed documentation of the main function and classes in OptiProfiler. For installation or simple usage examples, please refer to the User guide.

Main function for most users#

benchmark([solvers])

Benchmark optimization solvers on a set of problems with specified features.

Main classes#

Problem(fun, x0[, name, xl, xu, aub, bub, ...])

Optimization problem to be used in the benchmarking.

Feature(name, **feature_options)

Mapping from an optimization problem to a new one with specified features.

FeaturedProblem(problem, feature, max_eval)

Subclass of Problem that equips an optimization problem with a feature.

Problem-library protocol#

ProblemLibraryPlugin(name, api_version, ...)

Versioned interface implemented by a problem-library adapter.

list_problem_libraries([...])

List discoverable libraries without importing optional dependencies.

Problem library configuration#

get_plib_config(plib[, verbose, ...])

Read the effective process-level configuration of a problem library.

set_plib_config(plib, *[, ...])

Set process-level default overrides for one problem library.

Other tools#

show_versions()

Display useful system and dependency information.

s2mpj_load(problem_name, *args[, ...])

Convert an S2MPJ problem name to a Problem instance.

s2mpj_select(options[, library_options])

Select problems from S2MPJ that satisfy given criteria.

External provider APIs are documented by their independently installed packages: PyCUTEst, SOLAR, and experimental RS13. See Python problem libraries for their development installation and uninstall boundaries.