Skip to main content

KvElem

Enum KvElem 

Source
pub enum KvElem {
    F32,
    F16,
    Q8_0,
    Turbo4,
}
Expand description

Element width of one cached K/V scalar, per backend store.

The block-quantized variants are the ggml/TurboQuant wire formats ferrox-metal writes for FERROX_CTK (see ferrox_metal::attn::MetalKvDtype), so their cost is per 32-element block, not per scalar.

Variants§

§

F32

Host ferrox_core::cache::KvCache, which stores Vec<f32>.

§

F16

Metal device KV default (FERROX_CTK=f16, llama.cpp -ctk f16).

§

Q8_0

ggml Q8_0 wire: 32 elems -> 2-byte scale + 32 int8 = 34 bytes. FERROX_CTK=q8_0|turbo8|fp8 all land on this width.

§

Turbo4

TurboQuant 4-bit: 32 elems -> 2-byte scale + 16 nibble bytes.

Implementations§

Source§

impl KvElem

Source

pub fn bytes_for(self, elems: u64) -> u64

Bytes needed to store elems cached scalars, rounding up to a whole block for the block-quantized wires (a partial block still costs a full one).

Source

pub fn as_str(self) -> &'static str

Source

pub fn from_ctk(value: &str) -> Self

Maps a FERROX_CTK / --ctk value onto the width the Metal KV store really keeps. Mirrors ferrox_metal::attn::effective_metal_kv_dtype: turbo8 and fp8 share Q8_0’s 34-byte wire, and anything unrecognised or unimplemented (turbo3) falls back to f16 rather than being budgeted at a width no kernel writes.

Note this does not check the block alignment that function also checks (n_kv_heads * head_dim divisible by 32), so a misaligned shape is budgeted at the requested width while the runtime silently uses f16 – an under-estimate, called out here rather than papered over.

Trait Implementations§

Source§

impl Clone for KvElem

Source§

fn clone(&self) -> KvElem

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 Copy for KvElem

Source§

impl Debug for KvElem

Source§

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

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

impl Eq for KvElem

Source§

impl PartialEq for KvElem

Source§

fn eq(&self, other: &KvElem) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for KvElem

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

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.