Skip to main content

A collection of useful heuristic based optimization algorithms.

Project description

Krug

This package contains a flexible implementation of simulated annealing and genetic algorithms. It's possible that particle swarm optimization may also be added in the future.

Simulated Annealing

Background

Simulated annealing is a random algorithm that attempts to minimize an objective function. It does this by tweaking the current best solution slightly and determining if it is better or not. If it is better, the tweaked version becomes the the current best solution. If it isn't, it still may become the current best solution. This has to do with how "hot" the algorithm is. The hotter it is, the more likely poor solutions are to get accepted. The hope is that accepting less optimal solutions occassionally will get solution out of local minima.

Usage

As the end user, you must provide:

  1. The function to minimize. This will typically transform the solution into some more usasble form.
  2. A neighbor function that returns a slightly perturbed version solution passed to it.
  3. A function that returns a temperature when called. It's best practice to have each temperature be cooler than the last. There are built in temperature schedules avaible to use.
  4. A starting solution. Simulated annealing could in theory work with any sort of solution space, but to simplify the framework, we only support 1 dimensional numpy arrays.

All of of these are passed into the constructor of krug.sa.SAOptimizer. Typically, you will call the step method of an SAOptimizer in a loop and use the last returned solution as your answer. This is up to you though as the design is flexible enough to allow for a range of uses. SAOptimizer also suports replacing the current best solution with a new one. This could be useful if you want to run multiple instances at once and have them interact.

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

krug-0.0.12.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

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

krug-0.0.12-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file krug-0.0.12.tar.gz.

File metadata

  • Download URL: krug-0.0.12.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.7

File hashes

Hashes for krug-0.0.12.tar.gz
Algorithm Hash digest
SHA256 fe4e7c3cd2950e3715fae3ec9bd6b2f51b04491a79324ada04bdc09a02d41bc1
MD5 c2125b755c34826d0dd005067d4c065f
BLAKE2b-256 deb2640ca4415bb847d42daa5dfc8e4730e1a58ee6b93c2f1f7adab74f957b1c

See more details on using hashes here.

File details

Details for the file krug-0.0.12-py3-none-any.whl.

File metadata

  • Download URL: krug-0.0.12-py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.7

File hashes

Hashes for krug-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 f29e517db2c209f8b7a1de8c89d21b1595b9553224ae844eea1d44e5a32fa6ae
MD5 2622edc166dff36de25e57742b0758a3
BLAKE2b-256 4b405239454080bda064070e17617b80c52fc700731044caa65b197442d2c8c5

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