Skip to main content

A flexible derivative-free solver for (bound constrained) general objective minimization

Project description

Build Status GNU GPL v3 License Latest PyPI version DOI:10.5281/zenodo.2630437 https://static.pepy.tech/personalized-badge/py-bobyqa?period=total&units=international_system&left_color=black&right_color=green&left_text=Downloads

Py-BOBYQA is a flexible package for solving bound-constrained general objective minimization, without requiring derivatives of the objective. At its core, it is a Python implementation of the BOBYQA algorithm by Powell, but Py-BOBYQA has extra features improving its performance on some problems (see the papers below for details). Py-BOBYQA is particularly useful when evaluations of the objective function are expensive and/or noisy.

More details about Py-BOBYQA and its enhancements over BOBYQA can be found in our papers:

  1. Coralia Cartis, Jan Fiala, Benjamin Marteau and Lindon Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, ACM Transactions on Mathematical Software, 45:3 (2019), pp. 32:1-32:41 [arXiv preprint: 1804.00154]

  2. Coralia Cartis, Lindon Roberts and Oliver Sheridan-Methven, Escaping local minima with derivative-free methods: a numerical investigation, Optimization, 71:8 (2022), pp. 2343-2373. [arXiv preprint: 1812.11343]

  3. Lindon Roberts, Model Construction for Convex-Constrained Derivative-Free Optimization, arXiv preprint arXiv:2403.14960 (2024).

Please cite [1] when using Py-BOBYQA for local optimization, [1,2] when using Py-BOBYQA’s global optimization heuristic functionality, and [1,3] if using the general convex constraints functionality.

The original paper by Powell is: M. J. D. Powell, The BOBYQA algorithm for bound constrained optimization without derivatives, technical report DAMTP 2009/NA06, University of Cambridge (2009), and the original Fortran implementation is available here.

If you are interested in solving least-squares minimization problems, you may wish to try DFO-LS, which has the same features as Py-BOBYQA (plus some more), and exploits the least-squares problem structure, so performs better on such problems.

Documentation

See manual.pdf or the online manual.

Citation

Full details of the Py-BOBYQA algorithm are given in our papers:

  1. Coralia Cartis, Jan Fiala, Benjamin Marteau and Lindon Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, ACM Transactions on Mathematical Software, 45:3 (2019), pp. 32:1-32:41 [preprint]

  2. Coralia Cartis, Lindon Roberts and Oliver Sheridan-Methven, Escaping local minima with derivative-free methods: a numerical investigation, Optimization, 71:8 (2022), pp. 2343-2373. [arXiv preprint: 1812.11343]

  3. Lindon Roberts, Model Construction for Convex-Constrained Derivative-Free Optimization, arXiv preprint arXiv:2403.14960 (2024).

Please cite [1] when using Py-BOBYQA for local optimization, [1,2] when using Py-BOBYQA’s global optimization heuristic functionality, and [1,3] if using the general convex constraints functionality.

Requirements

Py-BOBYQA requires the following software to be installed:

Additionally, the following python packages should be installed (these will be installed automatically if using pip, see Installation using pip):

Optional package: Py-BOBYQA versions 1.2 and higher also support the trustregion package for fast trust-region subproblem solutions. To install this, make sure you have a Fortran compiler (e.g. gfortran) and NumPy installed, then run pip install trustregion. You do not have to have trustregion installed for Py-BOBYQA to work, and it is not installed by default.

Installation using pip

For easy installation, use pip:

$ pip install Py-BOBYQA

Note that if an older install of Py-BOBYQA is present on your system you can use:

$ pip install --upgrade Py-BOBYQA

to upgrade Py-BOBYQA to the latest version.

Manual installation

Alternatively, you can download the source code from Github and unpack as follows:

$ git clone https://github.com/numericalalgorithmsgroup/pybobyqa
$ cd pybobyqa

Py-BOBYQA is written in pure Python and requires no compilation. It can be installed using:

$ pip install .

instead.

To upgrade Py-BOBYQA to the latest version, navigate to the top-level directory (i.e. the one containing setup.py) and rerun the installation using pip, as above:

$ git pull
$ pip install .

Testing

If you installed Py-BOBYQA manually, you can test your installation using the pytest package:

$ pip install pytest
$ python -m pytest --pyargs pybobyqa

Alternatively, the HTML documentation provides some simple examples of how to run Py-BOBYQA.

Examples

Examples of how to run Py-BOBYQA are given in the online documentation, and the examples directory in Github.

Uninstallation

If Py-BOBYQA was installed using pip you can uninstall as follows:

$ pip uninstall Py-BOBYQA

If Py-BOBYQA was installed manually you have to remove the installed files by hand (located in your python site-packages directory).

Bugs

Please report any bugs using GitHub’s issue tracker.

License

This algorithm is released under the GNU GPL license. Please contact NAG for alternative licensing.

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

py_bobyqa-1.5.0.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

Py_BOBYQA-1.5.0-py3-none-any.whl (58.0 kB view details)

Uploaded Python 3

File details

Details for the file py_bobyqa-1.5.0.tar.gz.

File metadata

  • Download URL: py_bobyqa-1.5.0.tar.gz
  • Upload date:
  • Size: 51.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for py_bobyqa-1.5.0.tar.gz
Algorithm Hash digest
SHA256 3c7719b68b28834ea6d538f54603f6a891263f7c21f1a673de79e3a5e0e7e413
MD5 87b9a9195267ec68344c5f7e72998608
BLAKE2b-256 6b41c4c74daf208ed27e14071e92efb7ea238ffdf77ee93a3a7777ff02d2b0e4

See more details on using hashes here.

File details

Details for the file Py_BOBYQA-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: Py_BOBYQA-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 58.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for Py_BOBYQA-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 457afc04d6f2c9f1814934854dc4e542c5e5982a0f80add4b211fcdb0b5811e3
MD5 6a8b642ae37eb3720a826f2a1a149d0f
BLAKE2b-256 f41e0d44a4e3a291c009a357fbd1d61511d9306c2c4db9a7ceb6e8104d8d385f

See more details on using hashes here.

Supported by

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