Skip to main content

Codec

proxima_primitives::codec

Enum Codec

pub enum Codec {
Show 33 variants    Q4K,
    Q5K,
    Q6K,
    Q8_0,
    Q3K,
    Q4_0,
    Float16,
    BFloat16,
    Q2K,
    Q5_1,
    Q5_0,
    Q4_1,
    Q8_1,
    Q8K,
    Iq1S,
    Iq1M,
    Iq2Xxs,
    Iq2Xs,
    Iq2S,
    Iq3Xxs,
    Iq3S,
    Iq4Nl,
    Iq4Xs,
    Tq10,
    Tq20,
    Mxfp4,
    Nvfp4,
    Q1_0,
    Q2_0,
    BFloat8,
    Bf8E5M2,
    Bf4E2M1,
    Fp6E3M2,
}

Expand description

Which packed byte layout a codec-tagged buffer holds.

Variants§

Q4K

Q5K

Q6K

Q8_0

Q3K

Q4_0

Float16

BFloat16

Q2K

Q5_1

Q5_0

Q4_1

Q8_1

Q8K

Iq1S

Iq1M

Iq2Xxs

Iq2Xs

Iq2S

Iq3Xxs

Iq3S

Iq4Nl

Iq4Xs

Tq10

Tq20

Mxfp4

Nvfp4

Q1_0

Q2_0

BFloat8

Bf8E5M2

Bf4E2M1

Fp6E3M2

Implementations§

impl Codec

pub const FP6_E3M2_BLOCK_ELEMENTS: usize = 32

Weights per Codec::Fp6E3M2 block, one f16 absmax scale each.

pub const FP6_E3M2_BLOCK_BYTES: usize

Bytes per Codec::Fp6E3M2 block: the 6-bit FloatLayout::E3M2 fields packed, then the f16 scale.

pub fn tag(self) -> u8

The wire byte a sidecar tags this codec with. Stable across releases – an on-disk sidecar’s bytes decode by this mapping.

pub fn from_tag(tag: u8) -> Option<Self>

The inverse of Self::tag. None for a byte no codec claims.

pub const fn block_layout(self) -> Option<BlockLayout>

The block packing of the linear block codecs, None for every other codec.

pub const fn layout(self) -> Option<FloatLayout>

The element layout of the float codecs, None for every codec that is not a plain float layout (block-quantized integer codecs, codebooks, and the formats with no decoder). Fp6E3M2 is the layout of its six-bit fields; the f16 scale per 32 elements is its block.

Trait Implementations§

impl Clone for Codec

fn clone(&self) -> Self

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

impl Copy for Codec

impl Debug for Codec

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

Formats the value using the given formatter. Read more

impl Eq for Codec

impl PartialEq for Codec

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Codec

Auto Trait Implementations§

impl Freeze for Codec

impl RefUnwindSafe for Codec

impl Send for Codec

impl Sync for Codec

impl Unpin for Codec

impl UnsafeUnpin for Codec

impl UnwindSafe for Codec

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more