diff --git a/README.md b/README.md index c37efeb..ebbfe7a 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,28 @@ _Yet another black-box optimization library for Python_ ## Description -Yabox is a small library for black-box (derivative free) optimization of functions. The library includes different stochastic algorithms for minimizing a function f(X), where X = {x1, ..., xN}. The function f(X) does not need to have an analytical form. +Yabox is a very small library for black-box (derivative free) optimization of functions that only depends on `numpy` and `matplotlib` for visualization. The library includes different stochastic algorithms for minimizing a function `f(X)` that does not need to have an analytical form, where `X = {x1, ..., xN}`. The current version of the library includes the Differential Evolution algorithm and a modified version for parallel evaluation. Example of minimization of the Ackley function (using Yabox and Differential Evolution): ![Ackley Function](../master/notebooks/img/ackley.gif?raw=true) +## Basic usage + +### Pre-defined functions +Yabox includes some default benchmark functions used in black-box optimization, available in the package yabox.problems. These functions also include 2D and 3D plotting capabilities: + +```python +from yabox.problems import CrossInTray +cross = CrossInTray() +cross.plot3d() +``` +![CrossInTray Function](../master/docs/images/crossintray.png?raw=true) + +### Optimization + +Example using Differential Evolution + +![Optimization example](../master/docs/images/opt_example.gif?raw=true) diff --git a/docs/images/crossintray.png b/docs/images/crossintray.png new file mode 100644 index 0000000..bdecebd Binary files /dev/null and b/docs/images/crossintray.png differ diff --git a/docs/images/opt_example.gif b/docs/images/opt_example.gif new file mode 100644 index 0000000..ae20c85 Binary files /dev/null and b/docs/images/opt_example.gif differ diff --git a/docs/images/optimization_progress.gif b/docs/images/optimization_progress.gif new file mode 100644 index 0000000..aba01e4 Binary files /dev/null and b/docs/images/optimization_progress.gif differ