retrival25 1.0.0

One place stop for BM25 and it's variants

retrival25 👑

One stop solution for all BM25 needs

Installation

You can install retrival25 with pip:

pip install retrival25

Quick Start

Here is a simple example of how to use retrival25:

from retrival25.rank import ranker

# Add you data here
corpus = [
    "a cat is a feline and likes to purr",
    "a dog is the human's best friend and loves to play",
    "a bird is a beautiful animal that can fly",
    "a fish is a creature that lives in water and swims",
]

# pass data to be preprocessed and indexed
obj = ranker(corpus=corpus, type="robertson", k=1.2, b=0.75)

# return top n retrived documents
obj.get_top_n(query=query[0], n=10)

Variants

You can use the following variants of BM25

• Original implementation (type="robertson")
• ATIRE (type="atire_bm25")
• BM25L (type="bm25_L")
• BM25+ (type="bm25_plus+")
• BM25-adbt (type="bm25_adbt")

By default ranker uses type="robertson"