automatic commit
[folded-ctf.git] / README.txt
index c4717a0..3b37296 100644 (file)
@@ -8,7 +8,7 @@ INTRODUCTION
      F. Fleuret and D. Geman, "Stationary Features and Cat Detection",
      Journal of Machine Learning Research (JMLR), 2008, to appear.
 
      F. Fleuret and D. Geman, "Stationary Features and Cat Detection",
      Journal of Machine Learning Research (JMLR), 2008, to appear.
 
-  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
 
@@ -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
   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
 
   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,
 ---------------------
 
   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
 
   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
 
 
     ./folding --pool-name=./something.pool open-pool train-detector write-detector