ga 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca6bd91f34c0b47ed8990d3edd4ff6d0b7d771f3
+  data.tar.gz: 5dd715e92b787d9ebb40ba02e0bca6f418df53ba
+SHA512:
+  metadata.gz: 33ecd28ad168a007e208bdb2dff3a8a432e7983cb474de78da945ce568cd8a09624b11c94b10c16a157de0cd86e354814dae0ec85b845ff55f50018461691324
+  data.tar.gz: '08511cef0e79837e42244da6c92d93799aad5ddd6f3f0159e0e096477633d7935be46dbf2427792c51302e6231052d8ad061cef38db58926f0b3f002a99ac487'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require gem_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://gems.ruby-china.org'
+
+# Specify your gem's dependencies in ga.gemspec
+gemspec
+
+gem 'parallel'
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jiangzhi.xie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# GA
+
+Simple Framework for Genetic Algorithm
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ga'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ga
+
+## Usage
+
+### Define your unit
+
+require methods:
+
+* `Unit.random_new`
+* `Unit#initialize(genome)` need copy genome
+* `Unit#fitness` return fitness
+* `Unit#fitness=` #set fitness
+* `Unit#cross!(target_unit)`
+* `Unit#mutate!`
+* `Unit#<=>(target_unit)`
+
+```
+class Unit
+  include GA
+
+  attr_accessor :genome, :fitness
+
+  def self.random_new
+    self.new(3.times.map { rand(3) })
+  end
+
+  def initialize(genome)
+    @genome = genome.dup
+  end
+
+  def fitness
+    @fitness ||= genome.reduce(&:+)
+  end
+
+  def cross!(target)
+    (rand(3) + 1).times do |i|
+      genome[i], target.genome[i] = target.genome[i], genome[i]
+    end
+  end
+
+  def mutate!
+    (rand(3) + 1).times do
+      i = rand(3)
+      genome[i] = (genome[i] + rand(3)) % 3
+    end
+  end
+
+  def <=>(target)
+    self.fitness <=> target.fitness
+  end
+end
+```
+
+### Evolve
+
+`Unit#evolve(total_units, generations, crossover_rate, variation_rate)` return latest units
+
+```
+units = Unit.evolve(32, 100, 0.8, 0.15) 
+best = units.max
+```
+
+### Print evolve info
+
+```
+gz = Unit.new_ga_zoo
+ga.debug!
+units = ga.evolve(32, 100, 0.8, 0.15)
+```
+
+### Use `before_init_fitness` callback
+
+```
+gz = Unit.new_ga_zoo
+gz.before_init_fitness do |units, generation|
+  # parallel calculate fitness
+  data = Parallel.map(units, in_processes: 8) {|unit| unit.fitness }
+  units.each_with_index {|unit, index| unit.fitness = data[index] }
+end
+```
+
+### More
+
+see `examples/` folder
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xjz19901211/ga.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ga"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/01bag.rb

@@ -0,0 +1,99 @@
+require 'bundler/setup'
+require 'ga'
+
+ITEMS = [
+  { weight: 3, value: 200},
+  { weight: 10, value: 500},
+  { weight: 100, value: 30},
+  { weight: 200, value: 2000},
+  { weight: 300, value: 500},
+  { weight: 50, value: 50},
+  { weight: 190, value: 1000},
+  { weight: 200, value: 1500},
+]
+
+MAX_WEIGHT = 400
+
+class Unit
+  include GA
+
+  attr_accessor :genome, :fitness
+
+  def self.random_new
+    self.new(ITEMS.map do rand(2) == 1 end)
+  end
+
+  def initialize(genome)
+    @genome = genome.dup
+  end
+
+  def fitness
+    return @fitness if @fitness
+    total_value = 0
+    total_weight = 0
+    genome.each_with_index do |item, index|
+      next unless item
+      total_value += ITEMS[index][:value]
+      total_weight += ITEMS[index][:weight]
+    end
+    (total_weight > MAX_WEIGHT or total_value == 0) ? 1 : total_value
+  end
+
+  def weight
+    total_weight = 0
+
+    genome.each_with_index do |item, index|
+      next unless item
+      total_weight += ITEMS[index][:weight]
+    end
+
+    return total_weight
+  end
+
+  def length
+    genome.length
+  end
+
+  def mutate!
+    rand(length).times { genome[rand(length)] ^= true }
+  end
+
+  def cross!(unit)
+    (rand(length) + 1).times do
+      i = rand(length)
+      genome[i], unit.genome[i] = unit.genome[i], genome[i]
+    end
+  end
+
+  def <=>(target)
+    self.fitness <=> target.fitness
+  end
+
+  def inspect
+    "#{object_id} #{self.fitness}|#{self.weight} = #{genome.map {|i| i ? 1 : 0 }.join(', ')}"
+  end
+end
+
+
+require 'benchmark'
+
+r = {}
+Benchmark.bm do |x|
+  x.report('a') do
+    puts 'start'
+    100.times do
+      units = Unit.evolve(32, 100, 0.8, 0.15)
+      unit = units.max
+      print unit.inspect + "\r"
+      r[unit.fitness] ||= 0
+      r[unit.fitness] += 1
+    end
+    puts 'end'
+  end
+end
+
+puts "100 times result: "
+r.each do |val, times|
+  puts "#{val}: #{times} times"
+end
+

data/examples/robot.rb

@@ -0,0 +1,229 @@
+require 'bundler/setup'
+require 'ga'
+
+require 'parallel'
+
+MAP_SIZE = 7
+
+
+# 0 empty 1 dust 2 wall
+# [x][y]
+def new_map
+  MAP_SIZE.times.map { [0] * MAP_SIZE }
+end
+
+def rand_map(map, dust_rate = 0.5)
+  map.each do |cols|
+    cols.length.times {|i| cols[i] = rand() <= dust_rate ? 1 : 0 }
+  end
+end
+
+def show_map(map, bx = nil, by = nil)
+  puts('-' * 20)
+  MAP_SIZE.times do |y|
+    MAP_SIZE.times do |x|
+      if bx == x and by == y then
+        print(map[x][y], '* ')
+      else
+        print(map[x][y], '  ')
+      end
+    end
+    print("\n")
+  end
+  puts('-' * 20)
+end
+
+
+# 0 random move
+# 9 clear
+# 1 2 3
+# 4   5
+# 6 7 8
+ACTIONS_DATA = {
+  0 => nil,
+  9 => nil,
+
+  # 1 => [-1, -1],
+  2 => [0, -1],
+  # 3 => [1, -1],
+
+  4 => [-1, 0],
+  # 5 => [1, 0],
+
+  6 => [-1, 1],
+  # 7 => [0, 1],
+  8 => [1, 1]
+}
+
+ACTIONS = ACTIONS_DATA.keys
+MOVE_ACTIONS = [2, 4, 6, 8]
+
+class Robot
+  include GA
+
+  # genome
+  #
+  # {env => action}
+  #
+  # env: '10122'
+  #     1
+  #   2 3 4
+  #     5
+  # action:
+
+  attr_accessor :genome, :fitness
+  TOTAL_VALUE_TEST = 150
+
+  def self.random_new
+    self.new({})
+  end
+
+  def initialize(genome)
+    @genome = genome.dup
+  end
+
+  def fitness
+    tester = RobotTester.new(self)
+    @fitness ||= TOTAL_VALUE_TEST.times.map { tester.test }.reduce(&:+) / TOTAL_VALUE_TEST
+  end
+
+  def <=>(target)
+    fitness <=> target.fitness
+  end
+
+  def analyse_env(env)
+    @genome[env] ||= if env[2] == '1' then
+      9
+    elsif env == '00000' then
+      0
+    else
+      MOVE_ACTIONS.sample
+    end
+  end
+
+  def cross!(target)
+    all_genome = (genome.keys + target.genome.keys).uniq
+    len = all_genome.length
+    min_robot = [self, target].min
+
+    rand(len).times do
+      gene = all_genome[rand(len)]
+
+      if genome[gene] == target.genome[gene] and rand() < 0.3 then
+        min_robot.genome[gene] = ACTIONS.sample
+      else
+        genome[gene], target.genome[gene] = target.genome[gene], genome[gene]
+      end
+    end
+  end
+
+  def mutate!
+    all_genome = genome.keys
+    len = all_genome.length
+
+    (rand(len) + 1).times do
+      gene = all_genome[rand(len)]
+      genome[gene] = ACTIONS.sample
+    end
+  end
+end
+
+class RobotTester
+  attr_reader :map, :robot
+
+  def initialize(robot)
+    @map = new_map
+    @robot = robot
+  end
+
+  def test(step = 70, show = false)
+    rand_map(map)
+    x = rand(map.length)
+    y = rand(map.length)
+    @total_value = 0
+
+    step.times do
+      env = scan_env(x, y)
+      action = robot.analyse_env(env)
+      rx, ry = execute_action(x, y, action)
+
+      x += rx
+      y += ry
+
+      if x < 0 or y < 0 or x >= MAP_SIZE or y >= MAP_SIZE then
+        x -= rx
+        y -= ry
+        @total_value -= 10
+      elsif map[x][y] == 1
+        @total_value += 1
+      end
+
+      if show then
+        show_map(map, x, y)
+        sleep 0.2
+      end
+    end
+
+    @total_value
+  end
+
+  def execute_action(x, y, action)
+    case action
+    when 9 then
+      if map[x][y] == 1 then
+        map[x][y] = 0
+        @total_value += 10
+      else
+        @total_value -= 10
+      end
+
+      [0, 0]
+    when 0 then
+      @total_value -= 1
+      ACTIONS_DATA[MOVE_ACTIONS.sample]
+    else
+      @total_value -= 1
+      ACTIONS_DATA[action]
+    end
+  end
+
+  SCAN_COORDS = [
+    [0, -1], [-1, 0], [0, 0], [1, 0], [0, 1]
+  ]
+  def scan_env(x, y)
+    SCAN_COORDS.map do |sx, sy|
+      rx = x + sx
+      ry = y + sy
+
+      if rx < 0 || ry < 0 || rx >= MAP_SIZE || ry >= MAP_SIZE then
+        2
+      else
+        map[rx][ry]
+      end
+    end.join
+  end
+end
+
+
+ga_zoo = Robot.new_ga_zoo
+ga_zoo.debug!
+
+ga_zoo.before_init_fitness do |units|
+  vs = Parallel.map(units, in_processes: 8) do |unit|
+    [unit.fitness, unit.genome]
+  end
+  units.each_with_index do |unit, index|
+    unit.fitness, unit.genome = vs[index]
+  end
+end
+
+robots = ga_zoo.evolve(256, 300)
+robot = robots.max
+
+RobotTester.new(robot).test(100, true)
+
+puts "========= result ============="
+puts "fitness: #{robot.fitness}"
+puts robot.genome
+
+

data/ga.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ga/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ga"
+  spec.version       = GA::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["xiejiangzhi@gmail.com"]
+
+  spec.summary       = %q{Simple Framework of Genetic Algorithm}
+  spec.description   = %q{Simple Framework of Genetic Algorithm}
+  spec.homepage      = "https://github.com/xjz19901211/ga"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/ga/version.rb

@@ -0,0 +1,3 @@
+module GA
+  VERSION = "0.1.0"
+end

data/lib/ga/zoo.rb

@@ -0,0 +1,98 @@
+module GA
+  class Zoo
+    attr_reader :unit_cls
+
+    def initialize(unit_cls)
+      @unit_cls = unit_cls
+      @debug = false
+      @before_fitness_callback = nil
+    end
+
+    def evolve(units = 32, generations = 100, crossover_rate = 0.8, mutation_rate = 0.15)
+      units = units.times.map { unit_cls.random_new } if units.is_a?(Fixnum)
+
+      generations.times do |i|
+        @before_fitness_callback.call(units, i + 1) if @before_fitness_callback
+        output_debug_info(units, generations, i + 1) if @debug
+
+        units = select_units(units)
+        cross(units, crossover_rate)
+        mutate(units, mutation_rate)
+      end
+
+      return units
+    end
+
+    def debug!
+      @debug = true
+    end
+
+    def before_init_fitness(&block)
+      @before_fitness_callback = block
+    end
+
+
+    private
+
+    def select_units(units)
+      new_units = units.map do
+        ou = units.sample(3).max
+        unit_cls.new(ou.genome).tap {|u| u.fitness = ou.fitness }
+      end
+
+      # Elite policy
+      min_index = new_units.index(new_units.min)
+      if min_index != 0 then
+        new_units[min_index], new_units[0] = new_units[0], new_units[min_index]
+      end
+      new_units[0] = unit_cls.new(units.max.genome)
+      new_units
+    end
+
+    def cross(units, rate)
+      last_index = nil
+
+      units.each_with_index do |unit, index|
+        next if index == 0
+        next if rand() >= rate
+
+        if last_index
+          units[last_index].cross!(unit)
+          # recalculate fitness
+          units[last_index].fitness = unit.fitness = nil
+          last_index = nil
+        else
+          last_index = index
+        end
+      end
+    end
+
+    def mutate(units, rate)
+      units.each_with_index do |unit, index|
+        next if index == 0
+        next if rand() >= rate
+        unit.mutate!
+        # recalculate fitness
+        unit.fitness = nil
+      end
+    end
+
+    def output_debug_info(units, generations, generation)
+      units.sort!
+      info = [
+        "GA-#{generation}/#{generations} #{units.count}-#{units[-1].genome.length}",
+        ' fitness: '
+      ]
+
+      if units.length <= 7 then
+        info << units.map(&:fitness).join(', ')
+      else
+        info << "#{units[0..2].map(&:fitness).join(', ')}"
+        info << " ... #{units[-5..-1].map(&:fitness).join(', ')}"
+      end
+
+      puts info.join
+    end
+  end
+end
+

data/lib/ga.rb

@@ -0,0 +1,19 @@
+require "ga/version"
+require "ga/zoo"
+
+module GA
+  def self.included(cls)
+    cls.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def new_ga_zoo
+      GA::Zoo.new(self)
+    end
+
+    def evolve(total_units = 32, generations = 100, crossover_rate = 0.8, muration_rate = 0.1)
+      new_ga_zoo.evolve(total_units, generations, crossover_rate, muration_rate)
+    end
+  end
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ga
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Framework of Genetic Algorithm
+email:
+- xiejiangzhi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/01bag.rb
+- examples/robot.rb
+- ga.gemspec
+- lib/ga.rb
+- lib/ga/version.rb
+- lib/ga/zoo.rb
+homepage: https://github.com/xjz19901211/ga
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Simple Framework of Genetic Algorithm
+test_files: []