Model: SPLADE++ CoCondenser-SelfDistil (using ONNX for on-the-fly query encoding)
This page describes regression experiments, integrated into Anserini's regression testing framework, using the SPLADE++ CoCondenser-SelfDistil model on the TREC 2020 Deep Learning Track passage ranking task, as described in the following paper:
Thibault Formal, Carlos Lassance, Benjamin Piwowarski, and Stéphane Clinchant. From Distillation to Hard Negative Sampling: Making Sparse Neural IR Models More Effective. Proceedings of the 45th International ACM SIGIR Conference on Research and Development in Information Retrieval, pages 2353–2359.
In these experiments, we are using ONNX to perform query encoding on the fly.
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 dl20-passage-splade-pp-sd-onnxWe make available a version of the MS MARCO Passage Corpus that has already been encoded with SPLADE++ CoCondenser-SelfDistil.
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 dl20-passage-splade-pp-sd-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-splade-pp-sd.tar -P collections/
tar xvf collections/msmarco-passage-splade-pp-sd.tar -C collections/To confirm, msmarco-passage-splade-pp-sd.tar is 4.8 GB and has MD5 checksum cb7e264222f2bf2221dd2c9d28190be1.
With the corpus downloaded, the following command will perform the remaining steps below:
python src/main/python/run_regression.py --index --verify --search --regression dl20-passage-splade-pp-sd-onnx \
--corpus-path collections/msmarco-passage-splade-pp-sdSample indexing command:
target/appassembler/bin/IndexCollection \
-collection JsonVectorCollection \
-input /path/to/msmarco-passage-splade-pp-sd \
-index indexes/lucene-index.msmarco-passage-splade-pp-sd/ \
-generator DefaultLuceneDocumentGenerator \
-threads 16 -impact -pretokenized -storeDocvectors \
>& logs/log.msmarco-passage-splade-pp-sd &The path /path/to/msmarco-passage-splade-pp-sd/ 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 SPLADE-distil CoCodenser Medium tokens.
Upon completion, we should have an index with 8,841,823 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 54 topics for which NIST has provided judgments as part of the TREC 2020 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-passage-splade-pp-sd/ \
-topics tools/topics-and-qrels/topics.dl20.txt \
-topicreader TsvInt \
-output runs/run.msmarco-passage-splade-pp-sd.splade-pp-sd.topics.dl20.txt \
-impact -pretokenized -encoder SpladePlusPlusSelfDistil &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-passage-splade-pp-sd/ \
-topics tools/topics-and-qrels/topics.dl20.txt \
-topicreader TsvInt \
-output runs/run.msmarco-passage-splade-pp-sd.rm3.topics.dl20.txt \
-impact -pretokenized -rm3 -encoder SpladePlusPlusSelfDistil &
target/appassembler/bin/SearchCollection \
-index indexes/lucene-index.msmarco-passage-splade-pp-sd/ \
-topics tools/topics-and-qrels/topics.dl20.txt \
-topicreader TsvInt \
-output runs/run.msmarco-passage-splade-pp-sd.rocchio.topics.dl20.txt \
-impact -pretokenized -rocchio -encoder SpladePlusPlusSelfDistil &Evaluation can be performed using trec_eval:
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.splade-pp-sd.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m ndcg_cut.10 -c tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.splade-pp-sd.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m recall.100 -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.splade-pp-sd.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m recall.1000 -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.splade-pp-sd.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rm3.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m ndcg_cut.10 -c tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rm3.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m recall.100 -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rm3.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m recall.1000 -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rm3.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m map -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rocchio.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m ndcg_cut.10 -c tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rocchio.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m recall.100 -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rocchio.topics.dl20.txt
tools/eval/trec_eval.9.0.4/trec_eval -m recall.1000 -c -l 2 tools/topics-and-qrels/qrels.dl20-passage.txt runs/run.msmarco-passage-splade-pp-sd.rocchio.topics.dl20.txtWith the above commands, you should be able to reproduce the following results:
| AP@1000 | SPLADE++ CoCondenser-SelfDistil | +RM3 | +Rocchio |
|---|---|---|---|
| DL20 (Passage) | 0.5139 | 0.5266 | 0.5335 |
| nDCG@10 | SPLADE++ CoCondenser-SelfDistil | +RM3 | +Rocchio |
| DL20 (Passage) | 0.7282 | 0.7227 | 0.7388 |
| R@100 | SPLADE++ CoCondenser-SelfDistil | +RM3 | +Rocchio |
| DL20 (Passage) | 0.7512 | 0.7648 | 0.7656 |
| R@1000 | SPLADE++ CoCondenser-SelfDistil | +RM3 | +Rocchio |
| DL20 (Passage) | 0.9024 | 0.9174 | 0.9120 |
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.
- Results reproduced by @cadurosar on 2023-06-01 (commit
70ea75) - Results reproduced by @ArthurChen189 on 2023-06-01 (commit
a403a2a)