Struct lance_index::vector::pq::builder::PQBuildParams

pub struct PQBuildParams {
    pub num_sub_vectors: usize,
    pub num_bits: usize,
    pub use_opq: bool,
    pub max_iters: usize,
    pub max_opq_iters: usize,
    pub codebook: Option<ArrayRef>,
    pub sample_rate: usize,
}

Parameters for building product quantizer.

Fields

num_sub_vectors: usize

Number of sub-vectors to build PQ code

num_bits: usize

The number of bits to present one PQ centroid.

use_opq: bool

Train as optimized product quantization.

max_iters: usize

The max number of iterations for kmeans training.

max_opq_iters: usize

Max number of iterations to train Optimized Product Quantization, if use_opq is true.

codebook: Option<ArrayRef>

User provided codebook.

sample_rate: usize

Sample rate to train PQ codebook.

Implementations

impl PQBuildParams

pub fn new(num_sub_vectors: usize, num_bits: usize) -> Self

pub fn with_codebook( num_sub_vectors: usize, num_bits: usize, codebook: ArrayRef ) -> Self

pub async fn build_from_matrix<T: ArrowFloatType + Dot + Cosine + L2 + 'static>( &self, data: &MatrixView<T>, metric_type: MetricType ) -> Result<Arc<dyn ProductQuantizer + 'static>>

pub async fn build( &self, data: &dyn Array, metric_type: MetricType ) -> Result<Arc<dyn ProductQuantizer>>

Build a ProductQuantizer from the given data.

Trait Implementations

impl Clone for PQBuildParams

fn clone(&self) -> PQBuildParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PQBuildParams

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

Formats the value using the given formatter.

impl Default for PQBuildParams

fn default() -> Self

Returns the “default value” for a type.