Model: uniCOIL (with doc2query-T5 expansions) zero-shot
This page describes baseline experiments, integrated into Anserini's regression testing framework, on the TREC 2022 Deep Learning Track passage ranking task using the MS MARCO V2 Passage Corpus. Here, we cover experiments with the uniCOIL model trained on the MS MARCO V1 passage ranking test collection, applied in a zero-shot manner, with doc2query-T5 expansions.
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.
Note that the NIST relevance judgments provide far more relevant passages 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 the MS MARCO V2 Passage Corpus, 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 dl22-passage-unicoil-0shotWe make available a version of the MS MARCO passage corpus that has already been processed with uniCOIL, i.e., we have applied doc2query-T5 expansions, 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 dl22-passage-unicoil-0shotThe 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.
Download, unpack, and prepare the corpus:
# Download
wget https://rgw.cs.uwaterloo.ca/JIMMYLIN-bucket0/data/msmarco_v2_passage_unicoil_0shot.tar -P collections/
# Unpack
tar -xvf collections/msmarco_v2_passage_unicoil_0shot.tar -C collections/
# Rename (indexer is expecting corpus under a slightly different name)
mv collections/msmarco_v2_passage_unicoil_0shot collections/msmarco-v2-passage-unicoil-0shotTo confirm, msmarco_v2_passage_unicoil_0shot.tar is 41 GB and has an MD5 checksum of 1949a00bfd5e1f1a230a04bbc1f01539.
With the corpus downloaded, the following command will perform the remaining steps below:
python src/main/python/run_regression.py --index --verify --search --regression dl22-passage-unicoil-0shot \
--corpus-path collections/msmarco-v2-passage-unicoil-0shotSample indexing command:
target/appassembler/bin/IndexCollection \
-collection JsonVectorCollection \
-input /path/to/msmarco-v2-passage-unicoil-0shot \
-index indexes/lucene-index.msmarco-v2-passage-unicoil-0shot/ \
-generator DefaultLuceneDocumentGenerator \
-threads 24 -impact -pretokenized -storeRaw \
>& logs/log.msmarco-v2-passage-unicoil-0shot &The path /path/to/msmarco-v2-passage-unicoil-0shot/ 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 138,364,198 documents.
For additional details, see explanation of common indexing options.
Topics and qrels are stored here, which is linked to the Anserini repo as a submodule. The regression experiments here evaluate on the 76 topics for which NIST has provided judgments as part of the TREC 2022 Deep Learning Track.
After indexing has completed, you should be able to perform retrieval as follows:
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-v2-passage-unicoil-0shot/ \
-topics tools/topics-and-qrels/topics.dl22.unicoil.0shot.tsv.gz \
-topicreader TsvInt \
-output runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot.topics.dl22.unicoil.0shot.txt \
-impact -pretokenized &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-v2-passage-unicoil-0shot/ \
-topics tools/topics-and-qrels/topics.dl22.unicoil.0shot.tsv.gz \
-topicreader TsvInt \
-output runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rm3.topics.dl22.unicoil.0shot.txt \
-impact -pretokenized -rm3 -collection JsonVectorCollection &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-v2-passage-unicoil-0shot/ \
-topics tools/topics-and-qrels/topics.dl22.unicoil.0shot.tsv.gz \
-topicreader TsvInt \
-output runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rocchio.topics.dl22.unicoil.0shot.txt \
-impact -pretokenized -rocchio -collection JsonVectorCollection &Evaluation can be performed using trec_eval:
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m recip_rank -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rm3.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m recip_rank -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rm3.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rm3.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rm3.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rm3.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m map -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rocchio.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -M 100 -m recip_rank -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rocchio.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rocchio.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rocchio.topics.dl22.unicoil.0shot.txt
tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 -l 2 tools/topics-and-qrels/qrels.dl22-passage.txt runs/run.msmarco-v2-passage-unicoil-0shot.unicoil-0shot+rocchio.topics.dl22.unicoil.0shot.txtNote that the TREC 2022 passage qrels are not publicly available (yet).
However, if you are a participant, you can download them from the NIST "active participants" site.
Place the qrels file in tools/topics-and-qrels/qrels.dl22-passage.txt for the above evaluation commands to work.
With the above commands, you should be able to reproduce the following results:
| MAP@100 | uniCOIL (with doc2query-T5) zero-shot | +RM3 | +Rocchio |
|---|---|---|---|
| DL22 (Passage) | 0.1050 | 0.1170 | 0.1225 |
| MRR@100 | uniCOIL (with doc2query-T5) zero-shot | +RM3 | +Rocchio |
| DL22 (Passage) | 0.5831 | 0.5634 | 0.5577 |
| nDCG@10 | uniCOIL (with doc2query-T5) zero-shot | +RM3 | +Rocchio |
| DL22 (Passage) | 0.4614 | 0.4608 | 0.4886 |
| R@100 | uniCOIL (with doc2query-T5) zero-shot | +RM3 | +Rocchio |
| DL22 (Passage) | 0.2716 | 0.2751 | 0.2860 |
| R@1000 | uniCOIL (with doc2query-T5) zero-shot | +RM3 | +Rocchio |
| DL22 (Passage) | 0.5253 | 0.5372 | 0.5559 |
The uniCOIL condition corresponds to the p_unicoil_exp run submitted to the TREC 2022 Deep Learning Track as a "baseline".
As of 91ec67, this correspondence was exact.
That is, modulo the runtag and the number of hits, the output runfile should be identical.
This can be confirmed as follows:
# Trim out the runtag:
cut -d ' ' -f 1-5 runs/p_unicoil_exp > runs/p_unicoil_exp.submitted.cut
# Trim out the runtag and retain only top 100 hits per query:
python tools/scripts/trim_run_to_top_k.pl --k 100 --input runs/run.msmarco-v2-passage-unicoil-0shot.dl22.unicoil-0shot --output runs/run.msmarco-v2-passage-unicoil-0shot.dl22.unicoil-0shot.hits100
cut -d ' ' -f 1-5 runs/run.msmarco-v2-passage-unicoil-0shot.dl22.unicoil-0shot.hits100 > runs/p_unicoil_exp.new.cut
# Verify the two runfiles are identical:
diff runs/p_unicoil_exp.submitted.cut runs/p_unicoil_exp.new.cutThe "uniCOIL + Rocchio" condition corresponds to the p_unicoil_exp_rocchio run submitted to the TREC 2022 Deep Learning Track as a "baseline".
However, due to a60e84, the results are slightly different (because the underlying implementation changed).