Skip to main content

Nf4Quantizer

Struct Nf4Quantizer 

Source
pub struct Nf4Quantizer {
    pub block_size: usize,
}
Expand description

NF4 quantizer — encodes tensors to packed 4-bit NF4 codes.

Blocks of block_size elements share an absmax scaling factor. The default block_size of 64 matches the QLoRA paper.

Fields§

§block_size: usize

Number of elements per absmax scaling block.

Implementations§

Source§

impl Nf4Quantizer

Source

pub fn new(block_size: usize) -> Self

Create an NF4 quantizer with the given block size.

§Panics

Panics if block_size == 0.

Source

pub fn encode(&self, tensor: &[f32]) -> QuantResult<(Vec<u8>, Vec<f32>)>

Encode a flat tensor to packed NF4 bytes and per-block absmax values.

The number of elements must be a multiple of block_size, and block_size must be even (pairs of nibbles pack into bytes).

Returns (packed_bytes, absmax_per_block).

§Errors
Source

pub fn decode(&self, packed: &[u8], absmaxs: &[f32]) -> QuantResult<Vec<f32>>

Decode packed NF4 bytes back to f32 using the stored absmax values.

§Errors
Source

pub fn quantization_mse(&self, tensor: &[f32]) -> QuantResult<f32>

Estimate the quantization error (mean squared error) for a tensor.

§Errors

Propagates errors from encode / decode.

Trait Implementations§

Source§

impl Clone for Nf4Quantizer

Source§

fn clone(&self) -> Nf4Quantizer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Nf4Quantizer

Source§

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

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

impl Default for Nf4Quantizer

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