batch_experiment 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bfaf4a6fa10230872eb47786f5ed25caef9866c
-  data.tar.gz: 5c2d57dbc5487a37d409bd6c9454177f16d44cae
+  metadata.gz: e2281f50d62e17b6584f76c6ee3a06b15ad3f95e
+  data.tar.gz: 6e75c67a2776de460de325dff16620cf5e1297b4
 SHA512:
-  metadata.gz: e53e5c263fca88c5389268e2d8e2aafd8491bf100d3ad3888d84024ba7f515e4797ef7856fd0f03274274f563e3263a5bb5d55a1e336210e3e770409ca52e377
-  data.tar.gz: f4d4741012d48a9383ac7cd73013ab40ab86d0dcbd98d7b55cee2b0ae6c3ffe790c1662d60ab2093249a4d41a720c2705a3615198ce4aae4239a5ecc1da52c2e
+  metadata.gz: 697c5f3cb314baed7e726e03c9627d76c3cb5f47709d666d48169b9f9bb6f79bd4c3f713e10ab738bb35bd312fa5ab9be2cce290da0fc701ccbb2157fb09826a
+  data.tar.gz: de6fa0170a1d52371e9b5799432e9915f9e9256eb76c425a520a27e217e90fa6c0e3d3709212acf3b4b52fc6244a1c6ec9b06eac321e617f42caecf184452e23

data/README.md

@@ -15,11 +15,11 @@ What conditions you need to use this tool:
 
 What is not needed:
 
-* To know how to program in ruby. Only taking less than 5 minutes to learn some basic syntax will suffice to run commands on multiple cores and save the results to files (using BatchExperiment::batch). However, if you want not only to execute the commands but want to extract and group some information from their output to a CVS (using BatchExperiment::experiment), you will need to tell ruby how to do the extracting part.
+* To know how to program in ruby. Only taking less than 5 minutes to learn some basic syntax will suffice to run commands on multiple cores and save the results to files (using BatchExperiment::batch). However, if you want not only to execute the commands but want to extract and group some information from their output to a CSV (using BatchExperiment::experiment), you will need to tell ruby how to do the extracting part.
 
 ## How to use it
 
-You will need to create a ruby script (copy, past and adapt one of the provided examples), give it execution permissions ("chmod +x script.rb"), and execute it ("./script.rb"). It's good to remember that this will probably flood the folder from were you called the command with files containing the output of the commands. Also good to remember that the commands will be called from the folder where you called the script, so they probably will expect that any relative paths/filenames given to them to be relative to the current folder.
+You will need to create a ruby script (copy, past and adapt one of the provided examples), give it execution permissions ("chmod +x script.rb"), and execute it ("./script.rb"). It's good to remember that, if you didn't created a folder for the output files and set the :output_dir configuration to it, the script will probably flood your current folder with the output files. Also, good to remember that, if you didn't set the :cwd configuration, the commands will be called from the folder where you called the script, so they probably will expect that any relative paths/filenames given to them to be relative to the current folder.
 
 ## Examples
 
@@ -33,7 +33,7 @@ require 'batch_experiment'
 commands = [
   'sleep 2 && echo orange',
   'sleep 4 && echo banana',
-  'sleep 100 && echo "never gonna happen"',
+  'sleep 100 && echo "never gonna happen"', # killed by timeout
 ]
 
 conf = {

data/examples/ukp_experiment.rb

@@ -25,6 +25,8 @@ execution_info = {
   cpus_available: [1, 2, 3],
   timeout: 10,
   post_timeout: 2,
+  cwd: '/home/henrique/AreaDeTrabalho/masters/data/ukp/',
+  output_dir: '/home/henrique/AreaDeTrabalho/tmp/',
 }
 
 conf = {
@@ -36,8 +38,6 @@ conf = {
 files = ['corepb.ukp', 'exnsd18.ukp', 'exnsd26.ukp', 'exnsdbis18.ukp', 'exnsd16.ukp', 'exnsd20.ukp', 'exnsdbis10.ukp', 'exnsds12.ukp']
 # If you don't execute the script from the ukp files folder you need to put the
 # folder relative or absolute path here (with trailing slash).
-path = '~/Aulas/mestrado/masters/data/ukp/'
-files.map! { | f | path + f }
 
 BatchExperiment::experiment(comms_info, execution_info, conf, files)
 

data/lib/batch_experiment.rb

@@ -136,6 +136,12 @@ module BatchExperiment
   #   Default: '.out'.
   #   -- err_ext [String] Extension to be used in place of '.err'.
   #   Default: '.err'.
+  #   -- cwd [String] Command Working Directory. The path from where the
+  #   commands will be executed. Default: './' (i.e. the same directory from
+  #   where the ruby script was run).
+  #   -- output_dir [String] The folder used to save the
+  #   '.out'/'.err'/'.unfinished' files. Default: './' (i.e. the same directory
+  #   from where the ruby script was run).
   #
   # @return [String] Which commands were executed. Can be different from
   #   the 'commands' argument if commands are skipped (see :skip_done_comms).
@@ -174,6 +180,8 @@ module BatchExperiment
     conf[:post_timeout]     ||= 5
     conf[:converter]        ||= BatchExperiment::Comm2FnameConverter.new
     conf[:skip_done_comms]    = true if conf[:skip_done_comms].nil?
+    conf[:cwd]              ||= './'
+    conf[:output_dir]       ||= './'
 
     # Initialize main variables
     free_cpus = conf[:cpus_available].clone
@@ -183,9 +191,9 @@ module BatchExperiment
 
     commands.each do | command |
       commfname = conf[:converter].call(command)
-      out_fname = commfname + conf[:out_ext]
-      err_fname = commfname + conf[:err_ext]
-      lockfname = commfname + conf[:unfinished_ext]
+      out_fname = conf[:output_dir] + commfname + conf[:out_ext]
+      err_fname = conf[:output_dir] + commfname + conf[:err_ext]
+      lockfname = conf[:output_dir] + commfname + conf[:unfinished_ext]
 
       if conf[:skip_done_comms] && File.exists?(out_fname)
         if File.exists?(lockfname)
@@ -216,10 +224,11 @@ module BatchExperiment
         'sh', '-c', command
       )
 
+      cproc.cwd = conf[:cwd]
+
       File.open(lockfname, 'w') {} # empty on purpose
       out = File.open(out_fname, 'w')
       err = File.open(err_fname, 'w')
-
       cproc.io.stdout = out
       cproc.io.stderr = err
 
@@ -398,8 +407,9 @@ module BatchExperiment
     #conf[:skip_commands] defaults to false/nil
 
     # Get some of the batch config that we use inside here too.
-    out_ext         = batch_conf[:out_ext] || '.out'
+    out_ext         = batch_conf[:out_ext]        || '.out'
     unfinished_ext  = batch_conf[:unfinished_ext] || '.unfinished'
+    output_dir      = batch_conf[:output_dir]     || './'
     converter = batch_conf[:converter].clone unless batch_conf[:converter].nil?
     converter ||= BatchExperiment::Comm2FnameConverter.new
 
@@ -480,14 +490,14 @@ module BatchExperiment
       curr_line = [algorithm, filename, run_number]
 
       partial_fname = converter.call(exp_comm)
-      out_fname = partial_fname + out_ext
-      lockfname = partial_fname + unfinished_ext
+      out_fname = output_dir + partial_fname + out_ext
+      lockfname = output_dir + partial_fname + unfinished_ext
       extractor = run_info[:comm_info][:extractor]
 
       if File.exists?(out_fname)
         if File.exists?(lockfname)
           puts "Ignored file '#{out_fname}' because there was a"
-             + "  '#{lockfname}' file in the same folder."
+             + "  '#{lockfname}' file too."
         else
           f_content = File.open(out_fname, 'r') { | f | f.read }
           curr_line << extractor.extract(f_content)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch_experiment
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Henrique Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -66,4 +66,3 @@ specification_version: 4
 summary: A ruby script that distributes system commands between cpu cores, and save
   their output.
 test_files: []
-has_rdoc: