bm25

README

bm25

bm25 is a scoring function that helps with information retrieval

Documentation

Overview

package bm25 is a lingo-friendly BM25 library. BM25 is a scoring function that relies on TFIDF, and is useful for document retrieval

Index

• type DocScore
• type DocScores
  • func BM25(tf *tfidf.TFIDF, query tfidf.Document, docs []tfidf.Document, k1, b float64) DocScores
  • func (ds DocScores) Len() int
  • func (ds DocScores) Less(i, j int) bool
  • func (ds DocScores) Swap(i, j int)

Types

type DocScore

type DocScore struct {
	ID    int
	Score float64
}

DocScore is a tuple of the document ID and a score

type DocScores

type DocScores []DocScore

DocScores is a list of DocScore

func BM25

func BM25(tf *tfidf.TFIDF, query tfidf.Document, docs []tfidf.Document, k1, b float64) DocScores

BM25 is the scoring function.

k1 should be between 1.2 and 2. b should be around 0.75

func (DocScores) Len

func (ds DocScores) Len() int

func (DocScores) Less

func (ds DocScores) Less(i, j int) bool

func (DocScores) Swap

func (ds DocScores) Swap(i, j int)