----------------------------------------------------------------
NIST - TREC - Video Track - Known-items tasks evaluation program
----------------------------------------------------------------

---------
0-Purpose
---------
This program is design to evaluate the results of known-items submission files.

---------------------
1-System Requirements
---------------------
This small program requires :
	- JDK 1.1.8 or later (including any version of Java 2 : http://java.sun.com/j2se/1.3/)

--------------
2-Installation
--------------
1. Download the tar file
2. Untar the file

The content of tar file should be (all untar in a KISoft folder) :

-Readme.txt, 
-KI_Eval.jar,
-Reference directory with 74 reference files (Reference),
-ComparisonResult directory with 2 DTD files,
-System directory with 2 DTD files and a system file example (input_example.xml),
-xerces-1_4_4 directory (Xml parser).

-------------
3. Running it
-------------
-Make sure that your result file follow the Xml structure defined in the
2 DTD file in System directory (videoSearchResults.dtd and videoSearchResult.dtd)
by adding the following line at the beginnig of your file:

<!DOCTYPE videoSearchResults SYSTEM "videoSearchResults.dtd">

-Run:

java -jar KI_eval

	It will gives instructions on how to use the 2 two parameter to control 
	the sufficient overlapping of the know-item (reference item) and the
	submitted item (system item).
	2 parameters are -pRef and -pSys: to be used with the desired values as:
	
java -jar KI_Eval myFile.xml -pRef0.6666 -pSys0.3333

-The output will be in a directory corresponding to each sysId provided in the input file
and also one directory per different values use for pRef and pSys.

