Home

Awesome

OSIRRC Docker Image for Anserini

Build Status Docker Build Status DOI

Ryan Clancy and Jimmy Lin

This is the docker image for the Anserini toolkit (v0.5.1) conforming to the OSIRRC jig for the Open-Source IR Replicability Challenge (OSIRRC) at SIGIR 2019. This image is available on Docker Hub. The OSIRRC 2019 image library contains a log of successful executions of this image.

Quick Start

The following jig command can be used to index TREC disks 4/5 for robust04:

python run.py prepare \
  --repo osirrc2019/anserini \
  --tag v0.1.1 \
  --collections robust04=/path/to/disk45=trectext

The following jig command can be used to perform a retrieval run on the collection with the robust04 test collection.

python run.py search \
  --repo osirrc2019/anserini \
  --tag v0.1.1 \
  --output out/anserini \
  --qrels qrels/qrels.robust04.txt \
  --topic topics/topics.robust04.txt \
  --collection robust04 \
  --opts search_args="-bm25" out_file_name="run.bm25.robust04"

The arguments search_args and out_file_name can be customized (i.e., search_args="-ql -rm3" and out_file_name="run.ql.rm3.robust04")

Retrieval Methods

The Anserini image supports the following retrieval methods:

Expected Results

The following numbers should be able to be re-produced using the scripts provided in the bin directory.

robust04

MAPBM25+RM3+AxQL+RM3+Ax
TREC 2004 Robust Track Topics0.25310.29030.28950.24670.27470.2774

core17

MAPBM25+RM3+AxQL+RM3+Ax
TREC 2017 Common Core Track Topics0.20870.28230.27870.20320.26060.2613

core18

MAPBM25+RM3+AxQL+RM3+Ax
TREC 2018 Common Core Track Topics0.24950.31360.29200.25260.30730.2966

gov2

MAPBM25+RM3+AxQL+RM3+Ax
TREC 2004 Terabyte Track: Topics 701-7500.26890.28440.26650.26810.27080.2666
TREC 2005 Terabyte Track: Topics 751-8000.33900.38200.36640.33030.35590.3646
TREC 2006 Terabyte Track: Topics 801-8500.30800.33770.30690.29960.31540.3084

cw09b

MAPBM25+RM3+AxQL+RM3+Ax
TREC 2010 Web Track: Topics 51-1000.11260.09330.09280.10600.10190.1086
TREC 2011 Web Track: Topics 101-1500.10940.10810.09740.09580.08370.0879
TREC 2012 Web Track: Topics 151-2000.11060.11070.13150.10690.10590.1212

cw12b

MAPBM25+RM3+AxQL+RM3+Ax
TREC 2013 Web Track: Topics 201-2500.04680.04120.04350.03970.03220.0359
TREC 2014 Web Track: Topics 251-3000.02240.02100.01800.02350.02030.0186

Implementation

The following is a quick breakdown of what happens in each of the scripts in this repo.

Dockerfile

The Dockerfile installs dependencies (python3, etc.), copies scripts to the root dir, and sets the working dir to /work.

init

The init script is straightforward - it's simply a shell script (via the #!/usr/bin/env sh she-bang) that invokes wget to download an anserini JAR from Maven Central.

index

The index Python script (via the #!/usr/bin/python3 she-bang) reads a JSON string (see here) containing at least one collection to index (including the name, path, and format). The collection is indexed and placed in a directory, with the same name as the collection, in the working dir (i.e., /work/robust04). At this point, jig takes a snapshot and the indexed collections are persisted for the search hook.

search

The search script reads a JSON string (see here) containing the collection name (to map back to the index directory from the index hook) and topic path, among other options. The retrieval run is performed (using additional --opts params, see above) and output is placed in /output for the jig to evaluate using trec_eval.

References

Reviews