This page documents regression experiments for the MS MARCO document ranking task, which is integrated into Anserini's regression testing framework. Note that there are four different regression conditions for this task, and this page describes the following:
- Indexing Condition: each MS MARCO document is treated as a unit of indexing
- Expansion Condition: none
All four conditions are described in detail here, in the context of doc2query-T5.
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.
Typical indexing command:
nohup sh target/appassembler/bin/IndexCollection -collection CleanTrecCollection \
-input /path/to/msmarco-doc \
-index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-generator DefaultLuceneDocumentGenerator \
-threads 1 -storePositions -storeDocvectors -storeRaw \
>& logs/log.msmarco-doc &
The directory /path/to/msmarco-doc/ should be a directory containing the official document collection (a single file), in TREC format.
For additional details, see explanation of common indexing options.
Topics and qrels are stored in src/main/resources/topics-and-qrels/.
The regression experiments here evaluate on the 5193 dev set questions.
After indexing has completed, you should be able to perform retrieval as follows:
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-default.topics.msmarco-doc.dev.txt \
-bm25 &
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-default+rm3.topics.msmarco-doc.dev.txt \
-bm25 -rm3 &
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-default+ax.topics.msmarco-doc.dev.txt \
-bm25 -axiom -axiom.deterministic -rerankCutoff 20 &
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-default+prf.topics.msmarco-doc.dev.txt \
-bm25 -bm25prf &
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-tuned.topics.msmarco-doc.dev.txt \
-bm25 -bm25.k1 4.46 -bm25.b 0.82 &
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-tuned+rm3.topics.msmarco-doc.dev.txt \
-bm25 -bm25.k1 4.46 -bm25.b 0.82 -rm3 &
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-tuned+ax.topics.msmarco-doc.dev.txt \
-bm25 -bm25.k1 4.46 -bm25.b 0.82 -axiom -axiom.deterministic -rerankCutoff 20 &
nohup target/appassembler/bin/SearchCollection -index indexes/lucene-index.msmarco-doc.pos+docvectors+raw \
-topicreader TsvInt -topics src/main/resources/topics-and-qrels/topics.msmarco-doc.dev.txt \
-output runs/run.msmarco-doc.bm25-tuned+prf.topics.msmarco-doc.dev.txt \
-bm25 -bm25.k1 4.46 -bm25.b 0.82 -bm25prf &
Evaluation can be performed using trec_eval:
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-default.topics.msmarco-doc.dev.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-default+rm3.topics.msmarco-doc.dev.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-default+ax.topics.msmarco-doc.dev.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-default+prf.topics.msmarco-doc.dev.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-tuned.topics.msmarco-doc.dev.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-tuned+rm3.topics.msmarco-doc.dev.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-tuned+ax.topics.msmarco-doc.dev.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -m recall.100 -c -m recall.1000 -c src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt runs/run.msmarco-doc.bm25-tuned+prf.topics.msmarco-doc.dev.txt
With the above commands, you should be able to replicate the following results:
| MAP | BM25 (Default) | +RM3 | +Ax | +PRF | BM25 (Tuned) | +RM3 | +Ax | +PRF |
|---|---|---|---|---|---|---|---|---|
| MS MARCO Doc Ranking: Dev | 0.2310 | 0.1632 | 0.1147 | 0.1357 | 0.2775 | 0.2238 | 0.1885 | 0.1531 |
| R@100 | BM25 (Default) | +RM3 | +Ax | +PRF | BM25 (Tuned) | +RM3 | +Ax | +PRF |
|---|---|---|---|---|---|---|---|---|
| MS MARCO Doc Ranking: Dev | 0.7279 | 0.6765 | 0.5750 | 0.6362 | 0.8076 | 0.7789 | 0.7510 | 0.6819 |
| R@1000 | BM25 (Default) | +RM3 | +Ax | +PRF | BM25 (Tuned) | +RM3 | +Ax | +PRF |
|---|---|---|---|---|---|---|---|---|
| MS MARCO Doc Ranking: Dev | 0.8856 | 0.8785 | 0.8369 | 0.8471 | 0.9357 | 0.9307 | 0.9249 | 0.8752 |
The setting "default" refers the default BM25 settings of k1=0.9, b=0.4, while "tuned" refers to the tuned setting of k1=4.46, b=0.82.
See this page for more details.
Note that here we are using trec_eval to evaluate the top 1000 hits for each query; beware, an official MS MARCO document ranking task leaderboard submission comprises only 100 hits per query.
Use the following commands to convert the TREC run files into the MS MARCO format and use the official eval script to compute MRR@100:
$ python tools/scripts/msmarco/convert_trec_to_msmarco_run.py --input runs/run.msmarco-doc.bm25-default.topics.msmarco-doc.dev.txt --output runs/run.msmarco-doc.bm25-default.topics.msmarco-doc.dev.msmarco.txt --k 100 --quiet
$ python tools/scripts/msmarco/msmarco_doc_eval.py --judgments src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt --run runs/run.msmarco-doc.bm25-default.topics.msmarco-doc.dev.msmarco.txt
#####################
MRR @100: 0.23005723505603545
QueriesRanked: 5193
#####################
$ python tools/scripts/msmarco/convert_trec_to_msmarco_run.py --input runs/run.msmarco-doc.bm25-tuned.topics.msmarco-doc.dev.txt --output runs/run.msmarco-doc.bm25-tuned.topics.msmarco-doc.dev.msmarco.txt --k 100 --quiet
$ python tools/scripts/msmarco/msmarco_doc_eval.py --judgments src/main/resources/topics-and-qrels/qrels.msmarco-doc.dev.txt --run runs/run.msmarco-doc.bm25-tuned.topics.msmarco-doc.dev.msmarco.txt
#####################
MRR @100: 0.2770296928568709
QueriesRanked: 5193
#####################