From fadfc40533427074ffa1bb7e90b0d97d313b1274 Mon Sep 17 00:00:00 2001 From: Jimmy Lin Date: Sun, 16 Jun 2019 22:32:42 -0400 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cebaced..8d4efb9 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,15 @@ python3 run.py search --repo jass/osirrc2019 --collection robust04 --topic topi --> # OSIRRC Docker Image for JASS [![Generic badge](https://img.shields.io/badge/DockerHub-go%21-yellow.svg)](https://hub.docker.com/r/osirrc2019/jass) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3247163.svg)](https://doi.org/10.5281/zenodo.3247163) [**Andrew Trotman**](https://github.com/andrewtrotman) This readme is heavily based (i.e. copied from) the Anserini readme. This is the docker image for [JASS](https://github.com/andrewtrotman/JASSv2/tree/master/JASSv1) conforming to the [OSIRRC jig](https://github.com/osirrc/jig/) for the [Open-Source IR Replicability Challenge (OSIRRC) at SIGIR 2019](https://osirrc.github.io/osirrc2019/). -This image is has been tested with the jig at commit [ca31987](https://github.com/osirrc/jig/commit/ca3198704795f2b6de8b78ed7a66bbdf1dccadb1) (6/5/2019). +This image is available on [Docker Hub](https://hub.docker.com/r/osirrc2019/jass). +The [OSIRRC 2019 image library](https://github.com/osirrc/osirrc2019-library) contains a log of successful executions of this image. JASS is not a fully stand along search system. It is just the search engine. It relies on [ATIRE](http://atire.org) for indexing and other services. As JASS has been forked several times, this is the verson seen in the [JASSv2](https://github.com/andrewtrotman/JASSv2) repo. @@ -29,7 +31,13 @@ python3 run.py prepare \ --tag v0.1.0 \ --collections robust04=/path/to/disk45=trectext ``` -e.g. ```python3 run.py prepare --repo jass/osirrc2019 --collections robust04=/Users/andrew/programming/JASSv2/docker/osirrc2019/robust04=trectext``` + +For example: + +``` +python3 run.py prepare --repo jass/osirrc2019 \ + --collections robust04=/Users/andrew/programming/JASSv2/docker/osirrc2019/robust04=trectext +``` The following `jig` command can be used to perform a retrieval run on the collection with the `robust04` test collection. @@ -43,7 +51,13 @@ python3 run.py search \ --top_k 100" ``` -e.g. ```python3 run.py search --repo jass/osirrc2019 --collection robust04 --topic topics.robust04.301-450.601-700.txt --top_k 100 --output /Users/andrew/programming/osirrc2019/jass-docker/output --qrels qrels/qrels.robust2004.txt``` +For example: + +``` +python3 run.py search --repo jass/osirrc2019 --collection robust04 \ + --topic topics.robust04.301-450.601-700.txt --top_k 100 \ + --output /Users/andrew/programming/osirrc2019/jass-docker/output --qrels qrels/qrels.robust2004.txt +``` ## Retrieval Methods This instance of JASS uses BM25 from ATIRE with the defailt parameters. JASS requires an impact ordered index which is generated by ATIRE then converted into the [JASS index format](https://github.com/andrewtrotman/JASSv2/wiki/JASSv1)