rankit 0.1.4

Learning to Rank: differentiable ranking, LTR losses (RankNet, LambdaRank, ApproxNDCG, ListNet, ListMLE), trainers, and IR evaluation metrics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! Input validation utilities for metrics and evaluation.
#![allow(missing_docs)]

/// Validation error for metric inputs.
#[derive(Debug, Clone, PartialEq)]
pub enum ValidationError {
    /// k is larger than ranked list size.
    KTooLarge { k: usize, ranked_len: usize },
    /// k is zero.
    KZero,
    /// Ranked list is empty.
    EmptyRanked,
    /// No relevant documents.
    NoRelevant,
    /// Invalid persistence parameter (must be in (0, 1)).
    InvalidPersistence { persistence: f64 },
    /// Invalid beta parameter (must be positive).
    InvalidBeta { beta: f64 },
}

impl std::fmt::Display for ValidationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            ValidationError::KTooLarge { k, ranked_len } => {
                write!(
                    f,
                    "k ({}) is larger than ranked list size ({})",
                    k, ranked_len
                )
            }
            ValidationError::KZero => write!(f, "k must be greater than 0"),
            ValidationError::EmptyRanked => write!(f, "ranked list cannot be empty"),
            ValidationError::NoRelevant => write!(f, "no relevant documents provided"),
            ValidationError::InvalidPersistence { persistence } => {
                write!(
                    f,
                    "persistence parameter ({}) must be in (0, 1)",
                    persistence
                )
            }
            ValidationError::InvalidBeta { beta } => {
                write!(f, "beta parameter ({}) must be positive", beta)
            }
        }
    }
}

impl std::error::Error for ValidationError {}

/// Validate metric inputs.
pub fn validate_metric_inputs<I>(
    ranked: &[I],
    relevant: &std::collections::HashSet<I>,
    k: usize,
    require_relevant: bool,
) -> Result<(), ValidationError> {
    if k == 0 {
        return Err(ValidationError::KZero);
    }

    if ranked.is_empty() {
        return Err(ValidationError::EmptyRanked);
    }

    if require_relevant && relevant.is_empty() {
        return Err(ValidationError::NoRelevant);
    }

    Ok(())
}

/// Validate RBP persistence parameter (must be in (0, 1)).
pub fn validate_persistence(persistence: f64) -> Result<(), ValidationError> {
    if persistence <= 0.0 || persistence >= 1.0 {
        return Err(ValidationError::InvalidPersistence { persistence });
    }
    Ok(())
}

/// Validate F-measure beta parameter (must be positive).
pub fn validate_beta(beta: f64) -> Result<(), ValidationError> {
    if beta <= 0.0 {
        return Err(ValidationError::InvalidBeta { beta });
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashSet;

    #[test]
    fn test_validate_metric_inputs() {
        let ranked = vec!["doc1", "doc2", "doc3"];
        let relevant: HashSet<_> = ["doc1"].into_iter().collect();

        assert!(validate_metric_inputs(&ranked, &relevant, 3, false).is_ok());
        assert!(validate_metric_inputs(&ranked, &relevant, 3, true).is_ok());

        assert!(matches!(
            validate_metric_inputs(&ranked, &relevant, 0, false),
            Err(ValidationError::KZero)
        ));

        let empty: Vec<&str> = vec![];
        assert!(matches!(
            validate_metric_inputs(&empty, &relevant, 3, false),
            Err(ValidationError::EmptyRanked)
        ));
    }

    #[test]
    fn test_validate_persistence() {
        assert!(validate_persistence(0.5).is_ok());
        assert!(validate_persistence(0.95).is_ok());
        assert!(matches!(
            validate_persistence(0.0),
            Err(ValidationError::InvalidPersistence { .. })
        ));
        assert!(matches!(
            validate_persistence(1.0),
            Err(ValidationError::InvalidPersistence { .. })
        ));
    }

    #[test]
    fn test_validate_beta() {
        assert!(validate_beta(1.0).is_ok());
        assert!(matches!(
            validate_beta(0.0),
            Err(ValidationError::InvalidBeta { .. })
        ));
    }
}