bandit 0.0.2 → 0.0.3

data/lib/generators/bandit/templates/dashboard/view/index.html.erb

@@ -0,0 +1,21 @@
+<section class='span-20 colborder'>
+  <div class='title'><h1>Status</h1></div>
+  <p>
+    Using <%= storage_name %> storage <%= storage_config %> and a <%= player_name %> player <%= player_config %> for <%= Bandit.experiments.length %> active experiment(s).
+  </p>
+  <div class='title'><h1>Running Experiments</h1></div>
+  <% @experiments.each { |experiment| %>
+  <h2><%= link_to experiment.name.to_s.titleize, url_for(:action => 'show', :id => experiment.name) %></h2>
+  <p>
+    <%= experiment.description %>
+  </p>
+  <% experiment.alternatives.each { |alt| %>
+    <h3>Alternative: <%= alt %></h3>
+    <ul>
+      <li>Participants: <%= experiment.participant_count(alt) %></li>
+      <li>Conversions: <%= experiment.conversion_count(alt) %></li>
+      <li>Conversion rate: <%= experiment.conversion_rate(alt) %> %</li>
+    </ul>
+  <% } %>
+<% } %>
+</section>

data/lib/generators/bandit/templates/dashboard/view/show.html.erb

@@ -0,0 +1,24 @@
+<section class='span-20 colborder'>
+  <div class='title'><h1><%= @experiment.name.to_s.titleize %></h1></div>
+  <p>
+    <%= @experiment.description %>
+  </p>
+
+  <div id="gcontainer"></div>
+
+  <% @experiment.alternatives.each { |alt| %>
+  <h2>Alternative: <%= alt %></h2>
+  <ul>
+    <li>Participants: <%= @experiment.participant_count(alt) %></li>
+    <li>Conversions: <%= @experiment.conversion_count(alt) %></li>
+    <li>Conversion rate: <%= @experiment.conversion_rate(alt) %> %</li>
+  </ul>
+  <% } %>
+
+</section>
+
+<script type="text/javascript">
+var url = "<%= url_for(:controller => 'bandit', :action => 'show', :id => @experiment.name, :format => 'csv') %>";
+var title = "<%= @experiment.name.to_s.titleize %>";
+show_chart(title, url);
+</script>

data/players.rdoc

@@ -0,0 +1,22 @@
+= Bandit Players
+There are a number of different possible players that each seek to explore/exploit using different methods.
+
+== Epsilon Greedy
+The epsilon greedy player selects the best alternative with a probability of 1 - epsilon, and selects uniformly among the other alternatives with a probability of epsilon.  You can set the value of epsilon in the config file like this:
+
+    production:
+      ...
+      player: epsilon_greedy
+      player_config:
+        epsilon: 0.1
+      ...
+
+
+== Round Robin
+This is included for testing purposes only.  It will not optimize.  There are no config options.
+
+
+    production:
+      ...
+      player: round_robin
+      ...

data/test/config.yml

@@ -0,0 +1,7 @@
+redis_storage_config:
+  host: localhost
+  port: 6379
+
+memcache_storage_config:
+  host: localhost
+  

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'test/unit'
+require 'yaml'
+
+$:.unshift(File.join File.dirname(__FILE__), '..', 'lib')
+require 'bandit'
+
+CONFIG = YAML.load_file File.join(File.dirname(__FILE__), "config.yml")
+
+module SetupHelper
+  def new_experiment
+    Bandit::Experiment.create(:exp_test) { |exp| 
+      exp.alternatives = [10,20,30,40]
+      exp.title = "A Test Exp"
+      exp.description = "Desc"
+    }
+  end
+end

data/test/memcache_storage_test.rb

@@ -0,0 +1,17 @@
+require File.join File.dirname(__FILE__), 'helper'
+require File.join File.dirname(__FILE__), 'storage_test_base'
+
+class MemCacheStorageTest < Test::Unit::TestCase
+  include StorageTestBase
+  include SetupHelper
+
+  def setup
+    Bandit.setup do |config|
+      config.player = "round_robin"
+      config.storage = 'memcache'
+      config.storage_config = CONFIG['memcache_storage_config']
+    end
+    
+    @storage = Bandit.storage
+  end
+end

data/test/memory_storage_test.rb

@@ -0,0 +1,16 @@
+require File.join File.dirname(__FILE__), 'helper'
+require File.join File.dirname(__FILE__), 'storage_test_base'
+
+class MemoryStorageTest < Test::Unit::TestCase
+  include StorageTestBase
+  include SetupHelper
+
+  def setup
+    Bandit.setup do |config|
+      config.player = "round_robin"
+      config.storage = 'memory'
+    end
+    
+    @storage = Bandit.storage
+  end
+end

data/test/redis_storage_test.rb

@@ -0,0 +1,17 @@
+require File.join File.dirname(__FILE__), 'helper'
+require File.join File.dirname(__FILE__), 'storage_test_base'
+
+class MemCacheStorageTest < Test::Unit::TestCase
+  include StorageTestBase
+  include SetupHelper
+
+  def setup
+    Bandit.setup do |config|
+      config.player = "round_robin"
+      config.storage = 'redis'
+      config.storage_config = CONFIG['redis_storage_config']
+    end
+    
+    @storage = Bandit.storage
+  end
+end

data/test/storage_test_base.rb

@@ -0,0 +1,54 @@
+require 'date'
+
+module StorageTestBase
+  def teardown
+    @storage.clear!
+  end
+
+  def test_participant_storage
+    exp = new_experiment
+    alt = exp.alternatives.first
+
+    start = Bandit::DateHour.now
+    @storage.incr_participants(exp, alt)
+    assert_equal @storage.participant_count(exp, alt), 1
+    @storage.incr_participants(exp, alt, 2)
+    assert_equal @storage.participant_count(exp, alt), 3
+    assert_equal @storage.participant_count(exp, alt, Bandit::DateHour.now), 3
+
+    assert_equal @storage.alternative_start_time(exp, alt), start
+
+    future = Bandit::DateHour.new(Date.today, Time.now.hour+3)
+    @storage.incr_participants(exp, alt, 123, future)
+    assert_equal @storage.participant_count(exp, alt, future), 123
+
+    assert_equal @storage.participant_count(exp, "nonexistant"), 0
+  end
+
+  def test_conversion_storage
+    exp = new_experiment
+    alt = exp.alternatives.first
+
+    @storage.incr_conversions(exp, alt)
+    assert_equal @storage.conversion_count(exp, alt), 1
+    @storage.incr_conversions(exp, alt, 2)
+    assert_equal @storage.conversion_count(exp, alt), 3
+    assert_equal @storage.conversion_count(exp, alt, Bandit::DateHour.now), 3
+
+    future = Bandit::DateHour.new(Date.today, Time.now.hour+3)
+    @storage.incr_conversions(exp, alt, 123, future)
+    assert_equal @storage.conversion_count(exp, alt, future), 123
+
+    assert_equal @storage.conversion_count(exp, "nonexistant"), 0
+  end
+
+  def test_player_storage
+    player = Bandit.player
+    exp = new_experiment
+
+    @storage.player_state_set(exp, player, "something", 123)
+    assert_equal @storage.player_state_get(exp, player, "something"), 123
+    
+    assert_equal @storage.player_state_get(exp, player, "nonexistant"), nil
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bandit
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Brian Muller
@@ -15,10 +15,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-05 00:00:00 -04:00
+date: 2011-08-13 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 3
+        - 0
+        - 5
+        version: 3.0.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: Bandit provides a way to do multi-armed bandit optimization of alternatives in a rails website
 email: 
 - brian.muller@livingsocial.com
@@ -31,11 +60,57 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
 - README.rdoc
 - Rakefile
 - bandit.gemspec
 - lib/bandit.rb
+- lib/bandit/config.rb
+- lib/bandit/date_hour.rb
+- lib/bandit/exceptions.rb
+- lib/bandit/experiment.rb
+- lib/bandit/extensions/controller_concerns.rb
+- lib/bandit/extensions/string.rb
+- lib/bandit/extensions/time.rb
+- lib/bandit/extensions/view_concerns.rb
+- lib/bandit/memoizable.rb
+- lib/bandit/players/base.rb
+- lib/bandit/players/epsilon_greedy.rb
+- lib/bandit/players/round_robin.rb
+- lib/bandit/storage/base.rb
+- lib/bandit/storage/memcache.rb
+- lib/bandit/storage/memory.rb
+- lib/bandit/storage/redis.rb
 - lib/bandit/version.rb
+- lib/generators/bandit/USAGE
+- lib/generators/bandit/dashboard_generator.rb
+- lib/generators/bandit/install_generator.rb
+- lib/generators/bandit/templates/bandit.rake
+- lib/generators/bandit/templates/bandit.rb
+- lib/generators/bandit/templates/bandit.yml
+- lib/generators/bandit/templates/bandit_controller.rb
+- lib/generators/bandit/templates/dashboard/bandit.html.erb
+- lib/generators/bandit/templates/dashboard/css/application.css
+- lib/generators/bandit/templates/dashboard/css/base.css
+- lib/generators/bandit/templates/dashboard/css/toupee/buttons.css
+- lib/generators/bandit/templates/dashboard/css/toupee/forms.css
+- lib/generators/bandit/templates/dashboard/css/toupee/modules.css
+- lib/generators/bandit/templates/dashboard/css/toupee/reset.css
+- lib/generators/bandit/templates/dashboard/css/toupee/structure.css
+- lib/generators/bandit/templates/dashboard/css/toupee/typography.css
+- lib/generators/bandit/templates/dashboard/helpers/bandit_helper.rb
+- lib/generators/bandit/templates/dashboard/js/bandit.js
+- lib/generators/bandit/templates/dashboard/js/highstock.js
+- lib/generators/bandit/templates/dashboard/js/jquery.min.js
+- lib/generators/bandit/templates/dashboard/view/index.html.erb
+- lib/generators/bandit/templates/dashboard/view/show.html.erb
+- players.rdoc
+- test/config.yml
+- test/helper.rb
+- test/memcache_storage_test.rb
+- test/memory_storage_test.rb
+- test/redis_storage_test.rb
+- test/storage_test_base.rb
 has_rdoc: true
 homepage: https://github.com/bmuller/bandit
 licenses: []
@@ -70,5 +145,10 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Multi-armed bandit testing in rails
-test_files: []
-
+test_files: 
+- test/config.yml
+- test/helper.rb
+- test/memcache_storage_test.rb
+- test/memory_storage_test.rb
+- test/redis_storage_test.rb
+- test/storage_test_base.rb