sipp-rs 0.1.0

Unified Rust library for extensible Sipp inference
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

//! Boundary picker for snapshot prefix-cache entries. Decides where along a prompt to commit a KV snapshot.

use crate::runtime::llama_token;
use crate::runtime::numeric::saturating_usize_to_u64;

pub const PREFIX_HASH_SEED: u64 = 1_469_598_103_934_665_603;
pub const PREFIX_HASH_PRIME: u64 = 1_099_511_628_211;
const DEFAULT_PREFIX_CACHE_INTERVAL_TOKENS: usize = 128;
const MAX_MINIMUM_PREFIX_CACHE_TOKENS: usize = 32;

pub fn mix_prefix_hash_token(hash: u64, token: llama_token) -> u64 {
    let token_bits = u32::from_ne_bytes(token.to_ne_bytes());
    (hash ^ u64::from(token_bits)).wrapping_mul(PREFIX_HASH_PRIME)
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub struct PrefixCachePolicyStats {
    pub lookup_count: u64,
    pub hit_count: u64,
    pub store_count: u64,
    pub restored_token_count: u64,
    pub stored_token_count: u64,
}

impl PrefixCachePolicyStats {
    fn record_lookup(&mut self) {
        increment_counter(&mut self.lookup_count);
    }

    fn record_hit(&mut self, token_count: usize) {
        increment_counter(&mut self.hit_count);
        add_token_count(&mut self.restored_token_count, token_count);
    }

    fn record_store(&mut self, token_count: usize) {
        increment_counter(&mut self.store_count);
        add_token_count(&mut self.stored_token_count, token_count);
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PrefixCachePolicy {
    prefix_cache_interval_tokens: usize,
    minimum_prefix_cache_tokens: usize,
    pub(crate) stats: PrefixCachePolicyStats,
}

impl PrefixCachePolicy {
    pub fn new(prefix_cache_interval_tokens: usize) -> Self {
        Self {
            prefix_cache_interval_tokens,
            minimum_prefix_cache_tokens: minimum_prefix_cache_tokens(prefix_cache_interval_tokens),
            stats: PrefixCachePolicyStats::default(),
        }
    }

    pub fn should_store_boundary(&self, token_count: usize, terminal_token_count: usize) -> bool {
        if is_terminal_boundary(token_count, terminal_token_count) {
            return true;
        }
        if token_count < self.minimum_prefix_cache_tokens {
            return false;
        }
        is_interval_boundary(token_count, self.prefix_cache_interval_tokens)
    }

    pub fn hash_prefix(&self, tokens: &[llama_token], token_count: usize) -> u64 {
        if token_count == 0 || tokens.is_empty() {
            return 0;
        }

        hash_tokens(&tokens[..token_count.min(tokens.len())])
    }

    pub fn record_lookup(&mut self) {
        self.stats.record_lookup();
    }

    pub fn record_hit(&mut self, token_count: usize) {
        self.stats.record_hit(token_count);
    }

    pub fn record_store(&mut self, token_count: usize) {
        self.stats.record_store(token_count);
    }
}

impl Default for PrefixCachePolicy {
    fn default() -> Self {
        Self::new(DEFAULT_PREFIX_CACHE_INTERVAL_TOKENS)
    }
}

fn hash_tokens(tokens: &[llama_token]) -> u64 {
    tokens.iter().fold(PREFIX_HASH_SEED, |hash, &token| {
        mix_prefix_hash_token(hash, token)
    })
}

fn minimum_prefix_cache_tokens(prefix_cache_interval_tokens: usize) -> usize {
    if prefix_cache_interval_tokens == 0 {
        MAX_MINIMUM_PREFIX_CACHE_TOKENS
    } else {
        prefix_cache_interval_tokens.min(MAX_MINIMUM_PREFIX_CACHE_TOKENS)
    }
}

fn is_terminal_boundary(token_count: usize, terminal_token_count: usize) -> bool {
    token_count == terminal_token_count
}

fn is_interval_boundary(token_count: usize, interval: usize) -> bool {
    interval > 0 && token_count.is_multiple_of(interval)
}

fn increment_counter(counter: &mut u64) {
    *counter = counter.saturating_add(1);
}

fn add_token_count(total: &mut u64, token_count: usize) {
    *total = total.saturating_add(saturating_usize_to_u64(token_count));
}

#[cfg(test)]
#[path = "../../../tests/runtime/session/prefix_cache_policy_tests.rs"]
mod prefix_cache_policy_tests;