experiment 0.3.2 → 0.3.3

data/Manifest.txt

@@ -12,7 +12,8 @@ lib/experiment/generator/Rakefile
 lib/experiment/base.rb
 lib/experiment/notify.rb
 lib/experiment/work_server.rb
-lib/experiment/distributed.rb
+lib/experiment/distributed/master.rb
+lib/experiment/distributed/slave.rb
 lib/experiment/factorial.rb
 lib/experiment/params.rb
 test/test_experiment.rb

data/bin/experiment

@@ -8,7 +8,7 @@ require "rdoc/rdoc"
 require File.dirname(__FILE__) + "/../lib/experiment/runner"
 
 class App
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
   
   attr_reader :options
 

data/lib/experiment.rb

@@ -2,5 +2,5 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module Experiment
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/lib/experiment/base.rb

@@ -2,7 +2,8 @@ require File.dirname(__FILE__) + "/notify"
 require File.dirname(__FILE__) + "/stats/descriptive"
 require File.dirname(__FILE__) + "/config"
 require File.dirname(__FILE__) + "/params"
-require File.dirname(__FILE__) + "/distributed"
+require File.dirname(__FILE__) + "/distributed/slave"
+require File.dirname(__FILE__) + "/distributed/master"
 require 'benchmark'
 require "drb/drb"
 require "yaml"
@@ -12,8 +13,6 @@ module Experiment
   # @author Jakub Hampl
   # @see https://github.com/gampleman/Experiment/wiki/Designing-your-experiment
   class Base
-
-    include Distributed
     
     @@cleanup_raw_files = false
     
@@ -30,22 +29,24 @@ module Experiment
     # Called internally by the framewrok
     # @private
     # @param [:normal, :master, :slave] mode
-    # @param [String] experiment name
+    # @param [String] experiment Name of the experimental condition.
+    # @param [OpenStruct] options Most of the options passed from the CLI.
   	def initialize(mode, experiment, options)
   		@experiment = experiment
   		@options = options
+  		# a bit of dependency injection here
   		case mode
-  		  
   		when :normal
   		  @abm = [] 
-  		  
 		  when :master
 		    @abm = []
 		    extend DRb::DRbUndumped
+		    extend Distributed::Master
 		    @done = false
 	    when :slave
-		    
+		    extend Distributed::Slave
   		end
+  		
   		Experiment::Config::load(experiment, options.opts, options.env)
   		@mode = mode
   	end
@@ -79,7 +80,7 @@ module Experiment
     
     # runs the whole experiment, called by the framework
     # @private
-  	def normal_run!(cv)
+  	def run!(cv)
   		@cvs = cv || 1
       @results = {}
   		Notify.started @experiment

data/lib/experiment/distributed/master.rb

@@ -0,0 +1,63 @@
+module Experiment
+  # It incorporates most of the logic required for distributed
+  # computing support.
+  # @see https://github.com/gampleman/Experiment/wiki/Distributed-Mode
+  # @private
+  module Distributed
+    # this module is included into base when running with --distributed
+    module Master
+      # Send work from the master server
+      # @return [Hash, false] either a spec what work to carry out or false 
+      #   when no work available
+      def get_work()
+    	  if cv = @started.index(false)
+    	    @started[cv] = true
+    	    {:cv => cv, :input => @data[cv], :dir => @dir, :options => Experiment::Config.to_hash, :cvs => cvs }
+    	  else
+    	    false
+        end
+      end
+
+      # returns true if all work has been disseminated
+      def distribution_done?
+        @started.all?
+      end
+
+      # Sends the result of the computation back to the master server.
+      # Called on the master server object.
+      def submit_result(cv, result, performance)
+        @completed[cv] = true
+        array_merge(@results, result)
+        @abm << performance
+        Notify.cv_done @experiment, cv
+        master_done! if @completed.all?
+      end
+
+      # Strats up the master server
+      def run!(cv)
+
+        @cvs = cv || 1
+        @results = {}
+    		Notify.started @experiment
+        split_up_data
+    		write_dir!
+    		@completed = (1..@cvs).map {|a| false }
+    		@started = @completed.dup
+      end
+
+      # Cleans up the master server after all work is done
+      def master_done!
+        @done = true
+        specification! true
+        summarize_performance!
+    		summarize_results! @results
+    		cleanup!
+    		Notify.completed @experiment
+
+    		#sleep 1
+        #DRb.stop_service
+      end
+      
+    end # module Master
+  end
+end

data/lib/experiment/distributed/slave.rb

@@ -0,0 +1,36 @@
+module Experiment
+  module Distributed
+    # this module is included into base when running as worker
+    module Slave
+      # master server DRb object
+      attr_accessor :master
+
+      # Main function. Will continously request work from the server,
+      # execute it and send back results, then loops to the beggining.
+      def run!(not_used_arg)
+        while work = @master.get_work
+          puts work.inspect
+          Experiment::Config.set work[:options]
+          @current_cv = work[:cv]
+          @dir = work[:dir]
+          @data = work[:input]
+          #@data = work[:input]
+          File.open(@dir + "/raw-#{@current_cv}.txt", "w") do |output|
+    			  @ouptut_file = output
+    			  run_the_experiment
+    			end
+    			result = analyze_result!(@dir + "/raw-#{@current_cv}.txt", @dir + "/analyzed-#{@current_cv}.txt")
+    			write_performance!
+    			@master.submit_result @current_cv, result, @abm.first
+        end
+
+      end
+      
+      
+      def test_data
+        @data
+      end
+      
+    end # Master
+  end
+end

data/lib/experiment/runner.rb

@@ -143,7 +143,7 @@ module Experiment
   			  require "./experiments/#{exp}/#{exp}"
   			  cla = eval(as_class_name(exp))
   				experiment = cla.new :normal, exp, @options
-  				experiment.normal_run! @options.cv
+  				experiment.run! @options.cv
   			end
 			  Notify::done
 		  end
@@ -199,7 +199,7 @@ module Experiment
   			  cla = eval(as_class_name(exp))
   				experiment = cla.new :slave, exp, @options
   			  experiment.master = @master.instance item
-  			  experiment.slave_run!
+  			  experiment.run! 0
         end
       end
 	  end

data/lib/experiment/work_server.rb

@@ -38,7 +38,7 @@ module Experiment
   				  @experiment_instances += subs
   				  return i + 1
 				  else
-  				  experiment.master_run! @options.cv
+  				  experiment.run! @options.cv
   				  @experiment_instances[i] = experiment
   				  return i
   				end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Jakub Hampl
@@ -75,7 +75,8 @@ files:
 - lib/experiment/base.rb
 - lib/experiment/notify.rb
 - lib/experiment/work_server.rb
-- lib/experiment/distributed.rb
+- lib/experiment/distributed/master.rb
+- lib/experiment/distributed/slave.rb
 - lib/experiment/factorial.rb
 - lib/experiment/params.rb
 - test/test_experiment.rb

data/lib/experiment/distributed.rb

@@ -1,98 +0,0 @@
-module Experiment
-# this module is included in Experiment::Base
-# It incorporates most of the logic required for distributed
-# computing support.
-# @see https://github.com/gampleman/Experiment/wiki/Distributed-Mode
-# @private
-module Distributed
-  
-  
-  # @group Called on slave
-  
-  # master server DRb object
-  attr_accessor :master
-  
-  # Main function. Will continously request work from the server,
-  # execute it and send back results, then loops to the beggining.
-  def slave_run!
-    while work = @master.get_work
-      puts work.inspect
-      Experiment::Config.set work[:options]
-      @current_cv = work[:cv]
-
-      @dir = work[:dir]
-      #@data = work[:input]
-      File.open(@dir + "/raw-#{@current_cv}.txt", "w") do |output|
-			  @ouptut_file = output
-			  run_the_experiment
-			end
-			result = analyze_result!(@dir + "/raw-#{@current_cv}.txt", @dir + "/analyzed-#{@current_cv}.txt")
-			write_performance!
-			@master.submit_result @current_cv, result, @abm.first
-    end
-
-  end
-  
-  
-  # @endgroup
-  
-  # @group Called on master
-  
-  # Send work from the master server
-  # @return [Hash, false] either a spec what work to carry out or false 
-  #   when no work available
-  def get_work()
-	  if cv = @started.index(false)
-	    @started[cv] = true
-	    {:cv => cv, :input => @data[cv], :dir => @dir, :options => Experiment::Config.to_hash }
-	  else
-	    false
-    end
-  end
-  
-  # returns true if all work has been disseminated
-  def distribution_done?
-    @started.all?
-  end
-  
-  # Sends the result of the computation back to the master server.
-  # Called on the master server object.
-  def submit_result(cv, result, performance)
-    @completed[cv] = true
-    array_merge(@results, result)
-    @abm << performance
-    Notify.cv_done @experiment, cv
-    master_done! if @completed.all?
-  end
-  
-  
-  
-  # Strats up the master server
-  def master_run!(cv)
-    
-    @cvs = cv || 1
-    @results = {}
-		Notify.started @experiment
-    split_up_data
-		write_dir!
-		@completed = (1..@cvs).map {|a| false }
-		@started = @completed.dup
-  end
-  
-  # Cleans up the master server after all work is done
-  def master_done!
-    @done = true
-    specification! true
-    summarize_performance!
-		summarize_results! @results
-		cleanup!
-		Notify.completed @experiment
-		
-		#sleep 1
-    #DRb.stop_service
-  end
-  
-  # @endgroup
-  
-end
-end