Experimaestro common module for IR experiments
Project description
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)
- Interface for the IR datasets library
- Splitting IR datasets
- Shuffling training triplets
- Representation
- Word Embeddings
- HuggingFace transformers
- Indices
- dense: FAISS interface
- sparse: xpmir-rust library
- 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
- HuggingFace integration (direct, through the Sentence Transformers library)
Thanks
Some parts of the code have been adapted from OpenNIR
Project details
Release history Release notifications | RSS feed
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)
Built Distribution
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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ac3999e57288733bf6df024a6d1be790b2ce4c0c908b37491c00308a1a02430 |
|
MD5 | 1e356fd50da29afc61e841091061541b |
|
BLAKE2b-256 | c6eb24b6d4f0eb12cd66aad487b139047dfe737dbfbdce92317a90780545139d |
File details
Details for the file experimaestro_ir-1.2.0-py3-none-any.whl
.
File metadata
- Download URL: experimaestro_ir-1.2.0-py3-none-any.whl
- Upload date:
- Size: 159.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.12.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4027542ce0fb2bb9bf581847bb7c356e1b9322ac20e3a97a63845a615c16bb62 |
|
MD5 | 1e270a0921353ea2f772476bc352ff8c |
|
BLAKE2b-256 | db2336784a4b410b8c7882ae40186e107f4ec4940e23feed30feba1bfd667bfe |