Skip to content

experimaestro/experimaestro-ir

Repository files navigation

pre-commit Documentation Status PyPI version

Information Retrieval for experimaestro

Information Retrieval module for experimaestro

The full documentation can be read at IR@experimaestro.

You can find experiments built on top of XPMIR on the xpmir github workspace.

Finally, you can find the roadmap.

Install

Base experimaestro-IR can be installed with pip install xpmir. Functionalities can be added by installing optional dependencies:

  • pip install xpmir[neural] to install neural-IR packages (torch, etc.)
  • pip install xpmir[anserini] to install Anserini related packages

For the development version, you can:

  • If you just want the development version: install with pip install git+https://github.com/experimaestro/experimaestro-ir.git
  • If you want to edit the code: clone and then do a pip install -e . within the directory

What's inside?

  • Collection management (using datamaestro)
  • Representation
    • Word Embeddings
    • HuggingFace transformers
  • Indices
  • Standard Indexing and Retrieval
    • Anserini
  • Learning to Rank
    • Pointwise
    • Pairwise
    • Distillation
  • Neural IR
    • Cross-Encoder
    • Splade
    • DRMM
    • ColBERT
  • Paper reproduction:
    • MonoBERT (Passage Re-ranking with BERT. Rodrigo Nogueira and Kyunghyun Cho. 2019)
    • (alpha) DuoBERT (Multi-Stage Document Ranking with BERT. Rodrigo Nogueira, Wei Yang, Kyunghyun Cho, Jimmy Lin. 2019)
    • (beta) Splade v2 (SPLADE v2: Sparse Lexical and Expansion Model for Information Retrieval, Thibault Formal, Carlos Lassance, Benjamin Piwowarski, and Stéphane Clinchant. SIGIR 2021)
    • (planned) ANCE
  • Pre-trained models

Thanks

Some parts of the code have been adapted from OpenNIR