Skip to main content

Simple Particle Swarm Optimization

Project description

Optimus-Beez

This is a Particle Swarm Optimization (PSO) package. The PSO used is the simplest version presented by Maurice Clarc in "Particle Swarm Optimization".

Installation

Run the following command: pip install optimusbeez

How to use Optimus-Beez

Choosing the function to evaluate

The default function to evaluate is Rosenbrock. To change this, first check out evaluate.py. This file contains evaluate() that evaluates points for different functions. If the function you wish to use is not defined, then go ahead and add it to evaluate(). Then go to function_info.txt and change

  • fn_name to the name of one of the functions in evaluate()
  • true_position to the x,y-coordinates of the global minimum of your function

Optimizing the parameters of the PSO

The optimization algorithm itself contains 5 parameters that need to be set by the user. These are set in the file optimal_constants.txt. In the code, these parameters are referred to as 'constants' so as not to confuse them with the x,y-coordinates. It is a good idea to optimize these constants using optimize_constants.py. Run optimize_constants.py on your command line. This is just good old random search optimization. You will be prompted several times for input. Use a value of 'time steps' similar to what you want to use with PSO. When the random search is completed, you will be asked if you want to overwrite the file optimal_constants.txt. Do this if you would like to use these constants in PSO.py.

Using PSO

The main script is PSO.py. Run this in the command line. You will be asked if you want to change the number of evaluations. If the value you wish to set is much larger or smaller than the default value, it is advised you run optimize_constants.py again. Set the value, or use the default value and wait for the PSO to finish. You will see an animation of your swarm at the end.

Testing

Nose is used to test the code. All tests are located in the 'tests' folder.To run the tests, execute:

nosetests

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

optimusbeez-0.1.2.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

optimusbeez-0.1.2-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file optimusbeez-0.1.2.tar.gz.

File metadata

  • Download URL: optimusbeez-0.1.2.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for optimusbeez-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d793302e0e9a5a893a6aabb82596b6dfa959b31f5dec01dec620aa9cdee5cd04
MD5 59aefeab65a0f748c68e0f252f362525
BLAKE2b-256 d3ac26fa7f510a8fff7604deecfc00568cfbda6e30055dceb44be27ed8cd2a72

See more details on using hashes here.

File details

Details for the file optimusbeez-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: optimusbeez-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for optimusbeez-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8f2bf5dedbcf9204e1b1f605fa08cd7706f331151ff45bd3681cf565d00adba1
MD5 af0886a4720d9c29affb1eca23c4a2c2
BLAKE2b-256 730f486128ac7af64246401e09dde2c68bd3d90c37e6721d309db6bac9bce833

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