Skip to main content

CMA-ES, Covariance Matrix Adaptation Evolution Strategy for non-linear numerical optimization in Python

Project description

The CMA-ES is a randomized derivative-free numerical optimization algorithm for difficult (non-convex, ill-conditioned, multi-modal, rugged, noisy) optimization problems in continuous or mixed-integer search spaces, implemented in Python.

The typical domain of application are objective functions with:

  • search space dimension between five and a few hundred,

  • dependent decision variables (non-separable)

  • gradients not being available or useful,

  • at least, say, 100 times dimension function evaluations possible and needed to get a satisfactory solution,

  • ill-conditioned or rugged or multi-modal landscapes.

The handling of

  • bound constraints via the 'bounds' = [lower, upper] option or the cma.BoundDomainTransform wrapper

  • linear and nonlinear constraints via the constraints argument to fmin2 or fmin_con2

  • noise via noise_handler=True as argument to fmin2

  • integer variables for mixed-integer problems via the 'integer_variables'=index_list option

is available too. The CMA-ES is quite reliable, however for small budgets (fewer function evaluations than 100 times dimension) or in very small dimensions faster methods are available.

The pycma module provides two independent implementations of the CMA-ES algorithm in the classes cma.CMAEvolutionStrategy and a basic implementation cma.purecma.CMAES.

Installation

In the terminal command line type

python -m pip install cma

The package will be downloaded and installed automatically. To upgrade an existing installation, ‘install’ must be replaced by ‘install -U’. For the documentation of pip, see here.

Alternatively, download and unpack the cma-...tar.gz file under the above Download files link. The folder cma from the tar archive can be used without any installation (for import to find it, it must be in the current folder or the Python search paths) or can be installed by pip install -e ..

Usage Example

In a Python shell:

>>> import cma
>>> help(cma)
    <output omitted>
>>> es = cma.CMAEvolutionStrategy(8 * [0], 0.5)
(5_w,10)-aCMA-ES (mu_w=3.2,w_1=45%) in dimension 8 (seed=468976, Tue May  6 19:14:06 2014)
>>> help(es)  # the same as help(cma.CMAEvolutionStrategy)
    <output omitted>
>>> es.optimize(cma.ff.rosen)
Iterat #Fevals   function value    axis ratio  sigma  minstd maxstd min:sec
    1      10 1.042661803766204e+02 1.0e+00 4.50e-01  4e-01  5e-01 0:0.0
    2      20 7.322331708590002e+01 1.2e+00 3.89e-01  4e-01  4e-01 0:0.0
    3      30 6.048150359372417e+01 1.2e+00 3.47e-01  3e-01  3e-01 0:0.0
  100    1000 3.165939452385367e+00 1.1e+01 7.08e-02  2e-02  7e-02 0:0.2
  200    2000 4.157333035296804e-01 1.9e+01 8.10e-02  9e-03  5e-02 0:0.4
  300    3000 2.413696640005903e-04 4.3e+01 9.57e-03  3e-04  7e-03 0:0.5
  400    4000 1.271582136805314e-11 7.6e+01 9.70e-06  8e-08  3e-06 0:0.7
  439    4390 1.062554035878040e-14 9.4e+01 5.31e-07  3e-09  8e-08 0:0.8
>>> es.result_pretty()  # pretty print result
termination on tolfun=1e-11
final/bestever f-value = 3.729752e-15 3.729752e-15
mean solution: [ 1.          1.          1.          1.          0.99999999  0.99999998
  0.99999995  0.99999991]
std deviation: [  2.84303359e-09   2.74700402e-09   3.28154576e-09   5.92961588e-09
   1.07700123e-08   2.12590385e-08   4.09374304e-08   8.16649754e-08]

optimizes the 8-dimensional Rosenbrock function with initial solution all zeros and initial sigma = 0.5.

Pretty much the same can be achieved with the “one-liner”

>>> import cma
>>> xopt, es = cma.fmin2(cma.ff.rosen, 8 * [0], 0.5)
    <output omitted>

where cma.fmin2 provides also options for restarts.

The same can be run via the ask-and-tell interface which gives the user direct control over the iteration loop of the algorithm:

>>> import cma
>>> es = cma.CMAEvolutionStrategy(12 * [0], 0.5)
>>> while not es.stop():
...     solutions = es.ask()
...     es.tell(solutions, [cma.ff.rosen(x) for x in solutions])
...     es.logger.add()  # write data to disc to be plotted
...     es.disp()
    <output omitted>
>>> es.result_pretty()
    <output omitted>
>>> cma.plot()  # shortcut for es.logger.plot()
CMA-ES on Rosenbrock function in dimension 8

A single run on the 12-dimensional Rosenbrock function.

The CMAOptions class manages the options for CMAEvolutionStrategy. The options class allows for substring search. For example, verbosity options can be found like

>>> import cma
>>> cma.s.pprint(cma.CMAOptions('erb'))
{'verb_log': '1  #v verbosity: write data to files every verb_log iteration, writing can be time critical on fast to evaluate functions'
 'verbose': '1  #v verbosity e.v. of initial/final message, -1 is very quiet, not yet implemented'
 'verb_plot': '0  #v in fmin(): plot() is called every verb_plot iteration'
 'verb_disp': '100  #v verbosity: display console output every verb_disp iteration'
 'verb_filenameprefix': 'outcmaes  # output filenames prefix'
 'verb_append': '0  # initial evaluation counter, if append, do not overwrite output files'
 'verb_time': 'True  #v output timings on console'}

Options are passed as another argument, after sigma, to cma.fmin2 or cma.CMAEvolutionStrategy like

>>> import cma
>>> es = cma.CMAEvolutionStrategy(8 * [0], 0.5,
                                  {'verb_disp': 1}) # display each iteration

Documentations

The full package API documentation:

See also

Dependencies

  • required (unless for cma.purecma): numpy – array processing for numbers, strings, records, and objects

  • optional (highly recommended): matplotlib – Python plotting package (includes pylab)

Use pip install numpy etc. for installation. The cma.purecma submodule can be used without any dependencies installed.

License: BSD-3-Clause

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cma-4.4.4.tar.gz (316.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cma-4.4.4-py3-none-any.whl (328.3 kB view details)

Uploaded Python 3

File details

Details for the file cma-4.4.4.tar.gz.

File metadata

  • Download URL: cma-4.4.4.tar.gz
  • Upload date:
  • Size: 316.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for cma-4.4.4.tar.gz
Algorithm Hash digest
SHA256 632bd654b5dce04c0eaa3166679d3e4773ce7a79eab7934e7f363c341b9a8170
MD5 3f322fc6625a168ccc587a48bba41db1
BLAKE2b-256 67ac8c27720838e293898671f01b5c452236a0c74f4799a3f2d5fcccbbf50d71

See more details on using hashes here.

File details

Details for the file cma-4.4.4-py3-none-any.whl.

File metadata

  • Download URL: cma-4.4.4-py3-none-any.whl
  • Upload date:
  • Size: 328.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for cma-4.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 edb6d02eb2aac2d54650f16a8f0c70711ff17445957de7c9de92ff7fd4b7ef38
MD5 fef59ec5f3aef8154dfc6e541a74a91d
BLAKE2b-256 d4d4ec46cedab6a6145e21768baa8110db3e2e836a320d8499e4ef18bc894e61

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page