Skip to main content

Simplicial homology global optimisation

Project description

.. image:: https://travis-ci.org/Stefan-Endres/shgo.svg?branch=master :target: https://travis-ci.org/Stefan-Endres/shgo .. image:: https://coveralls.io/repos/github/Stefan-Endres/shgo/badge.png?branch=master :target: https://coveralls.io/github/Stefan-Endres/shgo?branch=master

Repository: https://github.com/Stefan-Endres/shgo

Description

Finds the global minimum of a function using simplicial homology global optimisation (shgo_). Appropriate for solving general purpose NLP and blackbox optimisation problems to global optimality (low dimensional problems). The general form of an optimisation problem is given by:

.. _shgo: https://stefan-endres.github.io/shgo/

::

minimize f(x) subject to

g_i(x) >= 0,  i = 1,...,m
h_j(x)  = 0,  j = 1,...,p

where x is a vector of one or more variables. f(x) is the objective function R^n -> R, g_i(x) are the inequality constraints. h_j(x) are the equality constrains.

Installation

Stable:

.. code::

$ pip install shgo

Latest:

.. code::

$ git clone https://github.com/Stefan-Endres/shgo
$ cd shgo
$ python setup.py install
$ python setup.py test

Documentation

The project website https://stefan-endres.github.io/shgo/ contains more detailed examples, notes and performance profiles.

Quick example

Consider the problem of minimizing the Rosenbrock function. This function is implemented in rosen in scipy.optimize

.. code:: python

>>> from scipy.optimize import rosen
>>> from shgo import shgo
>>> bounds = [(0,2), (0, 2), (0, 2), (0, 2), (0, 2)]
>>> result = shgo(rosen, bounds)
>>> result.x, result.fun
(array([ 1.,  1.,  1.,  1.,  1.]), 2.9203923741900809e-18)

Note that bounds determine the dimensionality of the objective function and is therefore a required input, however you can specify empty bounds using None or objects like numpy.inf which will be converted to large float numbers.

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

shgo-0.5.0.tar.gz (346.5 kB view details)

Uploaded Source

Built Distribution

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

shgo-0.5.0-py2.py3-none-any.whl (665.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file shgo-0.5.0.tar.gz.

File metadata

  • Download URL: shgo-0.5.0.tar.gz
  • Upload date:
  • Size: 346.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for shgo-0.5.0.tar.gz
Algorithm Hash digest
SHA256 91ed7d6253ee2ba0aad8683b0bc5a93511770b4db6b08e23ec5a2e24399bde7b
MD5 0b546bcd5576c65c64112b50960ad980
BLAKE2b-256 04e5d8a4fbed7daff6249d14bde9ea951d3aa6dce8342540ed8c83eb7439978c

See more details on using hashes here.

File details

Details for the file shgo-0.5.0-py2.py3-none-any.whl.

File metadata

  • Download URL: shgo-0.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 665.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for shgo-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3a2dd2a3ee195df5d8ccc8a43765984b9273911ca09f47223ed799d53a342d4b
MD5 eb5b47bc47289ffb116cd92668c871b0
BLAKE2b-256 de906d711e4231ddaba3a13cdbe295d32828d12ac553cdc54eb9b027dd62bc2f

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