WSDShell v-0.05
                ===============

1. Introduction
===============

WSDShell is a set of programs and wrapper scripts for running supervised
word sense disambiguation (WSD) experiments in batch mode on any WSD 
collection adhering to a specified format and directory structure. 

2. Pre-requisites
=================

For WSDShell programs to function, the following software must be correctly
installed on your system, with the appropriate paths added to your
PATH variable and Java CLASSPATH variable:

* N-gram Statistics Package - V 0.71
  (Available at http://www.d.umn.edu/~tpederse/nsp.html)
* SenseTools - V 0.3
  (Available at http://www.d.umn.edu/~tpederse/sensetools.html)
* The WEKA Data Mining Suite 
  (Available at http://www.cs.waikato.ac.nz/ml/weka/)

3. Installation
===============

After downloading the file wsdshell-vVERSION.tar.gz to a directory where you 
have write permissions, run the following command -

    gzip -cd wsdshell-vVERSION.tar.gz | tar xvf -

Replace the VERSION with the version number you have downloaded.

This will extract the files in a directory named wsdshell/. Move this 
directory to the desired location and add the following directories to
your path variable:

    /your/full/path/wsdshell/bin
    /your/full/path/wsdshell/utils
    
Replace the "/your/full/path" string with the appropriate prefix.

This makes the wsdshell scripts accessible from any working directory, which
is required.

The program files that are installed are as follows (relative to the root
wsdshell/ directory):

* bin/wsdshell.pl - The main program file which invokes SenseTools, 
  NSP and Weka
* bin/wsdshelldriver.pl - Wrapper to call wsdshell.pl for a WSD 
  collection
* bin/runtests.pl - Wrapper to call wsdshelldriver.pl for a set of 
  experiments with an WSD collection
* bin/wsdsummary.pl - Program to extract summary information out of 
  the various conducted experiments
* utils/createcopies.pl - Creates multiple test copies of the WSD collection
* utils/copytestdirs.pl - Creates copies of mutiple test directories

4. Usage
========

Run `wsdshell.pl --help` for a list of options and `perldoc wsdshell.pl`
for a more detailed explanation. The other scripts in the package also
include similar command line help.

5. Additional Information
=========================

Additional information about the experiments we have performed using WSDShell
can be found in the paper: "A Comparative Study of Support Vector Machines 
Applied to the Supervised Word Sense Disambiguation Problem in the Medical 
Domain" - http://www.d.umn.edu/~joshi031/files/joshi-pedersen-wsd.pdf.

Some results that we have obtained (output of wsdsummary.pl) can be found at:
http://www.d.umn.edu/~joshi031/files/wsdshell/results/results.txt

The latest version of WSDShell can be obtained from:
http://www.d.umn.edu/~joshi031/files/wsdshell

6. Copyright Notice 
===================

Copyright (C) 2005, Ted Pedersen and Mahesh Joshi

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
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, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.