Skip to main content

MtmdContextParams

Struct MtmdContextParams 

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

Parameters used when creating an MtmdContext.

Obtain a default-initialised instance via MtmdContextParams::default().

Implementations§

Source§

impl MtmdContextParams

Source

pub fn use_gpu(self, v: bool) -> Self

Whether to run the vision/audio encoder on the GPU (default: true).

Source

pub fn print_timings(self, v: bool) -> Self

Whether to print timing info after each encode (default: false).

Source

pub fn n_threads(self, n: i32) -> Self

Number of threads used for the vision encoder (default taken from mtmd_context_params_default).

Source

pub fn warmup(self, v: bool) -> Self

Whether to run a warm-up encode pass after initialisation.

Source

pub fn image_min_tokens(self, n: i32) -> Self

Minimum number of image tokens (0 = use model default).

Source

pub fn image_max_tokens(self, n: i32) -> Self

Maximum number of image tokens (0 = use model default).

Source

pub fn media_marker(self, marker: Option<&str>) -> Result<Self, MtmdError>

Override the media marker string (e.g. "<image>").

The provided string must not contain interior NUL bytes. Pass None to use the library default (mtmd_default_marker()).

Note: the CString is stored inside the params so the pointer remains valid as long as this MtmdContextParams lives.

§Errors

Returns MtmdError if the marker string contains a NUL byte.

Trait Implementations§

Source§

impl Debug for MtmdContextParams

Source§

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

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

impl Default for MtmdContextParams

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> 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, 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<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