################################################################################
# This is the README file for tools shipped with RVKDE written in Dokuwiki
# syntax.

====== Abstract ======
This directory includes some useful tools:
  * Parameter selection (//kde-grid.pl//)
  * Automation (//kde-easy.pl//)

====== kde-grid.pl usage ======
<code>
kde-grid.pl is a parameter selection tool for RVKDE. It uses cross validation
technique to estimate the performance of each parameter combination in the
specified range and helps you to decide the best parameters for your problem.
Make sure the rvkde binary executable file is in the parent directory of this
script.

Options:
  -a  begin(,end(,step)) of alpha values in kernel function (default: 1)
  -b  begin(,end(,step)) of beta values in kernel function (default 1,5,.5)
  -h  print this help, then exit
  -s  begin(,end(,step)) of ks values in kernel function (default: 1,30)
  -t  begin(,end(,step)) of kt values in kernel function (default: 1,30)
  -v  n: n-fold cross validation mode (default: 5)

Examples:
  kde-grid.pl heart.scale
  kde-grid.pl -t 30 heart.scale # set kt = 30
  kde-grid.pl -t 30,50 heart.scale # set kt = 30, 31, ... 50
  kde-grid.pl -t 30,50,2 heart.scale # set kt = 30, 32, ... 50

Report bugs to <darby@ee.ncku.edu.tw>.
</code>

====== kde-easy.pl usage ======
<code>
Usage: kde-easy.pl TRAINING_FILE [TESTING_FILE]
kde-easy.pl is designed for users who know NOTHING about RVKDE. It makes
everything automatic, from data manipulation to parameter selection.  Make sure
the rvkde binary executable file is in the parent directory of this script.

Examples:
  kde-easy.pl heart.scale
  kde-easy.pl heart.scale heart.scale.t

Report bugs to <darby@ee.ncku.edu.tw>.
</code>
