This page describes experiments, integrated into Anserini's regression testing framework, for the TREC 2019 Deep Learning Track (Document Ranking Task) on the MS MARCO document collection using relevance judgments from NIST.
Note that the NIST relevance judgments provide far more relevant documents per topic, unlike the "sparse" judgments provided by Microsoft (these are sometimes called "dense" judgments to emphasize this contrast). For additional instructions on working with MS MARCO document collection, refer to this page.
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.
Note that in November 2021 we discovered issues in our regression tests, documented here. As a result, we have had to rebuild all our regressions from the raw corpus. These new versions yield end-to-end scores that are slightly different, so if numbers reported in a paper do not exactly match the numbers here, this may be the reason.
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 dl19-doc
Typical indexing command:
target/appassembler/bin/IndexCollection \
-collection JsonCollection \
-input /path/to/msmarco-doc \
-index indexes/lucene-index.msmarco-doc/ \
-generator DefaultLuceneDocumentGenerator \
-threads 7 -storePositions -storeDocvectors -storeRaw \
>& logs/log.msmarco-doc &
The directory /path/to/msmarco-doc/ should be a directory containing the document corpus in Anserini's jsonl format.
See this page for how to prepare the corpus.
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 43 topics for which NIST has provided judgments as part of the TREC 2019 Deep Learning Track.
The original data can be found here.
After indexing has completed, you should be able to perform retrieval as follows:
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-default.topics.dl19-doc.txt \
-bm25 &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-default+rm3.topics.dl19-doc.txt \
-bm25 -rm3 &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-default+ax.topics.dl19-doc.txt \
-bm25 -axiom -axiom.deterministic -rerankCutoff 20 &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-default+prf.topics.dl19-doc.txt \
-bm25 -bm25prf &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-tuned.topics.dl19-doc.txt \
-bm25 -bm25.k1 3.44 -bm25.b 0.87 &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-tuned+rm3.topics.dl19-doc.txt \
-bm25 -bm25.k1 3.44 -bm25.b 0.87 -rm3 &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-tuned+ax.topics.dl19-doc.txt \
-bm25 -bm25.k1 3.44 -bm25.b 0.87 -axiom -axiom.deterministic -rerankCutoff 20 &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-doc/ \
-topics src/main/resources/topics-and-qrels/topics.dl19-doc.txt \
-topicreader TsvInt \
-output runs/run.msmarco-doc.bm25-tuned+prf.topics.dl19-doc.txt \
-bm25 -bm25.k1 3.44 -bm25.b 0.87 -bm25prf &
Evaluation can be performed using trec_eval:
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+prf.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+prf.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+prf.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-default+prf.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+rm3.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+ax.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+prf.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+prf.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+prf.topics.dl19-doc.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 src/main/resources/topics-and-qrels/qrels.dl19-doc.txt runs/run.msmarco-doc.bm25-tuned+prf.topics.dl19-doc.txt
With the above commands, you should be able to reproduce the following results:
| AP@100 | BM25 (default) | +RM3 | +Ax | +PRF | BM25 (tuned) | +RM3 | +Ax | +PRF |
|---|---|---|---|---|---|---|---|---|
| DL19 (Doc) | 0.2434 | 0.2774 | 0.2454 | 0.2541 | 0.2311 | 0.2684 | 0.2792 | 0.2774 |
| nDCG@10 | BM25 (default) | +RM3 | +Ax | +PRF | BM25 (tuned) | +RM3 | +Ax | +PRF |
|---|---|---|---|---|---|---|---|---|
| DL19 (Doc) | 0.5176 | 0.5170 | 0.4732 | 0.5107 | 0.5139 | 0.5445 | 0.5203 | 0.5294 |
| R@100 | BM25 (default) | +RM3 | +Ax | +PRF | BM25 (tuned) | +RM3 | +Ax | +PRF |
|---|---|---|---|---|---|---|---|---|
| DL19 (Doc) | 0.3949 | 0.4189 | 0.3946 | 0.4003 | 0.3853 | 0.4186 | 0.4378 | 0.4295 |
| R@1000 | BM25 (default) | +RM3 | +Ax | +PRF | BM25 (tuned) | +RM3 | +Ax | +PRF |
|---|---|---|---|---|---|---|---|---|
| DL19 (Doc) | 0.6966 | 0.7503 | 0.7323 | 0.7357 | 0.6804 | 0.7288 | 0.7532 | 0.7559 |
Explanation of settings:
- The setting "default" refers the default BM25 settings of
k1=0.9,b=0.4. - The setting "tuned" refers to
k1=3.44,b=0.87, tuned using the MS MARCO document sparse judgments on 2019/06.
Settings tuned on the MS MARCO document sparse judgments may not work well on the TREC dense judgments.
Note that in the official evaluation for document ranking, all runs were truncated to top-100 hits per query (whereas all top-1000 hits per query were retained for passage ranking). Thus, average precision is computed to depth 100 (i.e., AP@100); nDCG@10 remains unaffected. Remember that we keep qrels of all relevance grades, unlike the case for passage ranking, where relevance grade 1 needs to be discarded when computing certain metrics. Here, we retrieve 1000 hits per query, but measure AP at cutoff 100 (e.g., AP@100). Thus, the experimental results reported here are directly comparable to the results reported in the track overview paper.
These regressions correspond to official TREC 2019 Deep Learning Track submissions by BASELINE group:
bm25base= BM25 (default),k1=0.9,b=0.4bm25base_rm3= BM25 (default) + RM3,k1=0.9,b=0.4bm25base_ax= BM25 (default) + Ax,k1=0.9,b=0.4bm25base_prf= BM25 (default) + PRF,k1=0.9,b=0.4bm25tuned_p= BM25 (tuned),k1=3.44,b=0.87bm25tuned_rm3= BM25 (tuned) + RM3,k1=3.44,b=0.87bm25tuned_ax= BM25 (tuned) + Ax,k1=3.44,b=0.87bm25tuned_prf= BM25 (tuned) + PRF,k1=3.44,b=0.87
Note that #1721 slightly change the results, since we corrected underlying issues with data preparation.