Struct lance::index::vector::VectorIndexParams

source · 
pub struct VectorIndexParams {
    pub num_partitions: u32,
    pub nbits: u8,
    pub num_sub_vectors: u32,
}
Expand description

The parameters to build vector index.

Fields§

§num_partitions: u32

The number of IVF partitions

§nbits: u8

the number of bits to present the centroids used in PQ.

§num_sub_vectors: u32

the number of sub vectors used in PQ.

Implementations§

source§

impl VectorIndexParams

source

pub fn ivf_pq(num_partitions: u32, nbits: u8, num_sub_vectors: u32) -> Self

Create index parameters for IVF_PQ index.

Parameters

  • num_partitions: the number of IVF partitions.
  • nbits: the number of bits to present the centroids used in PQ. Can only be 8 for now.
  • num_sub_vectors: the number of sub vectors used in PQ.

Trait Implementations§

source§

impl Default for VectorIndexParams

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl IndexParams for VectorIndexParams

source§

fn as_any(&self) -> &dyn Any

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere
T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · 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 Twhere
U: From<T>,

const: unstable · 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> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

§

fn vzip(self) -> V

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

impl<T> Allocation for Twhere
T: RefUnwindSafe + Send + Sync,