Python API documentation

Python API documentation#

Release:

1.1.0

Date:

May 15, 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 configuration#

get_plib_config(plib[, verbose])

Read the current configuration of a problem library.

set_plib_config(plib, **kwargs)

Override configuration variables for a problem library.

Other tools#

show_versions()

Display useful system and dependency information.

s2mpj_load(problem_name, *args)

Load the S2MPJ problem.

s2mpj_select(options)

Select problems from the S2MPJ collection that satisfy given criteria.

pycutest_load(problem_name, **kwargs)

Load a problem from pycutest and return a Problem instance.

pycutest_select(options)

Select problems from the pycutest collection that satisfy given criteria.