Crate cranky

Disclaimer: This is very much work in progress, and in the very early stage at that. Absolutely no backwards-compatilbility should be assumed.

Cranky is a library and tool for evaluating query effectiveness for information retrieval.

It is an attempt to replace tools like trec_eval, gdeval, and ndeval. The goal is to be fast but also provide a codebase that is easier to maintain, as well as provide interface to use in Rust and (eventually) C/C++ libraries. From there, we can create bindings to basically any other language.

Structs

Docid	Document TREC ID.
Iter	Represents a query iteration.
JudgementRecord	Judgement record.
Judgements	Abstraction over a set of relevance judgements.
Qid	Represents a query ID in TREC format.
Rank	Document rank.
ResultRecord	Result record.
ResultSet	Abstraction over a set of results from a single file in TREC format.
Run	Represents a query run.
Score	Floating point result score.
StringIdFactory	A convenience structure used to produce String IDs. It stores all previously used query IDs. When possible, it reuses a string.

Enums

Relevance

Document relevance used as gold standard.

Traits

Record

Result or judgement record.

Functions

read_records

Read records.