Skip to main content

EncodeQualityMetrics

Struct EncodeQualityMetrics 

Source
pub struct EncodeQualityMetrics {
    pub n_rows: usize,
    pub certified_rows: usize,
    pub fallback_rate: f64,
    pub support_agreement: f64,
    pub max_coord_abs_err: f64,
    pub max_reconstruction_abs_err: f64,
    pub reconstruction_ev: f64,
}
Expand description

Correctness of an encode result, measured against the production CPU encode (a per-row reference) and the reconstruction it implies.

Every field is a quantity a “batched exact per-row encode” claim has to stand on: it must AGREE with the production per-row encode (support + coordinates), it must RECONSTRUCT the targets (explained variance), and it must be honest about how many rows it could not certify (fallback rate).

Fields§

§n_rows: usize

Rows compared.

§certified_rows: usize

Rows the encode-under-test certified (h ≤ ½, exact-into-the-ball).

§fallback_rate: f64

Fraction of rows the encode-under-test could NOT certify and flagged for the multi-start fallback (1 - certified_rows/n_rows). This is the “fallback rate”.

§support_agreement: f64

Fraction of rows whose certificate flag AGREES with the per-row reference encode. For a correct batched encode this is 1.0 (the batch is just the per-row encode fanned out).

§max_coord_abs_err: f64

Largest absolute latent-coordinate difference between the encode-under-test and the per-row reference encode, over all rows and coordinate dims. A correct batched encode matches the per-row encode to round-off (≈ 0).

§max_reconstruction_abs_err: f64

Largest absolute element-wise reconstruction residual |x̂ − x| over the whole batch (the “amplitude”/reconstruction error in raw output units).

§reconstruction_ev: f64

Reconstruction explained variance 1 − ‖X − X̂‖²_F / ‖X − X̄‖²_F, with each output column centered by its own mean . 1.0 is a perfect on-manifold reconstruction; 0.0 is no better than the per-column mean.

Trait Implementations§

Source§

impl Clone for EncodeQualityMetrics

Source§

fn clone(&self) -> EncodeQualityMetrics

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 EncodeQualityMetrics

Source§

impl Debug for EncodeQualityMetrics

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<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> 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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V