minor bug fixes, updated readme
[RBC.git] / readme.txt
index 4f683c9..8bb6a77 100644 (file)
@@ -1,4 +1,4 @@
-***Random Ball Cover (RBC) v0.2***
+ ***Random Ball Cover (RBC) v0.2.5***
 Lawrence Cayton
 lcayton@tuebingen.mpg.de
 
@@ -17,6 +17,7 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+
 ---------------------------------------------------------------------
 SUMMARY
 
@@ -30,7 +31,7 @@ algorithm and the theory behind it.
 * L. Cayton, A nearest neighbor data structure for graphics hardware.
 ADMS, 2010.
 * L. Cayton, Accelerating nearest neighbor search on manycore systems.
-Submitted. 
+Submitted, 2011
 
 
 ---------------------------------------------------------------------
@@ -47,6 +48,11 @@ A sample driver is provided for the RBC.  To try it out, type
 $ testRBC
 at the prompt and a list of options will be displayed.
 
+The sample driver can be used with either text or binary input.  The
+text input format is one database element per line, with features
+separated by spaces.  The binary input format is in floats, but can be
+changed to doubles.  
+
 The output file format is a list of the queries' NNs,
 followed by a list of the distances to those NNs.  Note that by
 default, all input and output is stored in single-precision (float)
@@ -54,17 +60,34 @@ format.
 
 Basic functionality is provided through this driver, but I recommend
 integrating the RBC code directly into your code for the best
-results.  In particular, the best way to use the current
-implementation is to build the RBC once, then query it many times.
+results.  For many applications, the RBC needs to be built only once,
+and then can be queried many times. 
 
 The method requires a single parameter, the number of
-representatives.  This parameter allows one to trade-off between
+representatives.  This parameter allows you to trade-off between
 search quality and search speed.  The best way to set this parameter
 is to try a few different values out; a good starting point is
 generally 5*sqrt(n), where n is the number of database points.  Use
-the eval option (-e) to print out the error rate.  See the paper for
-detailed information on this parameter. 
+the eval option (-e) to print out the error rate.  See the paper
+(Cayton, 2011) for detailed information on this parameter. 
+
+The sample_input directory contains examples in both binary and
+text.  The sample_db set contains 1024 points, each of which has 16
+dimensions.  The sample_query set contains 128 sample queries (which
+of course also have 16 dimensions).  To try it out, run 
+
+$ testRBC -X sample_input/sample_db.txt -Q sample_input/sample_queries.txt -n 1024 -m 128 -d 16 -r 128
+
+or to try it out with the binary files, run
+
+$ testRBC -x sample_input/sample_db.bin -q sample_input/sample_queries.bin -n 1024 -m 128 -d 16 -r 128
 
+Note that the -r 128 descibes the number of representatives, which
+controls the accuracy of the search.  You might try varying this
+parameter to see the effects (there is nothing special about 128).
+You can print out the accuracy using by adding the -e switch; this
+will say the average number of the 32 nearest neighbors that were
+actually returned.  
 
 ---------------------------------------------------------------------
 FILES
@@ -79,6 +102,7 @@ FILES
 * kernelWrap.{h,cu} -- CPU wrapper code around the kernels.
 * rbc.{h,cu} -- the core of the RBC data structure.  Includes the
   implementation of build and search algorithms.
+* rbc_include.h -- header file to include in your driver.
 * sKernel.{h,cu} -- implementation of the kernel functions related to
   the parallel scan algorithm (used within the build method).
 * sKernelWrap.{h,cu} -- wrappers for the kernels in sKernel.
@@ -89,12 +113,12 @@ FILES
 ---------------------------------------------------------------------
 MISC NOTES ON THE CODE
 
-* The code currently computes distance using the L_1 (manhattan)
+* The code currently computes distance using the L_2 (Euclidean)
   metric.  If you wish to use a different notion of distance, you must
   modify defs.h.  It is quite simple to switch to any metric that 
   operates alongs the coordinates independently (eg, any L_p metric),
-  but more complex metrics will require some aditional work.  The L_2
-  metric (standard Euclidean distance) is already defined in defs.h.  
+  but more complex metrics will require some aditional work.  The L_1
+  metric (manhatten distance) is already defined in defs.h.  
 
 * The k-NN code is currently hard-coded for k=32.  It is hard-coded
   because it uses a manually implemented sorting network. This design
@@ -113,29 +137,19 @@ MISC NOTES ON THE CODE
 typedef double real;
 #define MAX_REAL DBL_MAX
 
-and comment out the lines
+  and comment out the lines
 
 typedef float real;
 #define MAX_REAL FLT_MAX
 
-Then, you must do a 
+  Then, you must add the compiler flag
+-arch=sm_20
+  to the NVCCFLAGS line of the Makefile (or sm_13 for older GPUs).
 
-make clean
+  Finally, do a 
+$ make clean
+  followed by another make.
 
-followed by another make.
-
-* This software has been tested on the following graphics cards:
-  NVIDIA GTX 285, GT 430, GTX 480
-  NVIDIA Tesla c2050.
-
-* This sotware has been tested under the following software setup:
-  Ubuntu 10.04 (linux)
-  gcc 4.4
-  cuda 3.1
-
-  It has been reported to work under Mac OSX.  Please share your
-  experience getting it to work under Windows!
 * For the most part, device variables (ie arrays residing on the GPU)
   begin with a lowercase d.  For example, the device version of the 
   DB variable x is dx.  
@@ -151,6 +165,17 @@ followed by another make.
   would require only minor changes to the code, though is currently 
   untested.
 
+* This software has been tested on the following graphics cards:
+  NVIDIA GTX 285, GT 430, GTX 480, GeForce 320M, Tesla c2050
+
+* This sotware has been developed under the following software setup:
+  Ubuntu 10.04 (linux)
+  gcc 4.4
+  cuda 3.2
+
+  It has also been tested under Mac OSX.  Please share your
+  experience getting it to work under Windows!
 * If you are running this code on a GPU which is also driving your
   display: A well-known issue with CUDA code in this situation is that 
   a process within the operating system will automatically kill