Struct AsyncQuantLoadContext 

pub struct AsyncQuantLoadContext {
    pub metadata: AsyncIndexMetadata,
    pub num_frozen_points: NonZeroUsize,
    pub metric: Metric,
    pub prefetch_lookahead: Option<usize>,
    pub is_disk_index: bool,
    pub prefetch_cache_line_level: Option<PrefetchCacheLineLevel>,
}

Indicates that the canonical layout for a Quant index is expected for deserialization.

For a file-path prefix prefix, this layout includes the following files:

Common:

• prefix: The file that contains the saved graph.
• prefix.data: The serialized full-precision data in .bin form.

Depending on the quantization method used, one of the following sets of files will also be present:

If Product Quantization (PQ) is used:

• prefix_build_pq_pivots.bin: The saved PQ pivot table.
• prefix_build_pq_compressed.bin: The saved PQ codes.

If Scalar Quantization (SQ) is used:

• prefix_sq_compressed.bin: The saved scalar quantized codes.
• prefix_scalar_quantizer_proto.bin: The saved scalar quantizer metadata.

Fields

metadata: AsyncIndexMetadata

The file path prefix of the index.

num_frozen_points: NonZeroUsize

The number of frozen points stored in the datasets.

metric: Metric

The metric to use for this index.

prefetch_lookahead: Option<usize>

The number of iterations to prefetch when performing bulk-retrievals.

is_disk_index: bool

Temporary parameter to indicate if the index is a disk index to load right file names. This can be removed once disk index uses same file names as async index.

prefetch_cache_line_level: Option<PrefetchCacheLineLevel>

controls the prefetch cache line level for the index.

Trait Implementations

impl LoadWith<AsyncQuantLoadContext> for NoStore

type Error = ANNError

The error type if deserialization is unsuccessful.

async fn load_with<P>(_: &P, _: &AsyncQuantLoadContext) -> ANNResult<Self>

where P: StorageReadProvider,

Load self form disk using provider for IO-related needs. Argument auxiliary can be arbitrary metadata required for a successful operation, such as file paths.

impl<T> LoadWith<AsyncQuantLoadContext> for MemoryVectorProviderAsync<T>

where T: VectorRepr,

async fn load_with<P>( provider: &P, ctx: &AsyncQuantLoadContext, ) -> ANNResult<Self>

where P: StorageReadProvider,

Load the dataset to a file beginning with the prefix and ending in .data.

The format of the serialized should be in the traditional .bin format.

type Error = ANNError

The error type if deserialization is unsuccessful.

impl LoadWith<AsyncQuantLoadContext> for MemoryQuantVectorProviderAsync

async fn load_with<P>( provider: &P, ctx: &AsyncQuantLoadContext, ) -> ANNResult<Self>

where P: StorageReadProvider,

Load the quant vector provider using the prefix in ctx~ as a prefix to [PQPathNames`] along with the number of PQ bytes.

type Error = ANNError

The error type if deserialization is unsuccessful.

impl LoadWith<AsyncQuantLoadContext> for SimpleNeighborProviderAsync

This is an adaptor for compatibility with the async index serialization.

type Error = ANNError

The error type if deserialization is unsuccessful.

async fn load_with<P>( provider: &P, ctx: &AsyncQuantLoadContext, ) -> ANNResult<Self>

where P: StorageReadProvider,

Load self form disk using provider for IO-related needs. Argument auxiliary can be arbitrary metadata required for a successful operation, such as file paths.

impl<T> LoadWith<AsyncQuantLoadContext> for FastMemoryVectorProviderAsync<T>

where T: VectorRepr,

async fn load_with<P>( provider: &P, ctx: &AsyncQuantLoadContext, ) -> ANNResult<Self>

where P: StorageReadProvider,

Load the dataset to a file beginning with the prefix and ending in .data.

The format of the serialized should be in the traditional .bin format.

type Error = ANNError

The error type if deserialization is unsuccessful.

impl LoadWith<AsyncQuantLoadContext> for FastMemoryQuantVectorProviderAsync

async fn load_with<P>( provider: &P, ctx: &AsyncQuantLoadContext, ) -> ANNResult<Self>

where P: StorageReadProvider,

Load the quant vector provider using the prefix in ctx~ as a prefix to [PQPathNames`] along with the number of PQ bytes.

type Error = ANNError

The error type if deserialization is unsuccessful.

impl<U, V, D, Ctx> LoadWith<AsyncQuantLoadContext> for DefaultProvider<U, V, D, Ctx>

where U: VectorStore + LoadWith<AsyncQuantLoadContext>, V: VectorStore + AsyncFriendly + LoadWith<AsyncQuantLoadContext>, D: AsyncFriendly + LoadWith<usize>, ANNError: From<U::Error> + From<V::Error> + From<D::Error>, Ctx: ExecutionContext,

type Error = ANNError

The error type if deserialization is unsuccessful.

async fn load_with<P>( provider: &P, ctx: &AsyncQuantLoadContext, ) -> ANNResult<Self>

where P: StorageReadProvider,

Load self form disk using provider for IO-related needs. Argument auxiliary can be arbitrary metadata required for a successful operation, such as file paths.

impl<const NBITS: usize> LoadWith<AsyncQuantLoadContext> for SQStore<NBITS>

where Unsigned: Representation<NBITS>,

type Error = ANNError

The error type if deserialization is unsuccessful.

async fn load_with<P>( read_provider: &P, ctx: &AsyncQuantLoadContext, ) -> ANNResult<Self>

where P: StorageReadProvider,

Load self form disk using provider for IO-related needs. Argument auxiliary can be arbitrary metadata required for a successful operation, such as file paths.