Skip to main content

Quantization

Struct Quantization 

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

Quantization parameters for an integer tensor.

Covers all four modes the edgefirst.json spec defines:

Modescale.len()zero_pointaxis
Per-tensor symmetric1NoneNone
Per-tensor asymmetric1Some(len == 1)None
Per-channel symmetric>1NoneSome(c)
Per-channel asymmetric>1Some(len == scale.len())Some(c)

The quantized storage type is carried on the parent Tensor<T>; this struct does not duplicate it. Construct via the four named constructors (the only public entry points); direct field mutation is not allowed so invalid combinations cannot be represented.

Dequantization formula:

  real_value = scale[c] × (quantized_value[c] - zero_point[c])

where c is the channel index (always 0 for per-tensor).

Implementations§

Source§

impl Quantization

Source

pub fn per_tensor_symmetric(scale: f32) -> Self

Per-tensor symmetric (zero_point = 0).

Source

pub fn per_tensor(scale: f32, zero_point: i32) -> Self

Per-tensor asymmetric — the most common runtime shape.

Source

pub fn per_channel_symmetric(scales: Vec<f32>, axis: usize) -> Result<Self>

Per-channel symmetric. Errors on empty scales.

Source

pub fn per_channel( scales: Vec<f32>, zero_points: Vec<i32>, axis: usize, ) -> Result<Self>

Per-channel asymmetric. Errors on length mismatch between scales and zero_points, or empty arrays.

Source

pub fn mode(&self) -> QuantMode<'_>

Borrow-based dispatch view. Match once at kernel entry.

Source

pub fn is_per_tensor(&self) -> bool

Returns true for per-tensor quantization (scale.len() == 1).

Source

pub fn is_per_channel(&self) -> bool

Returns true for per-channel quantization (scale.len() > 1).

Source

pub fn is_symmetric(&self) -> bool

Returns true for symmetric quantization (no zero-point, or zero-point vector of all zeros).

Source

pub fn scale(&self) -> &[f32]

Borrow the scale array. Length 1 for per-tensor; num_channels for per-channel.

Source

pub fn zero_point(&self) -> Option<&[i32]>

Borrow the zero-point array. None for symmetric.

Source

pub fn axis(&self) -> Option<usize>

Channel axis for per-channel quantization. None for per-tensor.

Trait Implementations§

Source§

impl Clone for Quantization

Source§

fn clone(&self) -> Quantization

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 Quantization

Source§

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

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

impl<'de> Deserialize<'de> for Quantization

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<(f32, i32)> for Quantization

Source§

fn from((scale, zero_point): (f32, i32)) -> Self

Convenience construction from a (scale, zero_point) tuple. Matches the legacy QuantTuple / Quantization::new calling convention so existing (0.1, -128).into() sites keep working.

Source§

impl PartialEq for Quantization

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Quantization

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Quantization

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,