Skip to main content

Heuristic and meta-heuristic optimisation suite in Python

Project description

FreeLunch - Meta-heuristic optimisation suite for python

Build Status codecov

Basically a dump of useful / funny metaheurisitcs with a (hopefully) simpe interface

Feeling cute might add benchmarking later idk

There are literally so many implementations of all of these so... here's one more!

Features

Optimisers

Your favourite not in the list? Feel free to add it.

  • Differential evolution freelunch.DE
  • Simulated Annealing freelunch.SA

Benchmarking functions

Tier list: TBA

  • N-dimensional Ackley function
  • N-dimensional Periodic function
  • N-dimensional Happy Cat function
  • N-dimensional Exponential function

Usage

Install with pip (req. numpy).

pip install freelunch

Import and instance your favourite meta-hueristics!

import freelunch
opt = freelunch.DE(obj=my_objective_function, bounds=my_bounds)

Return best solution only.

quick_result = opt()

Return optimum after nruns

best_of_runs = opt(nruns = n) 

Return best m solutions in np.ndarray

best_m = opt(return_m = m)

Return json friendly dict with fun metadata!

full_output = opt(full_output = True)

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

freelunch-0.0.2.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

freelunch-0.0.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file freelunch-0.0.2.tar.gz.

File metadata

  • Download URL: freelunch-0.0.2.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for freelunch-0.0.2.tar.gz
Algorithm Hash digest
SHA256 2b586b7628fd5e5708adc551813fe5547080a9e4a77b9586f6848b0f4d98258b
MD5 d20b48dd3efe002c14ff7c297521f1c2
BLAKE2b-256 d7b01ab800cb58dd84f88c08ae4b984ec45f3a585a53c48e6ff1e4ba862ca526

See more details on using hashes here.

Provenance

File details

Details for the file freelunch-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: freelunch-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post20201107 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for freelunch-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0766527e9fcdc5be2bf5416ae22dcc59c8eb5bac62e7b31310092c6894eb85c2
MD5 100569de2941bd5a19d399610b12d110
BLAKE2b-256 99411654a2b84aef69c7324d944d10c320ca58e5365d623cc1222500feac2580

See more details on using hashes here.

Provenance

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