Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
126 lines (90 sloc) 7.1 KB

Anserini

Build Status Maven Central LICENSE

Anserini is an open-source information retrieval toolkit built on Lucene that aims to bridge the gap between academic information retrieval research and the practice of building real-world search applications. This effort grew out of a reproducibility study of various open-source retrieval engines in 2016 (Lin et al., ECIR 2016). Additional details can be found in a short paper (Yang et al., SIGIR 2017) and a journal article (Yang et al., JDIQ 2018).

Getting Started

Anserini requires Java 8 (note that there are known issues with Java 10 and Java 11) and Maven 3.3+. Oracle JVM is necessary to replicate our regression results; there are known issues with OpenJDK (see this and this). Build using Maven:

mvn clean package appassembler:assemble

The eval/ directory contains evaluation tools and scripts, including trec_eval, gdeval.pl, ndeval. Before using trec_eval, unpack and compile it, as follows:

tar xvfz trec_eval.9.0.4.tar.gz && cd trec_eval.9.0.4 && make

Before using ndeval, compile it as follows:

cd ndeval && make

Running Standard IR Experiments

Anserini is designed to support experiments on various standard TREC collections out of the box. Each collection is associated with regression tests for replicability. Note that these regressions capture the "out of the box" experience, based on default parameter settings.

Additional regressions:

Runbooks:

Additional Documentation

  • Axiomatic Reranking

  • IndexUtils is a utility to interact with an index using the command line (e.g., print index statistics). Refer to target/appassembler/bin/IndexUtils -h for more details.

  • MapCollections is a generic mapper framework for processing a document collection in parallel. Developers can write their own mappers for different tasks: one simple example is CountDocumentMapper which counts the number of documents in a collection:

    target/appassembler/bin/MapCollections -collection ClueWeb09Collection \
      -threads 16 -input ~/collections/web/ClueWeb09b/ClueWeb09_English_1/ \
      -mapper CountDocumentMapper -context CountDocumentMapperContext
    

Python Interface

Anserini was designed with Python integration in mind, for connecting with popular deep learning toolkits such as PyTorch. This is accomplished via pyjnius. The SimpleSearcher class provides a simple Python/Java bridge, shown below:

import jnius_config
jnius_config.set_classpath("target/anserini-0.4.1-SNAPSHOT-fatjar.jar")

from jnius import autoclass
JString = autoclass('java.lang.String')
JSearcher = autoclass('io.anserini.search.SimpleSearcher')

searcher = JSearcher(JString('lucene-index.robust04.pos+docvectors+rawdocs'))
hits = searcher.search(JString('hubble space telescope'))

# the docid of the 1st hit
hits[0].docid

# the internal Lucene docid of the 1st hit
hits[0].ldocid

# the score of the 1st hit
hits[0].score

# the full document of the 1st hit
hits[0].content

Release History

References

Acknowledgments

This research has been supported in part by the Natural Sciences and Engineering Research Council (NSERC) of Canada and the U.S. National Science Foundation under IIS-1423002 and CNS-1405688. Any opinions, findings, and conclusions or recommendations expressed do not necessarily reflect the views of the sponsors.

You can’t perform that action at this time.