From dd0d46d77293df2855e1d5287b561f7a2890a96e Mon Sep 17 00:00:00 2001 From: Samuel Fadel Date: Thu, 10 Mar 2016 12:39:12 -0300 Subject: Updated README. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 82449d3..4f85d2d 100644 --- a/README.md +++ b/README.md @@ -32,14 +32,17 @@ This program needs a CUDA-enabled GPU (not necessarily powerful) to run. ./pm [options] dataset ## Options +Options accepted are: Option | Description -------------------------| -------------------------------------------------------------------------------------------- --h, --help | Displays this help. +-h, --help | Displays usage. -v, --version | Displays version information. -i, --indices | Filename to store the control points' indices. Omitting this option disables saving indices. -c, --cpoints | Filename to store the control points' map. Omitting this option disables saving this map. +And the arguments are: + Argument | Description ---------|----------------------------- dataset | Dataset filename (.tbl file) @@ -55,4 +58,6 @@ else. Note that the number of lines of this file and the indices file are supposed to be the same. **Dataset files** are the same as CP map files, except they are allowed to have -any number of columns (the same number of columns in each line, though). +any number of columns. In addition, the last column is assumed to be the class +labels (currently unused, but must be present). Node that the number of columns +must be the same on each line. -- cgit v1.2.3