Skip to main content

BatchProcessor

Struct BatchProcessor 

Source
pub struct BatchProcessor<'a, F>
where F: FnMut(Vec<Vec<Results>>, &[DynamicImage], &[String], &[SourceMeta]),
{ /* private fields */ }
Expand description

A processor for handling batch inference.

This struct manages collecting images into batches, running inference (with fallback), and invoking a callback with the results.

§Example

use ultralytics_inference::{YOLOModel, batch::BatchProcessor};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut model = YOLOModel::load("yolo26n.onnx")?;
    let batch_size = 4;
     
    let mut processor = BatchProcessor::new(&mut model, batch_size, |results, images, paths, metas| {
        println!("Processed batch of {} images", results.len());
    });
     
    // Add images...
    // processor.add(image, path, meta);
     
    processor.flush();
    Ok(())
}

Implementations§

Source§

impl<'a, F> BatchProcessor<'a, F>
where F: FnMut(Vec<Vec<Results>>, &[DynamicImage], &[String], &[SourceMeta]),

Source

pub fn new(model: &'a mut YOLOModel, batch_size: usize, callback: F) -> Self

Create a new BatchProcessor.

§Arguments
  • model - Mutable reference to the YOLOModel for inference.
  • batch_size - Maximum number of images to collect before processing.
  • callback - Closure invoked with batch results. Receives:
    • Vec<Vec<Results>> - Results for each image in the batch
    • &[DynamicImage] - The batch images
    • &[String] - Paths for each image
    • &[SourceMeta] - Metadata for each image
§Returns

A new BatchProcessor instance.

Source

pub fn add(&mut self, image: DynamicImage, path: String, meta: SourceMeta)

Add an image to the batch.

If the batch becomes full (reaches batch_size), it is automatically processed and the callback is invoked.

§Arguments
  • image - The image to add.
  • path - Path or identifier for this image.
  • meta - Source metadata for this image.
Source

pub fn flush(&mut self)

Process any remaining images in the batch.

This should be called after all images have been added to ensure the last partial batch is processed. Has no effect if the batch is empty.

Auto Trait Implementations§

§

impl<'a, F> Freeze for BatchProcessor<'a, F>
where F: Freeze,

§

impl<'a, F> !RefUnwindSafe for BatchProcessor<'a, F>

§

impl<'a, F> Send for BatchProcessor<'a, F>
where F: Send,

§

impl<'a, F> Sync for BatchProcessor<'a, F>
where F: Sync,

§

impl<'a, F> Unpin for BatchProcessor<'a, F>
where F: Unpin,

§

impl<'a, F> UnsafeUnpin for BatchProcessor<'a, F>
where F: UnsafeUnpin,

§

impl<'a, F> !UnwindSafe for BatchProcessor<'a, F>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more