llama-cpp-bindings 0.6.0

llama.cpp bindings for Rust
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

/// NUMA (Non-Uniform Memory Access) thread affinity strategy for llama.cpp.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub enum NumaStrategy {
    /// NUMA-aware scheduling is disabled. Threads are not pinned to specific nodes.
    Disabled,
    /// Distributes threads across NUMA nodes in a round-robin fashion.
    Distribute,
    /// Pins all threads to the current NUMA node to avoid cross-node memory access.
    Isolate,
    /// Respects the CPU affinity mask set externally by the `numactl` command.
    Numactl,
    /// Mirrors memory across NUMA nodes. Currently a no-op in llama.cpp.
    Mirror,
}

/// An invalid numa strategy was provided.
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub struct InvalidNumaStrategy(
    /// The invalid numa strategy that was provided.
    pub llama_cpp_bindings_sys::ggml_numa_strategy,
);

impl TryFrom<llama_cpp_bindings_sys::ggml_numa_strategy> for NumaStrategy {
    type Error = InvalidNumaStrategy;

    fn try_from(value: llama_cpp_bindings_sys::ggml_numa_strategy) -> Result<Self, Self::Error> {
        match value {
            llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_DISABLED => Ok(Self::Disabled),
            llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_DISTRIBUTE => Ok(Self::Distribute),
            llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_ISOLATE => Ok(Self::Isolate),
            llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_NUMACTL => Ok(Self::Numactl),
            llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_MIRROR => Ok(Self::Mirror),
            value => Err(InvalidNumaStrategy(value)),
        }
    }
}

impl From<NumaStrategy> for llama_cpp_bindings_sys::ggml_numa_strategy {
    fn from(value: NumaStrategy) -> Self {
        match value {
            NumaStrategy::Disabled => llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_DISABLED,
            NumaStrategy::Distribute => llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_DISTRIBUTE,
            NumaStrategy::Isolate => llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_ISOLATE,
            NumaStrategy::Numactl => llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_NUMACTL,
            NumaStrategy::Mirror => llama_cpp_bindings_sys::GGML_NUMA_STRATEGY_MIRROR,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::{InvalidNumaStrategy, NumaStrategy};

    #[test]
    fn numa_from_and_to() {
        let numas = [
            NumaStrategy::Disabled,
            NumaStrategy::Distribute,
            NumaStrategy::Isolate,
            NumaStrategy::Numactl,
            NumaStrategy::Mirror,
        ];

        for numa in &numas {
            let raw = llama_cpp_bindings_sys::ggml_numa_strategy::from(*numa);
            let roundtripped =
                NumaStrategy::try_from(raw).expect("Failed to roundtrip NumaStrategy");

            assert_eq!(*numa, roundtripped);
        }
    }

    #[test]
    fn invalid_numa_strategy_returns_error() {
        let invalid_value = 800;
        let result = NumaStrategy::try_from(invalid_value);

        assert_eq!(result, Err(InvalidNumaStrategy(invalid_value)));
    }
}