Skip to content

Latest commit

 

History

History
121 lines (87 loc) · 8.22 KB

regressions-msmarco-passage-unicoil-noexp.md

File metadata and controls

121 lines (87 loc) · 8.22 KB
Raw

Anserini Regressions: MS MARCO Passage Ranking

Model: uniCOIL (without any expansions)

This page describes regression experiments, integrated into Anserini's regression testing framework, using uniCOIL (without any expansions) on the MS MARCO passage ranking task. The uniCOIL model is described in the following paper:

Jimmy Lin and Xueguang Ma. A Few Brief Notes on DeepImpact, COIL, and a Conceptual Framework for Information Retrieval Techniques. arXiv:2106.14807.

The experiments on this page are not actually reported in the paper. Here, a variant model without expansion is used.

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 and then run bin/build.sh to rebuild the documentation.

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-passage-unicoil-noexp

We make available a version of the MS MARCO Passage Corpus that has already been processed with uniCOIL, i.e., we have performed model inference on every document and stored the output sparse vectors. Thus, no neural inference is involved.

From any machine, the following command will download the corpus and perform the complete regression, end to end:

python src/main/python/run_regression.py --download --index --verify --search --regression msmarco-passage-unicoil-noexp

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-unicoil-noexp.tar -P collections/
tar xvf collections/msmarco-passage-unicoil-noexp.tar -C collections/

To confirm, msmarco-passage-unicoil-noexp.tar is 2.7 GB and has MD5 checksum f17ddd8c7c00ff121c3c3b147d2e17d8. 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-passage-unicoil-noexp \
  --corpus-path collections/msmarco-passage-unicoil-noexp

Indexing

Sample indexing command:

target/appassembler/bin/IndexCollection \
  -collection JsonVectorCollection \
  -input /path/to/msmarco-passage-unicoil-noexp \
  -index indexes/lucene-index.msmarco-passage-unicoil-noexp/ \
  -generator DefaultLuceneDocumentGenerator \
  -threads 16 -impact -pretokenized -storeDocvectors \
  >& logs/log.msmarco-passage-unicoil-noexp &

The path /path/to/msmarco-passage-unicoil-noexp/ should point to the corpus downloaded above.

The important indexing options to note here are -impact -pretokenized: the first tells Anserini not to encode BM25 doclengths into Lucene's norms (which is the default) and the second option says not to apply any additional tokenization on the uniCOIL tokens. Upon completion, we should have an index with 8,841,823 documents.

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:

target/appassembler/bin/SearchCollection \
  -index indexes/lucene-index.msmarco-passage-unicoil-noexp/ \
  -topics tools/topics-and-qrels/topics.msmarco-passage.dev-subset.unicoil-noexp.tsv.gz \
  -topicreader TsvInt \
  -output runs/run.msmarco-passage-unicoil-noexp.unicoil-noexp.topics.msmarco-passage.dev-subset.unicoil-noexp.txt \
  -impact -pretokenized &

Evaluation can be performed using trec_eval:

tools/eval/trec_eval.9.0.4/trec_eval -c -m map tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-unicoil-noexp.unicoil-noexp.topics.msmarco-passage.dev-subset.unicoil-noexp.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 10 -m recip_rank tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-unicoil-noexp.unicoil-noexp.topics.msmarco-passage.dev-subset.unicoil-noexp.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-unicoil-noexp.unicoil-noexp.topics.msmarco-passage.dev-subset.unicoil-noexp.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.msmarco-passage.dev-subset.txt runs/run.msmarco-passage-unicoil-noexp.unicoil-noexp.topics.msmarco-passage.dev-subset.unicoil-noexp.txt

Effectiveness

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

AP@1000 uniCOIL (no expansions)
MS MARCO Passage: Dev 0.3215
RR@10 uniCOIL (no expansions)
MS MARCO Passage: Dev 0.3153
R@100 uniCOIL (no expansions)
MS MARCO Passage: Dev 0.8070
R@1000 uniCOIL (no expansions)
MS MARCO Passage: Dev 0.9239

Reproduction Log*

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