Skip to main content

LlamaContextParams

Struct LlamaContextParams 

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

Parameters controlling a crate::LlamaContext.

Starts from llama_context_default_params(). Note ik keeps a seed field in the context params (stock removed it) and uses a bool flash_attn plus the MTP fields mtp / mtp_op_type. There is no ctx_type in ik.

Implementations§

Source§

impl LlamaContextParams

Source

pub fn with_n_ctx(self, n_ctx: Option<NonZeroU32>) -> Self

Context size (tokens); None means “take it from the model” (0).

Takes Option<NonZeroU32> to match llama-cpp-2.

Source

pub fn with_n_batch(self, n_batch: u32) -> Self

Logical batch size.

Source

pub fn with_n_ubatch(self, n_ubatch: u32) -> Self

Physical (micro) batch size.

Source

pub fn with_n_rs_seq(self, n_rs_seq: u32) -> Self

Maximum number of sequences (distinct recurrent states).

llama-cpp-2’s NextN fork exposes this as n_rs_seq; ik’s equivalent is n_seq_max, which this sets.

Source

pub fn with_context_type(self, context_type: LlamaContextType) -> Self

Select the context kind. LlamaContextType::Mtp enables ik’s MTP path (equivalent to Self::with_mtp(true)).

Source

pub fn with_seed(self, seed: u32) -> Self

RNG seed (ik retains this in the context params).

Source

pub fn with_n_threads(self, n_threads: u32) -> Self

Threads used for generation.

Source

pub fn with_n_threads_batch(self, n_threads_batch: u32) -> Self

Threads used for batch/prompt processing.

Source

pub fn with_flash_attn(self, flash_attn: bool) -> Self

Enable flash attention.

Source

pub fn with_mtp(self, mtp: bool) -> Self

Activate the MTP path (requires a model loaded with .with_mtp(true)).

Source

pub fn with_embeddings(self, embeddings: bool) -> Self

Produce embeddings on decode (sets params.embeddings).

Required for embedding and reranker models; usually paired with Self::with_pooling_type.

Source

pub fn with_pooling_type(self, pooling_type: llama_pooling_type) -> Self

Set the pooling strategy for embeddings (sets params.pooling_type).

Takes the raw sys::llama_pooling_type (e.g. LLAMA_POOLING_TYPE_MEAN, LLAMA_POOLING_TYPE_CLS, or LLAMA_POOLING_TYPE_LAST) to avoid introducing a new enum.

Source

pub fn as_raw(&self) -> &llama_context_params

Access the raw params (advanced/escape hatch).

Trait Implementations§

Source§

impl Clone for LlamaContextParams

Source§

fn clone(&self) -> LlamaContextParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LlamaContextParams

Source§

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

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

impl Default for LlamaContextParams

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
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