Skip to main content

KvCache

Struct KvCache 

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

Simple contiguous KV cache implementation.

Stores key and value tensors for all layers in contiguous FP32 buffers. Each layer has a separate key buffer and value buffer, sized for the maximum context length.

Implementations§

Source§

impl KvCache

Source

pub fn new(num_layers: usize, max_seq_len: usize, kv_dim: usize) -> Self

Allocate a new KV cache.

§Arguments
  • num_layers - Number of transformer layers.
  • max_seq_len - Maximum context length.
  • kv_dim - KV dimension per token (num_kv_heads * head_dim).
Source

pub fn clear(&mut self)

Reset the cache, clearing all stored KV pairs.

Source

pub fn max_seq_len(&self) -> usize

Returns the maximum sequence length.

Source

pub fn kv_dim(&self) -> usize

Returns the KV dimension per token.

Source

pub fn num_layers(&self) -> usize

Returns the number of layers.

Source

pub fn advance(&mut self)

Advance the sequence position by one token.

Source

pub fn restore_from_snapshot( &mut self, keys: &[Vec<f32>], values: &[Vec<f32>], seq_len: usize, )

Restore from a prefix cache snapshot.

Copies the provided per-layer key/value data into internal buffers and sets seq_len to the snapshot’s length. The caller must ensure that keys.len() == values.len() == num_layers and that each inner vec has seq_len * kv_dim elements.

Source

pub fn truncate(&mut self, n: usize)

Truncate the KV cache to n tokens.

After this call seq_len() returns n (clamped to the current seq_len if n is already beyond it — truncate never extends the cache). The underlying buffers are not zeroed; the truncated region is simply considered invalid and will be overwritten on the next store_kv call.

This is the low-level primitive for speculative-decoding rollback: the target engine calls truncate(divergence_pos) after rejecting a draft token, then continues generating from divergence_pos.

Source

pub fn snapshot(&self) -> KvCacheSnapshot

Capture a snapshot of the current KV state.

Only the data up to seq_len * kv_dim is copied per layer, keeping the snapshot compact.

Source

pub fn to_payload(&self) -> KvStatePayload

Build a serializable crate::snapshot::KvStatePayload from the current state.

Source

pub fn restore_from_payload( &mut self, payload: &KvStatePayload, ) -> RuntimeResult<()>

Restore cache state from a crate::snapshot::KvStatePayload.

Validates that layer count and dimensions match the cache configuration, then restores the key/value buffers and sequence length.

Trait Implementations§

Source§

impl KvCacheAccess for KvCache

Source§

fn seq_len(&self) -> usize

Get the current sequence length (number of cached tokens).
Source§

fn store_kv( &mut self, layer: usize, key: &[f32], value: &[f32], ) -> ArchResult<()>

Store key and value tensors for a layer at the current position.
Source§

fn get_keys(&self, layer: usize) -> ArchResult<&[f32]>

Retrieve all cached keys for a layer up to the current sequence length.
Source§

fn get_values(&self, layer: usize) -> ArchResult<&[f32]>

Retrieve all cached values for a layer up to the current sequence length.
Source§

fn advance(&mut self)

Advance the cache position by one token. Read more
Source§

fn kv_dim(&self) -> usize

KV dimension per token (num_kv_heads * head_dim). Read more
Source§

fn for_each_key( &self, layer: usize, f: &mut dyn FnMut(usize, &[f32]), ) -> Result<(), ArchError>

Iterate over every cached key token for layer, calling f(pos, key_data). Read more
Source§

fn for_each_value( &self, layer: usize, f: &mut dyn FnMut(usize, &[f32]), ) -> Result<(), ArchError>

Iterate over every cached value token for layer, calling f(pos, value_data). 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> 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.
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