Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 3.84 KB

regressions-beir-v1.0.0-scidocs-flat.md

File metadata and controls

74 lines (54 loc) · 3.84 KB
Raw

Anserini Regressions: BEIR (v1.0.0) — SCIDOCS

This page documents BM25 regression experiments for BEIR (v1.0.0) — SCIDOCS. These experiments index the corpus in a "flat" manner, by concatenating the "title" and "text" into the "contents" field.

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 beir-v1.0.0-scidocs-flat

All the BEIR corpora are available for download:

wget https://rgw.cs.uwaterloo.ca/pyserini/data/beir-v1.0.0-corpus.tar -P collections/
tar xvf collections/beir-v1.0.0-corpus.tar -C collections/

The tarball is 14 GB and has MD5 checksum faefd5281b662c72ce03d22021e4ff6b. After download and unpacking the corpora, the run_regression.py command above should work without any issue.

Indexing

Typical indexing command:

bin/run.sh io.anserini.index.IndexCollection \
  -collection BeirFlatCollection \
  -input /path/to/beir-v1.0.0-scidocs-flat \
  -generator DefaultLuceneDocumentGenerator \
  -index indexes/lucene-index.beir-v1.0.0-scidocs-flat/ \
  -threads 1 -storePositions -storeDocvectors -storeRaw \
  >& logs/log.beir-v1.0.0-scidocs-flat &

For additional details, see explanation of common indexing options.

Retrieval

Topics and qrels are stored here, which is linked to the Anserini repo as a submodule.

After indexing has completed, you should be able to perform retrieval as follows:

bin/run.sh io.anserini.search.SearchCollection \
  -index indexes/lucene-index.beir-v1.0.0-scidocs-flat/ \
  -topics tools/topics-and-qrels/topics.beir-v1.0.0-scidocs.test.tsv.gz \
  -topicReader TsvString \
  -output runs/run.beir-v1.0.0-scidocs-flat.bm25.topics.beir-v1.0.0-scidocs.test.txt \
  -bm25 -removeQuery -hits 1000 &

Evaluation can be performed using trec_eval:

bin/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.beir-v1.0.0-scidocs.test.txt runs/run.beir-v1.0.0-scidocs-flat.bm25.topics.beir-v1.0.0-scidocs.test.txt
bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.beir-v1.0.0-scidocs.test.txt runs/run.beir-v1.0.0-scidocs-flat.bm25.topics.beir-v1.0.0-scidocs.test.txt
bin/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.beir-v1.0.0-scidocs.test.txt runs/run.beir-v1.0.0-scidocs-flat.bm25.topics.beir-v1.0.0-scidocs.test.txt

Effectiveness

With the above commands, you should be able to reproduce the following results:

nDCG@10 BM25
BEIR (v1.0.0): SCIDOCS 0.1490
R@100 BM25
BEIR (v1.0.0): SCIDOCS 0.3477
R@1000 BM25
BEIR (v1.0.0): SCIDOCS 0.5638