faiss.index_ivf

Undocumented in source.

Members

Aliases

FaissIndexIVF
alias FaissIndexIVF = FaissIndex_H
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Functions

faiss_IndexIVFStats_init
void faiss_IndexIVFStats_init(FaissIndexIVFStats* stats)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_IndexIVFStats_reset
void faiss_IndexIVFStats_reset(FaissIndexIVFStats* stats)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_IndexIVF_cast
FaissIndexIVF* faiss_IndexIVF_cast(FaissIndex* )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_IndexIVF_copy_subset_to
int faiss_IndexIVF_copy_subset_to(const(FaissIndexIVF)* index, FaissIndexIVF* other, int subset_type, idx_t a1, idx_t a2)

copy a subset of the entries index to the other index

faiss_IndexIVF_free
void faiss_IndexIVF_free(FaissIndexIVF* obj)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_IndexIVF_get_list_size
size_t faiss_IndexIVF_get_list_size(const(FaissIndexIVF)* index, size_t list_no)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_IndexIVF_imbalance_factor
double faiss_IndexIVF_imbalance_factor(const(FaissIndexIVF)* index)

Check the inverted lists' imbalance factor.

faiss_IndexIVF_invlists_get_ids
void faiss_IndexIVF_invlists_get_ids(const(FaissIndexIVF)* index, size_t list_no, idx_t* invlist)

Get the IDs in an inverted list. IDs are written to invlist, which must be large enough / to accommodate the full list.

faiss_IndexIVF_make_direct_map
int faiss_IndexIVF_make_direct_map(FaissIndexIVF* index, int new_maintain_direct_map)

initialize a direct map

faiss_IndexIVF_merge_from
int faiss_IndexIVF_merge_from(FaissIndexIVF* index, FaissIndexIVF* other, idx_t add_id)

moves the entries from another dataset to self. On output, * other is empty. add_id is added to all moved ids (for * sequential ids, this would be this->ntotal

faiss_IndexIVF_nlist
size_t faiss_IndexIVF_nlist(const(FaissIndexIVF)* )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_IndexIVF_nprobe
size_t faiss_IndexIVF_nprobe(const(FaissIndexIVF)* )

number of probes at query time

faiss_IndexIVF_own_fields
int faiss_IndexIVF_own_fields(const(FaissIndexIVF)* )

whether object owns the quantizer

faiss_IndexIVF_print_stats
void faiss_IndexIVF_print_stats(const(FaissIndexIVF)* index)

display some stats about the inverted lists of the index

faiss_IndexIVF_quantizer
FaissIndex* faiss_IndexIVF_quantizer(const(FaissIndexIVF)* )

quantizer that maps vectors to inverted lists

faiss_IndexIVF_quantizer_trains_alone
char faiss_IndexIVF_quantizer_trains_alone(const(FaissIndexIVF)* )

= 0: use the quantizer as index in a kmeans training = 1: just pass on the training set to the train() of the quantizer = 2: kmeans training on a flat index + add the centroids to the quantizer

faiss_IndexIVF_search_preassigned
int faiss_IndexIVF_search_preassigned(const(FaissIndexIVF)* index, idx_t n, const(float)* x, idx_t k, const(idx_t)* assign, const(float)* centroid_dis, float* distances, idx_t* labels, int store_pairs)

search a set of vectors, that are pre-quantized by the IVF quantizer. Fill in the corresponding heaps with the query results. search() calls this.

faiss_IndexIVF_set_nprobe
void faiss_IndexIVF_set_nprobe(FaissIndexIVF* , size_t )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_IndexIVF_set_own_fields
void faiss_IndexIVF_set_own_fields(FaissIndexIVF* , int )
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
faiss_get_indexIVF_stats
FaissIndexIVFStats* faiss_get_indexIVF_stats()

global var that collects all statists

Structs

FaissIndexIVFStats
struct FaissIndexIVFStats
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FaissIndex_H
struct FaissIndex_H

Index based on a inverted file (IVF)

Meta