Skip to main content

Lightweight Covariance Matrix Adaptation Evolution Strategy (CMA-ES) implementation for Python 3.

Project description

CMA-ES

Lightweight Covariance Matrix Adaptation Evolution Strategy (CMA-ES) [1] implementation.

visualize-six-hemp-camel

Himmelblau function.

visualize-himmelblau

Rosenbrock function.

visualize-rosenbrock

Quadratic function.

visualize-quadratic

These GIF animations are generated by visualizer.py.

Installation

Supported Python versions are 3.6 or later.

$ pip install cmaes

Usage

This library provides two interfaces that an Optuna's sampler interface and a low-level interface. I recommend you to use this library via Optuna.

Optuna's sampler interface

Optuna [2] is an automatic hyperparameter optimization framework. Optuna officially implements a sampler based on pycma. It achieves almost the same performance. But this library is faster and simple.

import optuna
from cmaes.sampler import CMASampler

def objective(trial: optuna.Trial):
    x1 = trial.suggest_uniform("x1", -4, 4)
    x2 = trial.suggest_uniform("x2", -4, 4)
    return (x1 - 3) ** 2 + (10 * (x2 + 2)) ** 2

if __name__ == "__main__":
    sampler = CMASampler()
    study = optuna.create_study(sampler=sampler)
    study.optimize(objective, n_trials=250)

Note that CMASampler doesn't support categorical distributions. Although pycma's sampler supports categorical distributions, it also has a problem (especially on high-cardinality categorical distribution). If your search space contains a categorical distribution, please use TPESampler.

Low-level interface

import numpy as np
from cmaes import CMA

def quadratic(x1, x2):
    return (x1 - 3) ** 2 + (10 * (x2 + 2)) ** 2

if __name__ == "__main__":
    cma_es = CMA(mean=np.zeros(2), sigma=1.3)

    for generation in range(50):
        solutions = []
        for _ in range(cma_es.population_size):
            x = cma_es.ask()
            value = quadratic(x[0], x[1])
            solutions.append((x, value))
            print(f"#{generation} {value} (x1={x[0]}, x2 = {x[1]})")
        cma_es.tell(solutions)

Benchmark results

Algorithm's efficiency

Rosenbrock function Six-Hemp Camel function
rosenbrock six-hemp-camel

This implementation (green) stands comparison with pycma (blue). See benchmark for details.

Execution Speed

trials/params storage pycma's sampler this library
100 / 5 memory 4.976 sec (+/- 0.596) 0.197 sec (+/- 0.078)
500 / 5 memory 71.651 sec (+/- 3.847) 0.656 sec (+/- 0.044)
500 / 50 memory 291.002 sec (+/- 5.010) 1.981 sec (+/- 0.041)
100 / 5 sqlite 16.143 sec (+/- 3.487) 11.843 sec (+/- 1.390)
500 / 5 sqlite 129.436 sec (+/- 6.279) 43.735 sec (+/- 2.676)
500 / 50 sqlite 397.084 sec (+/- 6.618) 150.531 sec (+/- 1.113)

This script was run on my laptop with --times 4. So the times should not be taken precisely. Even though, it is clear that this library is extremely faster than Optuna's pycma sampler (with Optuna v1.0.0 and pycma v2.7.0).

Links

Other libraries:

I respect all libraries involved in CMA-ES.

  • pycma : Most famous CMA-ES implementation by Nikolaus Hansen.
  • cma-es : A Tensorflow v2 implementation.

References:

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

cmaes-0.3.1.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

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

cmaes-0.3.1-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file cmaes-0.3.1.tar.gz.

File metadata

  • Download URL: cmaes-0.3.1.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.8.1

File hashes

Hashes for cmaes-0.3.1.tar.gz
Algorithm Hash digest
SHA256 ecb8bca76346b29b55de37ede37c7c9f7e7b4ff1962255f84cc9d297f0b0eecc
MD5 d4f566834fb35e2f0067294745b6747c
BLAKE2b-256 98c5fb8ac85b96b624756f4e18e68c65b4bbe18c1cf1600a4259af16aaeeb3e7

See more details on using hashes here.

File details

Details for the file cmaes-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: cmaes-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.8.1

File hashes

Hashes for cmaes-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e9cd879efdd6e424beb36476c315730b2db2c9510f51f22e1766412f5da34e40
MD5 a6263fc94a2415e142e9a98fcf8910c7
BLAKE2b-256 0f11bb470a06eaffaa03775dde0707ca0b8479cbcf7ff97272aaa3c82bd7e065

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