litert 0.2.1

Safe, idiomatic Rust bindings to Google's LiteRT (TFLite) on-device ML runtime.
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

//! Introspection for a model's named entry points (signatures).

use std::ptr::NonNull;

use litert_sys as sys;

use crate::{check, Error, Model, Result, TensorShape};

/// A named entry point of a [`Model`]. Most models define a single default
/// signature, exposed as index `0`.
///
/// Holds a clone of the source [`Model`] to keep the underlying C object
/// alive while the signature handle is used.
///
/// # Example
///
/// ```no_run
/// let model = litert::Model::from_file("model.tflite")?;
/// let sig = model.signature(0)?;
/// for i in 0..sig.input_count()? {
///     println!("input {i}: {:?}", sig.input_shape(i)?);
/// }
/// # Ok::<(), litert::Error>(())
/// ```
#[derive(Clone)]
pub struct Signature {
    ptr: NonNull<sys::LiteRtSignatureT>,
    _model: Model,
}

// Safety: LiteRtSignature is a non-owning pointer into an immutable model;
// concurrent read access is safe.
unsafe impl Send for Signature {}
unsafe impl Sync for Signature {}

impl Signature {
    pub(crate) fn new(model: Model, index: sys::LiteRtParamIndex) -> Result<Self> {
        let mut raw: sys::LiteRtSignature = std::ptr::null_mut();
        check(unsafe { sys::LiteRtGetModelSignature(model.as_raw(), index, &mut raw) })?;
        let ptr = NonNull::new(raw).ok_or(Error::NullPointer)?;
        Ok(Self { ptr, _model: model })
    }

    /// Number of input tensors.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Status`](crate::Error::Status) on runtime failure.
    pub fn input_count(&self) -> Result<usize> {
        let mut n: sys::LiteRtParamIndex = 0;
        check(unsafe { sys::LiteRtGetNumSignatureInputs(self.ptr.as_ptr(), &mut n) })?;
        Ok(n)
    }

    /// Number of output tensors.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Status`](crate::Error::Status) on runtime failure.
    pub fn output_count(&self) -> Result<usize> {
        let mut n: sys::LiteRtParamIndex = 0;
        check(unsafe { sys::LiteRtGetNumSignatureOutputs(self.ptr.as_ptr(), &mut n) })?;
        Ok(n)
    }

    /// Shape and element type of the `i`-th input tensor.
    ///
    /// # Errors
    ///
    /// Returns [`Error::Status`](crate::Error::Status) if the index is out of
    /// bounds or the C call fails.
    pub fn input_shape(&self, i: usize) -> Result<TensorShape> {
        let tensor = self.input_tensor(i)?;
        ranked_tensor_shape(tensor)
    }

    /// Shape and element type of the `i`-th output tensor.
    ///
    /// # Errors
    ///
    /// See [`Self::input_shape`].
    pub fn output_shape(&self, i: usize) -> Result<TensorShape> {
        let tensor = self.output_tensor(i)?;
        ranked_tensor_shape(tensor)
    }

    fn input_tensor(&self, i: usize) -> Result<sys::LiteRtTensor> {
        let mut t: sys::LiteRtTensor = std::ptr::null_mut();
        check(unsafe { sys::LiteRtGetSignatureInputTensorByIndex(self.ptr.as_ptr(), i, &mut t) })?;
        if t.is_null() {
            return Err(Error::NullPointer);
        }
        Ok(t)
    }

    fn output_tensor(&self, i: usize) -> Result<sys::LiteRtTensor> {
        let mut t: sys::LiteRtTensor = std::ptr::null_mut();
        check(unsafe { sys::LiteRtGetSignatureOutputTensorByIndex(self.ptr.as_ptr(), i, &mut t) })?;
        if t.is_null() {
            return Err(Error::NullPointer);
        }
        Ok(t)
    }
}

fn ranked_tensor_shape(tensor: sys::LiteRtTensor) -> Result<TensorShape> {
    let mut ranked = sys::LiteRtRankedTensorType::default();
    check(unsafe { sys::LiteRtGetRankedTensorType(tensor, &mut ranked) })?;
    let rank = ranked.layout.rank() as usize;
    Ok(TensorShape {
        element_type: crate::ElementType::from_raw(ranked.element_type),
        dims: ranked.layout.dimensions[..rank].to_vec(),
    })
}