Struct RetrievalMetrics 

pub struct RetrievalMetrics {
    pub recall: HashMap<usize, f32>,
    pub precision: HashMap<usize, f32>,
    pub mrr: f32,
    pub ndcg: HashMap<usize, f32>,
    pub map: f32,
}

Retrieval metrics for evaluation

Fields

recall: HashMap<usize, f32>

Recall@k for various k values

precision: HashMap<usize, f32>

Precision@k for various k values

mrr: f32

Mean Reciprocal Rank

ndcg: HashMap<usize, f32>

Normalized Discounted Cumulative Gain@k

map: f32

Mean Average Precision

Implementations

impl RetrievalMetrics

pub fn compute( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, k_values: &[usize], ) -> Self

Compute all metrics for a single query

pub fn recall_at_k( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, k: usize, ) -> f32

Compute Recall@k

Recall@k = |relevant ∩ retrieved@k| / |relevant|

pub fn precision_at_k( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, k: usize, ) -> f32

Compute Precision@k

Precision@k = |relevant ∩ retrieved@k| / k

pub fn mean_reciprocal_rank( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, ) -> f32

Compute Mean Reciprocal Rank (MRR)

MRR = 1 / rank of first relevant result

pub fn ndcg_at_k( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, k: usize, ) -> f32

Compute Normalized Discounted Cumulative Gain@k

NDCG@k = DCG@k / IDCG@k

pub fn average_precision( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, ) -> f32

Compute Average Precision (AP)

AP = (1/|relevant|) * Σ (Precision@k * rel(k))

pub fn f1_at_k( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, k: usize, ) -> f32

Compute F1 score at k

pub fn hit_rate_at_k( retrieved: &[ChunkId], relevant: &HashSet<ChunkId>, k: usize, ) -> f32

Compute Hit Rate (1 if any relevant in top-k, else 0)

Trait Implementations

impl Clone for RetrievalMetrics

fn clone(&self) -> RetrievalMetrics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RetrievalMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RetrievalMetrics

fn default() -> RetrievalMetrics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RetrievalMetrics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RetrievalMetrics

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.