Add more description for readme

hical · Jul 9, 2018 · ffd8681 · ffd8681
1 parent 92b328e
commit ffd8681
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,14 @@
+# Description of sampled test collection
 The text collection in this repository is a sample of the Athome4 collection,
 which was used in the TREC 2016 Total Recall Track [1]. The original dataset
 contains 290,000 Jeb Bush emails and 34 topics. 
 
-We provided 9 topics (`athome4.topics.sample`), some sampled documents 
-(`athome4_sample.tgz`), and some relevance judgments (`athome4.qrel.sample`) 
-for this sampled test collection.
+We provided 9 topics (`athome4.topics.sample`), 50000 sampled documents 
+(`athome4_sample.tgz`), and sampled relevance judgments (`athome4.qrel.sample`) for this sampled test collection.
+
+# Extract paragraphs for full documents
+```bash
+python3 process.py athome4_sample.tgz
+```
 
 [1] Grossman, Maura R., Gordon V. Cormack, and Adam Roegiest. "TREC 2016 Total Recall Track Overview." TREC. 2016.
diff --git a/process.py b/process.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 """ Preprocess the sample dataset
-Usage: python process.py ./athome4_test.tgz
+Usage: python process.py athome4_sample.tgz
 """
 
 import sys