Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 5.95 KB

regressions-msmarco-v1-passage.bm25-b8.md

File metadata and controls

104 lines (74 loc) · 5.95 KB
Raw

Anserini Regressions: MS MARCO Passage Ranking

Models: BM25 with quantized weights (8 bits)

This page documents regression experiments on the MS MARCO passage ranking task, which is integrated into Anserini's regression testing framework. For more complete instructions on how to run end-to-end experiments, refer to this page.

The exact configurations for these regressions are stored in this YAML file. Note that this page is automatically generated from this template as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead.

From one of our Waterloo servers (e.g., orca), the following command will perform the complete regression, end to end:

python src/main/python/run_regression.py --index --verify --search --regression msmarco-v1-passage.bm25-b8

From any machine, the following command will download the corpus (as quantized BM25 weights) and perform the complete regression, end to end:

python src/main/python/run_regression.py --download --index --verify --search --regression msmarco-v1-passage.bm25-b8

The run_regression.py script automates the following steps, but if you want to perform each step manually, simply copy/paste from the commands below and you'll obtain the same regression results.

Corpus Download

Download the corpus and unpack into collections/:

wget https://rgw.cs.uwaterloo.ca/JIMMYLIN-bucket0/data/msmarco-passage-bm25-b8.tar -P collections/
tar xvf collections/msmarco-passage-bm25-b8.tar -C collections/

To confirm, msmarco-passage-bm25-b8.tar is 1.2 GB and has MD5 checksum 0a623e2c97ac6b7e814bf1323a97b435. With the corpus downloaded, the following command will perform the remaining steps below:

python src/main/python/run_regression.py --index --verify --search --regression msmarco-v1-passage.bm25-b8 \
  --corpus-path collections/msmarco-passage-bm25-b8

Indexing

Typical indexing command:

bin/run.sh io.anserini.index.IndexCollection \
  -threads 9 \
  -collection JsonVectorCollection \
  -input /path/to/msmarco-passage-bm25-b8 \
  -generator DefaultLuceneDocumentGenerator \
  -index indexes/lucene-inverted.msmarco-v1-passage.bm25-b8/ \
  -impact -pretokenized \
  >& logs/log.msmarco-passage-bm25-b8 &

The directory /path/to/msmarco-passage-bm25-b8/ should be a directory containing jsonl files containing quantized BM25 vectors for every document

For additional details, see explanation of common indexing options.

Retrieval

Topics and qrels are stored here, which is linked to the Anserini repo as a submodule. The regression experiments here evaluate on the 6980 dev set questions; see this page for more details.

After indexing has completed, you should be able to perform retrieval as follows:

bin/run.sh io.anserini.search.SearchCollection \
  -index indexes/lucene-inverted.msmarco-v1-passage.bm25-b8/ \
  -topics tools/topics-and-qrels/topics.msmarco-passage.dev-subset.txt \
  -topicReader TsvInt \
  -output runs/run.msmarco-passage-bm25-b8.bm25-b8.topics.msmarco-passage.dev-subset.txt \
  -impact &

Evaluation can be performed using trec_eval:

bin/trec_eval -c -m map tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-bm25-b8.bm25-b8.topics.msmarco-passage.dev-subset.txt
bin/trec_eval -c -M 10 -m recip_rank tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-bm25-b8.bm25-b8.topics.msmarco-passage.dev-subset.txt
bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-bm25-b8.bm25-b8.topics.msmarco-passage.dev-subset.txt
bin/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-bm25-b8.bm25-b8.topics.msmarco-passage.dev-subset.txt

Effectiveness

With the above commands, you should be able to reproduce the following results:

AP@1000 BM25 (default parameters, quantized 8 bits)
MS MARCO Passage: Dev 0.1925
RR@10 BM25 (default parameters, quantized 8 bits)
MS MARCO Passage: Dev 0.1839
R@100 BM25 (default parameters, quantized 8 bits)
MS MARCO Passage: Dev 0.6604
R@1000 BM25 (default parameters, quantized 8 bits)
MS MARCO Passage: Dev 0.8562

Reproduction Log*

To add to this reproduction log, modify this template and run bin/build.sh to rebuild the documentation.