Crate genetic_rs

source ·
Expand description

A small crate to quickstart genetic algorithm projects

How to Use

First off, this crate comes with the builtin and genrand features by default. If you want to add the builtin crossover reproduction extension, you can do so by adding the crossover feature.

Once you have eveything imported as you wish, you can define your entity and impl the required traits:

ⓘ
#[derive(Clone, Debug)] // clone is currently a required derive for pruning nextgens.
struct MyEntity {
    field1: f32,
}
 
// required in all of the builtin functions as requirements of `DivisionReproduction` and `CrossoverReproduction`
impl RandomlyMutable for MyEntity {
    fn mutate(&mut self, rate: f32) {
        self.field1 += fastrand::f32() * rate;
    }
}
 
// required for `division_pruning_nextgen`.
impl DivisionReproduction for MyEntity {
    fn spawn_child(&self) -> Self {
        let mut child = self.clone();
        child.mutate(0.25); // use a constant mutation rate when spawning children in pruning algorithms.
        child
    }
}
 
// required for the builtin pruning algorithms.
impl Prunable for MyEntity {
    fn despawn(self) {
        // unneccessary to implement this function, but it can be useful for debugging and cleaning up entities.
        println!("{:?} died", self);
    }
}
 
// helper trait that allows us to use `Vec::gen_random` for the initial population.
impl GenerateRandom for MyEntity {
    fn gen_random(rng: &mut impl rand::Rng) -> Self {
        Self { field1: rng.gen() }
    }
}

Once you have a struct, you must create your fitness function:

ⓘ
fn my_fitness_fn(ent: &MyEntity) -> f32 {
    // this just means that the algorithm will try to create as big a number as possible due to fitness being directly taken from the field.
    // in a more complex genetic algorithm, you will want to utilize `ent` to test them and generate a reward.
    ent.field1
}

Once you have your fitness function, you can create a GeneticSim object to manage and control the evolutionary steps:

ⓘ
fn main() {
    let mut rng = rand::thread_rng();
    let mut sim = GeneticSim::new(
        // you must provide a random starting population. 
        // size will be preserved in builtin nextgen fns, but it is not required to keep a constant size if you were to build your own nextgen function.
        // in this case, you do not need to specify a type for `Vec::gen_random` because of the input of `my_fitness_fn`.
        Vec::gen_random(&mut rng, 100),
        my_fitness_fn,
        division
    );
     
    // perform evolution (100 gens)
    for _ in 0..100 {
        sim.next_generation(); // in a genetic algorithm with state, such as a physics simulation, you'd want to do things with `sim.entities` in between these calls
    }
     
    dbg!(sim.entities);
}

That is the minimal code for a working pruning-based genetic algorithm. You can read the docs or check the examples for more complicated systems.

License

This project falls under the MIT license.

Modules

  • builtin
    Built-in nextgen functions and traits to go with them.
  • prelude
    Used to quickly import everything this crate has to offer. Simply add use genetic_rs::prelude::* to begin using this crate.

Structs

Traits