gemseo / algos / opt

opt_factory module

A factory to execute optimization algorithms from their name.

class gemseo.algos.opt.opt_factory.OptimizersFactory

Bases: DriverFactory

Optimization libraries factory, see DriverFactory.

Test and import optimization library if it is available.

create(name)

Create a driver library from an algorithm name or a library name.

Parameters:

name (str) – The name of a library or algorithm.

Returns:

The driver library.

Return type:

DriverLib

execute(problem, algo_name, **options)

Execute a problem with an algorithm.

Parameters:

• problem (OptimizationProblem) – The problem to execute.

• algo_name (str) – The name of the algorithm.

• **options (Any) – The options of the algorithm.

Returns:

The optimization result.

Return type:

OptimizationResult

is_available(name)

Check the availability of a library name or algorithm name.

Parameters:

name (str) – The name of the library name or algorithm name.

Returns:

Whether the library or algorithm is available.

Return type:

bool

property algo_names_to_libraries: dict[str, str]

The mapping from the algorithm names to the libraries.

property algorithms: list[str]

The available algorithms names.

property libraries: list[str]

List the available library names in the present configuration.

Returns:

The names of the available libraries.

Examples using OptimizersFactory

Analytical test case # 2

Analytical test case # 2