Skip to main content

Experimaestro common module for IR experiments

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

experimaestro-ir-1.2.0.tar.gz (139.2 kB view details)

Uploaded Source

Built Distribution

experimaestro_ir-1.2.0-py3-none-any.whl (159.1 kB view details)

Uploaded Python 3

File details

Details for the file experimaestro-ir-1.2.0.tar.gz.

File metadata

  • Download URL: experimaestro-ir-1.2.0.tar.gz
  • Upload date:
  • Size: 139.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for experimaestro-ir-1.2.0.tar.gz
Algorithm Hash digest
SHA256 6ac3999e57288733bf6df024a6d1be790b2ce4c0c908b37491c00308a1a02430
MD5 1e356fd50da29afc61e841091061541b
BLAKE2b-256 c6eb24b6d4f0eb12cd66aad487b139047dfe737dbfbdce92317a90780545139d

See more details on using hashes here.

File details

Details for the file experimaestro_ir-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for experimaestro_ir-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4027542ce0fb2bb9bf581847bb7c356e1b9322ac20e3a97a63845a615c16bb62
MD5 1e270a0921353ea2f772476bc352ff8c
BLAKE2b-256 db2336784a4b410b8c7882ae40186e107f4ec4940e23feed30feba1bfd667bfe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page