Skip to main content

Genetic algorithms for n-dimensional function maximization.

Project description

fmga

fmga (function maximization through genetic algorithms) is a package that takes a genetic algorithm approach to maximization problem of non-convex objective functions in multiple dimensions.

The objective function doesn't have to be differentiable, or even continuous in the specified domain!
The idea is to sample an evolving population of points converging to the function maximum over many iterations.

The population of n-dimensional points undergoes random mutations - and is selected through elitism and ranking selection with selection weights inversely proportional to fitness and diversity ranks.

fmga now supports multiprocessing through pathos too!

Installation

Install with pip:

pip install fmga

Import within the python script with:

import fmga

Execution

Given a function on multiple variables, say:

def f(x, y, z):
    return x - math.sin(y) * z

Pass this function as the objective_function argument to the .maximize() method (lambdas work too!).

best_point = fmga.maximize(f, population_size=60, dimensions=3)

The maximize() method creates a Population of Point objects, calls the .converge() method on the Population object, and finally, returns a Point object representing the n-dimensional point with best fitness through the .best_estimate() method.

print(best_point, best_point.fitness)

By default, the multiprocessing argument defaults to False, so to enable multiprocessing, set this argument to True, and pass the number of processes to be spawned as the processes argument.

best_point = fmga.maximize(f, multiprocessing=True, processes=4)

Note that, when multiprocessing is enabled on Windows systems, you must put a guard over the entry point of your script. See here for a how-to.

fmga also supports a variable number of dimensions to optimise over, passed as the dimensions argument, which defaults to the number of arguments of the objective function passed.

If you wish to interact with the Population object directly, you can. Both of the following work:

population = fmga.Population(f, population_size=60, dimensions=3)
population = fmga.Population(population_size=60, objective_function=f, dimensions=3)

If you wish to define custom boundaries, create a list of tuples, for each dimension. Default boundaries are (0, 100). (This is different than in versions 1.x)

boundaries = [(0, 2.5), (0, 10)]

and pass this as the boundaries argument to the Population constructor or the maximise() method:

population = fmga.Population(f, population_size=60, boundaries=boundaries)
best_point = fmga.maximize(f, population_size=60, boundaries=boundaries)

Note that the default range for missing dimensions is (0, 100).
The population can be set to breed and iterate by using the .converge() method.

population.converge(iterations=20)

To perform only one iteration of breeding and mutating, do:

population.iterate()

Access population mean fitness and mean L1 diversity stats through the .mean_fitness and .mean_diversity attributes:

print(population.mean_fitness, population.mean_diversity)

The .best_estimate() method returns the point closest to the function point of maxima in the population, as a Point object.

best_point = population.best_estimate()

Every Point object has the coordinates attribute, a numpy array signifying the coordinates of point. To find the value of the function at this point, use the fitness attribute.

print(best_point.coordinates)
print(best_point.fitness)

Population Class Methods

The Population constructor takes the following arguments, in order:

objective_function The function to maximize!
dimensions (default = number of arguments of objective_function) The dimensionality of the points and the number of variables to maximize over.
population_size (default = 60) Number of points in the population.
boundaries (default = (0, 100) for every dimension) Must be a list of tuples. The tuple indicates the domain where the points are spread along that dimension.
elite_fraction (default = 0.1) Fraction of the population's points to be kept as elite during breeding. Must be between 0 and 1, inclusive.
mutation_probability (default = 0.05) How likely is is for a single point to mutate - this probability is the same for all points in the population. Must be between 0 and 1, inclusive.
mutation_range (default = 5) The range of the mutation when it does occur. Note that the point will never mutate out of the domain defined!
verbose (default = 0, was 2 for versions <= 2.4.0) How much console output to be displayed when iterating population after population. Must take values 0, 1 or 2 with 2 representing the most output, and 0 representing none.
multiprocessing (default = False) Whether multiprocessing is enabled
processes (default = multiprocessing.cpu_count()) Number of processes to spawn if multiprocessing is enabled.

The maximize() method takes all of the above in the same order, as well as a iterations argument, defaulting to 15, signifying the number of iterations that the underlying population undergoes.

The unpack() method accepts two arguments, a tuple of values and a list of shapes. If the length of the list of shapes is greater than one, it returns a list of numpy arrays of shape according to the list, by reshaping the tuple in-order. Otherwise it returns just a numpy array of the passed shape, formed by reshaping the tuple.
This is useful when working with a large number of arguments:

def f(*args):
    x, y, z = fmga.unpack(args, (1, (2, 2), 4))

    # x.shape == (1,)
    # y.shape == (2, 2)
    # z.shape == (4,)

    return x - y[0][0] + z[2]

Dependencies

  • numpy
  • pathos (>= 0.2.2.1)

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

fmga-2.6.0.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

fmga-2.6.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file fmga-2.6.0.tar.gz.

File metadata

  • Download URL: fmga-2.6.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.5.2

File hashes

Hashes for fmga-2.6.0.tar.gz
Algorithm Hash digest
SHA256 c473b4f112057f9a0bad6a7d0ca543dfea31e864a57619170b170306781cf884
MD5 caf2a99da1a40df49ca6ca01d425bd32
BLAKE2b-256 b3daf0e0dd1f35572488f3eb14df18d9a0a5577c806735b2dee04c3b5a20e24d

See more details on using hashes here.

File details

Details for the file fmga-2.6.0-py3-none-any.whl.

File metadata

  • Download URL: fmga-2.6.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.3 CPython/3.5.2

File hashes

Hashes for fmga-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 066e62a43a1d1702a0c2a9368dea5135279fd0c14a53ff72ae3030350b1b6fa3
MD5 18b56fc8253672b2a2fb529333f875bd
BLAKE2b-256 419649f515d5b90f387a366e5d3a32c2b9f6e0842aad99a3880bc3f1d2630c5f

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