gemseo / algos / opt

opt_factory module

A factory to execute optimization algorithms from their name.

class gemseo.algos.opt.opt_factory.OptimizersFactory[source]

Bases: gemseo.algos.driver_factory.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 – The name of a library or algorithm.

Returns

The driver library.

execute(problem, algo_name, **options)

Execute a problem with an algorithm.

Parameters
  • problem – The problem to execute.

  • algo_name – The name of the algorithm.

  • **options – The options of the algorithm.

is_available(name)

Check the availability of a library name or algorithm name.

Parameters

name – The name of the library name or algorithm name.

Returns

Whether the library or algorithm is available.

property algo_names_to_libraries

The mapping from the algorithm names to the libraries.

property algorithms

The available algorithms names.

property libraries

List the available library names in the present configuration.

Returns

The names of the available libraries.