Removed the definition of basename, which confuses an existing system one.
[folded-ctf.git] / README.txt
index c4717a0..61d8446 100644 (file)
@@ -6,16 +6,16 @@ INTRODUCTION
   the folded hierarchy of classifiers for cat detection described in
 
      F. Fleuret and D. Geman, "Stationary Features and Cat Detection",
-     Journal of Machine Learning Research (JMLR), 2008, to appear.
+     Journal of Machine Learning Research (JMLR), 9, 2549-2578, 2008.
 
-  Please use that citation and the original URL
+  Please use that citation and the URL
 
-     http://www.idiap.ch/folded-ctf
+     http://www.idiap.ch/folded-ctf/
 
   when referring to this software.
 
-  Contact Francois Fleuret at fleuret@idiap.ch for comments and bug
-  reports.
+  Contact Francois Fleuret at francois.fleuret@idiap.ch for comments
+  and bug reports.
 
 INSTALLATION
 ------------
@@ -38,11 +38,11 @@ INSTALLATION
   You can run the full thing with the following commands if you have
   wget installed
 
-  > wget http://www.idiap.ch/folded-ctf/data/folding-gpl.tgz
-  > tar zxvf folding-gpl.tgz
+  > wget http://www.idiap.ch/folded-ctf/data/folding-v1.0.tgz
+  > tar zxvf folding-v1.0.tgz
   > cd folding
-  > wget http://www.idiap.ch/folded-ctf/data/rmk.tgz
-  > tar zxvf rmk.tgz
+  > wget http://www.idiap.ch/folded-ctf/data/rmk-v1.0.tgz
+  > tar zxvf rmk-v1.0.tgz
   > ./run.sh
 
   Note that for every round, we have to fully train a detector and run
@@ -55,8 +55,13 @@ INSTALLATION
   on several machines as long as they see the same result directory.
 
   When all or some of the experimental rounds are over, you can
-  generate the ROC curves by invoking the ./graph.sh script. You need
-  a fairly recent version of Gnuplot.
+  generate ROC curves by invoking ./graph.sh script. You need a fairly
+  recent version of Gnuplot.
+
+  If you pass the argument "pics" to the ./graphs.sh script, it will
+  save images from the data set with the ground truth plotted on them,
+  the pose-indexed referential, and examples of the pose-indexed
+  feature windows.
 
   This program was developed on Debian GNU/Linux computers with the
   following main tool versions
@@ -73,14 +78,12 @@ EXECUTING THE PROGRAM
 ---------------------
 
   The main command has to be invoked with a list of parameter values,
-  followed by commands to execute.
-
-  To set the value of a parameter, just add an argument of the form
-  --parameter-name=value before the commands that should take it into
-  account.
+  followed by commands to execute. A parameter value is modified by
+  adding an argument of the form --parameter-name=value.
 
   For instance, to open a scene pool ./something.pool, train a
-  detector and save it, you would do
+  detector and save it with all other parameters kept at their default
+  value, you would do
 
     ./folding --pool-name=./something.pool open-pool train-detector write-detector