Update README.md

osirrc · May 10, 2019 · dd4fbde · dd4fbde
1 parent b515b64
commit dd4fbde
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,21 @@
 # Running
 Use the commands below to run the image from the [jig](https://github.com/osirrc2019/jig) directory, updating the corpus details as appropriate.
 
+The following corpus are supported:
+- `core17`
+- `core18`
+- `robust04`
+
 ## Prepare
+The following `jig` command can be used to index `robust04`:
 ```
 python run.py prepare \
   --repo osirrc2019/anserini \
   --collections robust04=/home/ryan/sync/ir/collections/disk45=trectext
 ```
 
 ## Search
+The following `jig` command can be used to perform a search over `robust04`.
 ```
 python run.py search \
   --repo osirrc2019/anserini \
@@ -18,3 +25,4 @@ python run.py search \
   --collection robust04 \
   --opts search_args="-bm25" out_file_name="run.bm25.robust04"
 ```
+Note: `search_args` and `out_file_name` can be updated for other algorithms (i.e., `search_args="-ql -rm3"` and `out_file_name="run.ql.rm3.robust04"`)