Struct Metadata 

pub struct Metadata {
    pub num_chunks: usize,
    pub nbits: usize,
    pub num_partitions: usize,
    pub num_embeddings: usize,
    pub avg_doclen: f64,
    pub num_documents: usize,
    pub next_plaid_compatible: bool,
}

Metadata for the index

Fields

num_chunks: usize

Number of chunks in the index

nbits: usize

Number of bits for quantization

num_partitions: usize

Number of partitions (centroids)

num_embeddings: usize

Total number of embeddings

avg_doclen: f64

Average document length

num_documents: usize

Total number of documents

next_plaid_compatible: bool

Whether the index has been converted to next-plaid compatible format. If false or missing, the index may need fast-plaid to next-plaid conversion.

Implementations

impl Metadata

pub fn load_from_path(index_path: &Path) -> Result<Self>

Load metadata from a JSON file, inferring num_documents from doclens if not present.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Metadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.