Skip to main content

PQConfig

Struct PQConfig 

Source
pub struct PQConfig {
    pub dim: usize,
    pub num_subspaces: usize,
    pub dims_per_block: usize,
    pub num_centroids: usize,
    pub seed: u64,
    pub anisotropic: bool,
    pub aniso_eta: f32,
    pub aniso_threshold: f32,
    pub use_opq: bool,
    pub opq_iters: usize,
}
Expand description

Configuration for Product Quantization with OPQ and Anisotropic Loss

Fields§

§dim: usize

Vector dimension

§num_subspaces: usize

Number of subspaces (M) - computed from dim / dims_per_block

§dims_per_block: usize

Dimensions per subspace block (ScaNN recommends 2)

§num_centroids: usize

Number of centroids per subspace (K) - typically 256 for u8 codes

§seed: u64

Random seed for reproducibility

§anisotropic: bool

Use anisotropic quantization (true ScaNN-style parallel/orthogonal weighting)

§aniso_eta: f32

Anisotropic eta: ratio of parallel to orthogonal error weight (η)

§aniso_threshold: f32

Anisotropic threshold T: only consider inner products >= T

§use_opq: bool

Use OPQ rotation matrix (learned via SVD)

§opq_iters: usize

Number of OPQ iterations

Implementations§

Source§

impl PQConfig

Source

pub fn new(dim: usize) -> Self

Create config with ScaNN-recommended defaults

Source

pub fn new_fast(dim: usize) -> Self

Create config with larger subspaces (faster but less accurate)

Source

pub fn new_balanced(dim: usize) -> Self

Create balanced config (good recall/speed tradeoff) Uses 16 subspaces for 128D+ vectors, 8 for smaller

Source

pub fn with_dims_per_block(self, d: usize) -> Self

Source

pub fn with_subspaces(self, m: usize) -> Self

Source

pub fn with_centroids(self, k: usize) -> Self

Source

pub fn with_anisotropic(self, enabled: bool, eta: f32) -> Self

Source

pub fn with_opq(self, enabled: bool, iters: usize) -> Self

Source

pub fn subspace_dim(&self) -> usize

Dimension of each subspace

Trait Implementations§

Source§

impl Clone for PQConfig

Source§

fn clone(&self) -> PQConfig

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 PQConfig

Source§

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

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

impl<'de> Deserialize<'de> for PQConfig

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 Serialize for PQConfig

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

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,