Model: cosDPR-distil with HNSW indexes (using ONNX for on-the-fly query encoding)
This page describes regression experiments, integrated into Anserini's regression testing framework, using the cosDPR-distil model on the TREC 2019 Deep Learning Track passage ranking task, as described in the following paper:
Xueguang Ma, Tommaso Teofili, and Jimmy Lin. Anserini Gets Dense Retrieval: Integration of Lucene's HNSW Indexes. Proceedings of the 32nd International Conference on Information and Knowledge Management (CIKM 2023), October 2023, pages 5366–5370, Birmingham, the United Kingdom.
In these experiments, we are performing query inference "on-the-fly" with ONNX.
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 MS MARCO passage collection, 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 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 dl19-passage.cos-dpr-distil.hnsw.onnxWe make available a version of the MS MARCO Passage Corpus that has already been encoded with cosDPR-distil.
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 dl19-passage.cos-dpr-distil.hnsw.onnxThe 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 the corpus and unpack into collections/:
wget https://rgw.cs.uwaterloo.ca/pyserini/data/msmarco-passage-cos-dpr-distil.tar -P collections/
tar xvf collections/msmarco-passage-cos-dpr-distil.tar -C collections/To confirm, msmarco-passage-cos-dpr-distil.tar is 57 GB and has MD5 checksum e20ffbc8b5e7f760af31298aefeaebbd.
With the corpus downloaded, the following command will perform the remaining steps below:
python src/main/python/run_regression.py --index --verify --search --regression dl19-passage.cos-dpr-distil.hnsw.onnx \
--corpus-path collections/msmarco-passage-cos-dpr-distilSample indexing command, building HNSW indexes:
bin/run.sh io.anserini.index.IndexHnswDenseVectors \
-collection JsonDenseVectorCollection \
-input /path/to/msmarco-passage-cos-dpr-distil \
-generator HnswDenseVectorDocumentGenerator \
-index indexes/lucene-hnsw.msmarco-v1-passage.cos-dpr-distil/ \
-threads 16 -M 16 -efC 100 -memoryBuffer 65536 -noMerge \
>& logs/log.msmarco-passage-cos-dpr-distil &The path /path/to/msmarco-passage-cos-dpr-distil/ should point to the corpus downloaded above.
Upon completion, we should have an index with 8,841,823 documents.
Note that here we are explicitly using Lucene's NoMergePolicy merge policy, which suppresses any merging of index segments.
This is because merging index segments is a costly operation and not worthwhile given our query set.
Topics and qrels are stored here, which is linked to the Anserini repo as a submodule. 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:
bin/run.sh io.anserini.search.SearchHnswDenseVectors \
-index indexes/lucene-hnsw.msmarco-v1-passage.cos-dpr-distil/ \
-topics tools/topics-and-qrels/topics.dl19-passage.txt \
-topicReader TsvInt \
-output runs/run.msmarco-passage-cos-dpr-distil.cos-dpr-distil-hnsw.topics.dl19-passage.txt \
-generator VectorQueryGenerator -topicField title -threads 16 -hits 1000 -efSearch 1000 -encoder CosDprDistil &Note that we are performing query inference "on-the-fly" with ONNX in these experiments.
Evaluation can be performed using trec_eval:
bin/trec_eval -m map -c -l 2 tools/topics-and-qrels/qrels.dl19-passage.txt runs/run.msmarco-passage-cos-dpr-distil.cos-dpr-distil-hnsw.topics.dl19-passage.txt
bin/trec_eval -m ndcg_cut.10 -c tools/topics-and-qrels/qrels.dl19-passage.txt runs/run.msmarco-passage-cos-dpr-distil.cos-dpr-distil-hnsw.topics.dl19-passage.txt
bin/trec_eval -m recall.100 -c -l 2 tools/topics-and-qrels/qrels.dl19-passage.txt runs/run.msmarco-passage-cos-dpr-distil.cos-dpr-distil-hnsw.topics.dl19-passage.txt
bin/trec_eval -m recall.1000 -c -l 2 tools/topics-and-qrels/qrels.dl19-passage.txt runs/run.msmarco-passage-cos-dpr-distil.cos-dpr-distil-hnsw.topics.dl19-passage.txtWith the above commands, you should be able to reproduce the following results:
| AP@1000 | cosDPR-distil |
|---|---|
| DL19 (Passage) | 0.458 |
| nDCG@10 | cosDPR-distil |
| DL19 (Passage) | 0.717 |
| R@100 | cosDPR-distil |
| DL19 (Passage) | 0.605 |
| R@1000 | cosDPR-distil |
| DL19 (Passage) | 0.805 |
Note that due to the non-deterministic nature of HNSW indexing, results may differ slightly between each experimental run. Nevertheless, scores are generally within 0.005 of the reference values recorded in our YAML configuration file.
Also note that retrieval metrics are computed to depth 1000 hits per query (as opposed to 100 hits per query for document ranking).
Also, for computing nDCG, remember that we keep qrels of all relevance grades, whereas for other metrics (e.g., AP), relevance grade 1 is considered not relevant (i.e., use the -l 2 option in trec_eval).
The experimental results reported here are directly comparable to the results reported in the track overview paper.
Reproduction Log*
To add to this reproduction log, modify this template and run bin/build.sh to rebuild the documentation.