Skip to main content

MtmdInputChunks

Struct MtmdInputChunks 

Source
pub struct MtmdInputChunks {
    pub chunks: NonNull<mtmd_input_chunks>,
}
Expand description

Safe wrapper around mtmd_input_chunks.

This is a collection of input chunks created from tokenizing text and media. The chunks represent the tokenized input that can be processed by the model, with text chunks containing tokens and media chunks containing embeddings.

Fields§

§chunks: NonNull<mtmd_input_chunks>

Raw pointer to the underlying mtmd_input_chunks.

Implementations§

Source§

impl MtmdInputChunks

Source

pub fn new() -> Result<Self, MtmdInputChunksError>

Create a new empty input chunks collection.

§Errors

Returns MtmdInputChunksError::ChunksCreationFailed if the underlying llama.cpp function returns null.

§Examples
use llama_cpp_bindings::mtmd::MtmdInputChunks;

let chunks = MtmdInputChunks::new().unwrap();
assert_eq!(chunks.len(), 0);
assert!(chunks.is_empty());
Source

pub fn len(&self) -> usize

Get the number of chunks

Source

pub fn is_empty(&self) -> bool

Check if chunks collection is empty

Source

pub fn get(&self, index: usize) -> Option<MtmdInputChunk>

Get a chunk by index

Source

pub fn total_tokens(&self) -> usize

Get total number of tokens across all chunks.

Source

pub fn total_positions(&self) -> i32

Get total position count across all chunks.

Source

pub fn eval_chunks( &self, mtmd_ctx: &MtmdContext, llama_ctx: &LlamaContext<'_>, start_position: llama_pos, seq_id: llama_seq_id, n_batch: i32, logits_last: bool, ) -> Result<llama_pos, MtmdEvalError>

Evaluate chunks using the multimodal context and LLAMA context.

§Errors

Returns MtmdEvalError::EvalFailure if any encoding or decoding operation fails.

Trait Implementations§

Source§

impl Debug for MtmdInputChunks

Source§

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

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

impl Drop for MtmdInputChunks

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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.