Skip to main content

QuantDesc

Struct QuantDesc 

Source
#[repr(C)]
pub struct QuantDesc { pub len: u64, pub axis_plus_one: u64, pub scales: SendConstPtr<f32>, pub zero_points: SendConstPtr<i32>, }
Expand description

Quantization metadata, in a form that can cross an .so boundary.

crate::TensorDesc deliberately does not carry this: it is the shared descriptor, pinned by ABI_VERSION and consumed by the C API, where tensors travel as real ef_tensor handles into one shared libedgefirst_tensor.so and no reconstruction ever happens. The Python packages are the only consumers that rebuild a tensor from a descriptor, so this rides in the capsule payload rather than widening a C ABI that does not need it.

Variable-length by nature – per-channel quantization carries one scale (and optionally one zero-point) per channel – so the arrays are borrowed, not inlined: scales/zero_points point into the Quantization that TensorCapsulePayload::quant_keepalive owns, on exactly the terms crate::TensorDesc::ptr borrows the producer’s host address. A consumer copies the values out during import (see QuantDesc::to_quantization) while the capsule is still alive, and never retains the pointers.

Fields§

§len: u64

Number of entries in scales (and in zero_points when non-null). Zero means the tensor carries no quantization – the one field a consumer must check before reading either pointer.

§axis_plus_one: u64

Channel axis for per-channel quantization, plus one; 0 means per-tensor. Encoded this way so the whole struct zeroes to “absent” rather than needing a separate presence flag for an Option<usize>.

§scales: SendConstPtr<f32>

len scale factors. Null iff len == 0.

§zero_points: SendConstPtr<i32>

len zero-points, or null for symmetric quantization.

Implementations§

Source§

impl QuantDesc

Source

pub const fn absent() -> Self

The descriptor for a tensor with no quantization metadata.

Source

pub fn borrowing(quant: &Quantization) -> Self

Describe quant, borrowing its arrays.

The caller must keep quant alive for as long as the descriptor is readable – in the capsule protocol, by storing the same Arc in TensorCapsulePayload::quant_keepalive.

Source

pub unsafe fn to_quantization(&self) -> Result<Option<Quantization>>

Copy the borrowed arrays into an owned crate::Quantization, or None when the producer declared no quantization.

Ok(None) means “the producer has none”; a descriptor that declares quantization but cannot be read back as a valid crate::Quantization is an Err, not a second spelling of None. Conflating the two is what made the bug this whole capsule version exists to fix so hard to place: a tensor that quietly arrives unquantized surfaces much later as the consumer’s own “requires quantization metadata”, which names the symptom and not the cause.

§Safety

self must have come from a capsule that is still alive, so the arrays scales/zero_points point at are still owned by the producer’s quant_keepalive.

Trait Implementations§

Source§

impl Clone for QuantDesc

Source§

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
Source§

impl Copy for QuantDesc

Source§

impl Debug for QuantDesc

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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