Struct BuildConfig 

pub struct BuildConfig {
    pub dimensions: usize,
    pub metric: Metric,
    pub backend: IndexBackend,
    pub storage: StorageParams,
    pub pq: PqParams,
    pub hnsw: HnswParams,
    pub ivf: IvfParams,
    pub num_shards: usize,
}

Top-level configuration for building an index.

Fields

dimensions: usize

Vector dimensionality. Must be set (> 0) and divisible by pq.num_subquantizers.

metric: Metric

Distance metric.

backend: IndexBackend

Which ANN backend to build.

storage: StorageParams

Disk storage parameters.

pq: PqParams

Product-quantization parameters (RAM approximate tier).

hnsw: HnswParams

HNSW parameters (used when backend == Hnsw).

ivf: IvfParams

IVF parameters (used when backend == Ivf).

num_shards: usize

Number of shards for the storage-efficient sharded build pipeline. 1 disables sharding.

Implementations

impl BuildConfig

pub fn new(dimensions: usize, metric: Metric, backend: IndexBackend) -> Self

Create a build configuration with the given dimensionality, metric, and backend, leaving all other parameters at their defaults.

pub fn validate(&self) -> Result<()>

Validate the entire configuration, including cross-field constraints.

Trait Implementations

impl Clone for BuildConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildConfig

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

Formats the value using the given formatter.

impl Default for BuildConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuildConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BuildConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BuildConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuildConfig