Skip to main content

ModelCache

Struct ModelCache 

Source
pub struct ModelCache { /* private fields */ }
Expand description

LRU cache of loaded OnnxModel handles.

See the module-level docs for an end-to-end example. Keys are canonicalised via canonical_path so equivalent relative/absolute paths resolve to the same slot.

Implementations§

Source§

impl ModelCache

Source

pub fn new() -> Self

Create a new cache with DEFAULT_CAPACITY slots.

Source

pub fn with_capacity(capacity: usize) -> MlResult<Self>

Create a new cache with the given positive capacity.

§Errors

Returns MlError::CacheCapacityZero if capacity == 0.

Source

pub fn capacity(&self) -> usize

Capacity reported by this cache.

Source

pub fn len(&self) -> MlResult<usize>

Current number of cached models.

Source

pub fn is_empty(&self) -> MlResult<bool>

Return whether the cache is empty.

Source

pub fn get_or_load( &self, path: impl AsRef<Path>, device: DeviceType, ) -> MlResult<Arc<OnnxModel>>

Load path or return the cached handle.

Under the hood the entire operation is serialised by the internal mutex, which avoids the classic double-checked-locking race where two threads both miss and both load the same model.

§Errors

Returns MlError::Pipeline with stage "cache" if the internal mutex is poisoned, or any error produced by OnnxModel::load on a cache miss.

Source

pub fn remove(&self, path: impl AsRef<Path>) -> MlResult<Option<Arc<OnnxModel>>>

Remove the cached entry for path if present and return it.

Source

pub fn clear(&self) -> MlResult<()>

Drop all cached entries.

Trait Implementations§

Source§

impl Debug for ModelCache

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ModelCache

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.