pygenalgo 1.9.1

Genetic Algorithms toolbox in Python3

PyGenAlgo: A simple and powerful toolkit for genetic algorithms.

Pylint score: 9.10 / 10

This repository implements a genetic algorithm toolbox in Python3 programming language, using only Numpy and Joblib as additional libraries. The basic approach offers a "StandardGA" class, where the whole population of chromosomes is replaced by a new one at the end of each iteration (or epoch). More recently, a new computational model was added named "IslandModelGA" class that offers a new genetic operator (MigrationOperator), that allows for periodic migration of the best individuals, among the (co-evolving) different island populations.

NOTE: For computationally expensive fitness functions the StandardGA class provides the option of parallel evaluation (of the individual chromosomes), by setting in the method run(..., parallel=True). However, for fast fitness functions this will actually cause the algorithm to execute slower (due to the time required to open and close the parallel pool). So the default setting here is "parallel=False". Regarding the IslandModelGA, this is running in parallel mode by definition.

NEWS: In this new release three crossover operators (SinglePointCrossover, MultiPointCrossover and UniformCrossover) got an update that: i) makes them faster and ii) allows them to be used with chromosomes of different lengths.

The current implementation offers a variety of genetic operators including:

• Selection operators:

  • Linear Rank Selector
  • Neighborhood Selector
  • Random Selector
  • Roulette Wheel Selector
  • Stochastic Universal Selector
  • Tournament Selector
  • Truncation Selector
  • Boltzmann Selector

• Crossover operators:

  • Single-Point Crossover
  • Multi-Point Crossover
  • Uniform Crossover
  • Order Crossover (OX1)
  • Partially Mapped Crossover (PMX)
  • Position Based Crossover (POS)
  • Blend-α Crossover (BLX-α)

• Mutation operators:

  • Random Mutator
  • Shuffle Mutator
  • Inverse Mutator
  • Gaussian Mutator
  • Swap Mutator
  • Flip Mutator
  • Polynomial Mutator

• Migration operators

  • Clockwise Migrator
  • Random Migrator

• Meta operators

  • Meta Selector
  • Meta Crossover
  • Meta Mutator
  • Meta Migration

(NOTE: Meta operators call randomly other compatible operators (selection/crossover/mutation/migration) from a predefined set, with equal probability.)

Incorporating additional genetic operators is easily facilitated by inheriting from the base classes:

• SelectionOperator
• CrossoverOperator
• MutationOperator
• MigrationOperator

and implementing the basic interface as described therein. In the examples that follow I show how one can use this code to run a GA for optimization problems (maximization/minimization) with and without constraints. The project is ongoing so new things might come along the way.

Installation

There are two options to install the software.

The easiest way is to download it from PyPI. Simply run the following command on a terminal:

pip install pygenalgo

Alternatively one can clone directly the latest version using git as follows:

git clone https://github.com/vrettasm/PyGeneticAlgorithms.git

After the download of the code (or the git clone), one can use the following commands:

cd PyGeneticAlgorithms
pip install .

This will install the latest PyGenAlgo version in the package management system.

Required packages

The recommended version is Python 3.10 (and above). To simplify the required packages just use:

pip install -r requirements.txt

Fitness function

The most important thing the user has to do is to define the "fitness function". A template is provided here, in addition to the examples below. The cost_function decorator is used to indicate whether the function will be maximized (default), or minimized. The second output parameter ("solution_found") is optional; only in the cases where we can evaluate if a termination condition is satisfied.

from pygenalgo.genome.chromosome import Chromosome
from pygenalgo.utils.utilities import cost_function


# Fitness function <template>.
@cost_function(minimize=True)
def fitness_func(individual: Chromosome):
    """
    This is how a fitness function should look like. The whole
    evaluation should be implemented (or wrapped around) this
    function.
    
    :param individual: Individual chromosome to be evaluated.
    
    :return: the function value evaluated at the individual.
    """

    # Extract gene values from the chromosome.
    x = individual.values()
    
    # ... CODE TO IMPLEMENT ...

    # Compute the function value.
    f_value = ...

    # Condition for termination.
    # We set it to True / False.
    solution_found = ...

    # Return the solution.
    return f_value, solution_found
# _end_def_

Once the fitness function is defined correctly the next steps are straightforward as described in the examples.

Examples

Some optimization examples on how to use these algorithms:

Problem	Variables	Objectives	Constraints	Optima
Sphere	M (=5)	1	no	single
Rastrigin	M (=5)	1	no	single
Rosenbrock	M (=2)	1	1	single
Binh & Korn	M (=2)	2	2	single
Sphere (parallel)	M (=10)	1	no	single
Easom (parallel)	M (=2)	1	no	single
Traveling Salesman	M (=10)	1	yes	single
N-Queens	M (=8)	1	yes	single
OneMax	M (=50)	1	no	single
Tanaka	M (=2)	2	2	single
Zakharov	M (=8)	1	no	single
Osyczka	6	2	6	single
Shubert	2	1	no	multiple
Gaussian Mixture	2	1	no	multiple
Multi-Depot VRP	M	1	yes	multiple

Constraint optimization problems can be easily addressed using the Penalty Method. Moreover, multi-objective optimizations (with or without constraints) can also be solved, using the weighted sum method, as shown in the examples above. For multimodal optimizations check examples Shubert and Gaussian Mixture.

References and Documentation

This work is described in:

• Michail D. Vrettas and Stefano Silvestri (2025) "PyGenAlgo: a simple and powerful toolkit for genetic algorithms". SoftwareX, vol. 30. DOI: 10.1016/j.softx.2025.102127.

You can find the latest documentation here.

Contact

For any questions/comments (regarding this code) please contact me at: [e-mail]