rlx-coreml 0.2.10

Apple CoreML / Neural Engine (ANE) backend for RLX — lowers the IR to an ML Program (MIL) and runs it through CoreML.framework
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

// RLX — versatile ML compiler + runtime.
// Copyright (C) 2026 Eugene Hauptmann, Nataliya Kosmyna.
//
// Per-backend kernel registry for `Op::Custom` on CoreML / ANE.
//
// Custom ops run on the host (hybrid execution) — same bytes-in/bytes-out
// contract as `rlx_cpu::op_registry::CpuKernel` and `rlx_metal::op_registry::
// MetalKernel`.

use std::collections::HashMap;
use std::sync::{Arc, OnceLock, RwLock};

use rlx_ir::Shape;

/// Host-side kernel for one `Op::Custom` name on the CoreML path.
pub trait CoremlKernel: Send + Sync + std::fmt::Debug {
    fn name(&self) -> &str;

    fn execute(
        &self,
        inputs: &[(&[u8], &Shape)],
        output: (&mut [u8], &Shape),
        attrs: &[u8],
    ) -> Result<(), String>;
}

pub struct CoremlKernelRegistry {
    kernels: RwLock<HashMap<String, Arc<dyn CoremlKernel>>>,
}

impl CoremlKernelRegistry {
    pub fn new() -> Self {
        Self {
            kernels: RwLock::new(HashMap::new()),
        }
    }

    pub fn register(&self, k: Arc<dyn CoremlKernel>) {
        let name = k.name().to_string();
        let mut g = self.kernels.write().unwrap();
        if g.contains_key(&name) {
            eprintln!(
                "rlx-coreml: CoremlKernel '{name}' was already registered — \
                 replacing the previous entry"
            );
        }
        g.insert(name, k);
    }

    pub fn lookup(&self, name: &str) -> Option<Arc<dyn CoremlKernel>> {
        self.kernels.read().unwrap().get(name).cloned()
    }
}

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

pub fn global_coreml_kernels() -> &'static CoremlKernelRegistry {
    static R: OnceLock<CoremlKernelRegistry> = OnceLock::new();
    R.get_or_init(CoremlKernelRegistry::new)
}

pub fn register_coreml_kernel(k: Arc<dyn CoremlKernel>) {
    global_coreml_kernels().register(k);
}

pub fn lookup_coreml_kernel(name: &str) -> Option<Arc<dyn CoremlKernel>> {
    global_coreml_kernels().lookup(name)
}

#[cfg(test)]
mod tests {
    use super::*;
    use rlx_ir::DType;

    #[derive(Debug)]
    struct StubKernel;
    impl CoremlKernel for StubKernel {
        fn name(&self) -> &str {
            "stub.coreml"
        }
        fn execute(
            &self,
            _inputs: &[(&[u8], &Shape)],
            _output: (&mut [u8], &Shape),
            _attrs: &[u8],
        ) -> Result<(), String> {
            Ok(())
        }
    }

    #[test]
    fn register_and_lookup_round_trips() {
        let reg = CoremlKernelRegistry::new();
        reg.register(Arc::new(StubKernel));
        let k = reg
            .lookup("stub.coreml")
            .expect("registered kernel must be findable");
        assert_eq!(k.name(), "stub.coreml");
    }

    #[test]
    fn execute_signature_compiles_and_runs() {
        let k: Arc<dyn CoremlKernel> = Arc::new(StubKernel);
        let in_shape = Shape::new(&[4], DType::F32);
        let out_shape = Shape::new(&[4], DType::F32);
        let in_bytes = vec![0u8; 16];
        let mut out_bytes = vec![0u8; 16];
        k.execute(&[(&in_bytes, &in_shape)], (&mut out_bytes, &out_shape), &[])
            .expect("stub kernel must succeed");
    }
}