Genetix
is a framework to solve problems using genetic algorithms in Elixir.
The process of creating an algorithm can be thought of in three phases:
- Problem Definition
- Evolution Definition
- Algorithm Execution
You only need to define the Genetix.Problem
and run it using Genetix.run/2
function!
To define a new Genetix.Problem
you need to define the specific-problems funtions:
- Define your solution space (
genotype/1
): How to generate a new individual of your problem. - Define your objective function (
fitness_function/2
): How to evaluate each individual. - Define your termination criteria (
terminate?/2
): When the algorithm must to stop.
Depends of the case, you may need define custom hyperparameters
. Internally, genetix
understand these:
Common hyperparameters
:
evaluation_type
: Evaluation operator. By defaultheuristic_evaluation/3
.select_type
: Selection operator. By defaultselect_elite/3
.select_rate
: Selection rate. By default0.8
. Take care of growing and shrinking population in combination withreinsertion_rate
.crossover_type
: Crossover operator. By defaulcrossover_cx_one_point/3
. To run successfully this problem, you need to override this property usingcustom_crossover
function.crossover_rate
: Crossover rate, apply in some strategies asuniform
to determine the probability to swap both genes. By default0.5
(50% of probability).mutation_type
: Mutation operator. By defaultmutation_shuffle/2
. To run successfully this problem, you need to override this property usingcustom_mutation
function.mutation_probability
: Mutation probability. By defaul0.05
.sort_criteria
: How to sort the population by its fitness score (max or min). By default max first.reinsertion_type
: Reinsertion strategy. By defaulpure/4
.reinsertion_rate
: Portion of old chromosomes to survive the next generation. By defaul0.2
. Take care of growing and shrinking population in combination withselect_rate
.statistics
: Map name-function with statistic functions to apply. By default, it calculates the minimum, maximum an the mean of the population (based on the fitness score).
Optional hyperparameters
:
size
: Size of the genotype. By default10
.population_size
: Total number of individuals to run the algorithm. By default100
.
To learn more and get started, check out our guides and docs.
NOTE: This framework is based on the Genetic algorithms in Elixir: Solve Problems Using Evolution
The Pragmatic Programmers, by Sean Moriarity.
Add :genetix
to the list of dependencies in mix.exs
:
def deps do
[
{:genetix, "~> 0.1"}
]
end
The One-Max problem is a trivial problem: What is the maximum sum of a bitstring (a string consisting of only 1s and 0s) of length N.
You only need to define your OneMax
problem and if you need it, define your own hyperparameters
to customize its behavior (in that case, is not needed).
Remember, a basic genetic problem consists of: genotype/0
, fitness_function/1
, and terminate?/1
.
defmodule OneMax do
@behaviour Genetix.Problem
alias Genetix.Types.Chromosome
@impl true
def genotype(opts \\ []) do
# Notice that in this case, we use `size` as a hyperparameter to define the gene size.
size = Keyword.get(opts, :size, 10)
genes = for _ <- 1..42, do: Enum.random(0..1)
%Chromosome{genes: genes, size: size}
end
@impl true
def fitness_function(chromosome, _opts \\ []), do: Enum.sum(chromosome.genes)
@impl true
def terminate?([best | _], _opts \\ []) do
best.fitness == best.size
end
end
You can run Genetix.run(Genetix.Problems.OneMax, size: 100)
to solve the problem.
If you want, you can take a look to genetix/problems
for other problems implemented as example.
The goal of all the problems you are going to solve are related with optimize and objetive. In all the algorithms, you must to define the problem, configure the algorithm and run it until you obtain a solution. Sometimes you need a way to track the progress of an evolution over the time:
- Analyze how your population's fitness grew over time
- How the distribution of fitness changed between generations
- ...
Those insight can help you make decisions about how to reconfigure or adjust your algorithms.
For this purpose, Genetix
provides Statistics
that uses ETS to store the evolution of the population over time. You can override the default statistics with the statistics
hyperparameter.
Once the algorithm ends you can access your statistics running Utilities.Statistics.lookup/1
function.
An example of use:
iex> Genetix.run(Genetix.Problems.OneMax, size: 100)
# once the algorithm ends
iex> {_, zero_gen_stats} = Utilities.Statistics.lookup(0)
iex> {_, fivethousand_gen_stats} = Utilities.Statistics.lookup(5000)
An example defining custom statistics:
def get_percentile_90(population) do
sorted_population = Enum.map(population, fn c -> c.fitness end) |> Enum.sort()
n = length(sorted_population)
k = round(0.9 * n)
if k == 0 do
Enum.at(sorted_population, 0)
else
Enum.at(sorted_population, k - 1)
end
end
Genetix.run(Genetix.Problems.OneMax, size: 10, statistics: %{percentile_90: &get_percentile_90/1})
Genetix
provides a way to track the evolution of each chromosome using libgraph
. A genealogy tree is a directed grapgh that points from parent chromosome to child chromosome and shows the transitions of the evolution from first population to last population.
You can explore the genealogy tree generated after running your algorithm:
Genetix.run(Genetix.Problems.OneMax, size: 50)
genealogy = Utilities.Genealogy.get_tree()
IO.inspect(Graph.vertices(genealogy))
If you run this, you'll see a very long list of chromosomes. Take a look to the libgraph doc for more information.
Elixir is a language that wasn't designed to be extremely efficient at computationally expensive tasks. Genetix
allows benchmark and profile your genetic algorithms. Benchmarking is the process of evaluating your code from a performance point of view (establishing performance metrics for an entire operation to compare between other operations). Profiling is the process of evaluating specific aspects of a program in space or time to add in performance optimization (to understand the behavior of a program talling which operation spends most of its time or what function a program invokes the most offering detailed insights into where you should try to optimize the most).
Benchmarking your algorithm allows you to determine if the optimizations you are making are having impact on the overall performance of your algorithm.
Genetix
uses benchee for benchmarking. Benchee
provides a lot of information out of the box.
You can check example(s) of benchmarking using benchee
under bench
folder and run mix run bench/benchmark.exs
to see the results of the benchmarks.
Check the benchee documentation for more information.
Genetix
also uses benchee_html to generate a nice looking HTML report where individual graphs can also be exported as PNG images under benchmarks
folder.
Genetix
also uses exprof to profile your genetics algorithms with Utilities.Profiler
.
An example how to use Utilities.Profiler
:
iex> Utilities.Profiler.run(Genetix.Problems.ZeroMax, sort_criteria: &<=/2)
HH:MM:SS.mm [info] Running Genetix.Problems.ZeroMax
FUNCTION CALLS % TIME [uS / CALLS]
-------- ----- ------- ---- [----------]
counters:get/2 1 0.00 0 [ 0.00]
counters:add/3 1 0.00 0 [ 0.00]
...
rand:uniform/1 5071 4.82 2253 [ 0.44]
erlang:send/2 979 5.08 2374 [ 2.42]
'Elixir.Enum':split_list/3 21394 5.80 2710 [ 0.13]
'Elixir.Enum':'-sum/1-lists^foldl/2-0-'/2 47486 11.28 5272 [ 0.11]
---------------------------------------------------------------------- ------ ------- ----- [----------]
Total: 224888 100.00% 46749 [ 0.21]
99.56
You should see a long list of results indicating where your genetic algorithm spends most of its time. In this example you 'll notices that most of the work in the algorithm happens in list functions and random number generations.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.