Index

A

add() (autofaiss.indices.faiss_index_wrapper.FaissIndexWrapper method) (autofaiss.indices.memory_efficient_flat_index.MemEfficientFlatIndex method) add_all() (autofaiss.indices.memory_efficient_flat_index.MemEfficientFlatIndex method) add_embeddings_to_index() (in module autofaiss.external.build) add_embeddings_to_index_distributed() (in module autofaiss.indices.distributed) add_embeddings_to_index_local() (in module autofaiss.indices.build) add_files() (autofaiss.indices.memory_efficient_flat_index.MemEfficientFlatIndex method) autofaiss module autofaiss.external module autofaiss.external.build module autofaiss.external.descriptions module autofaiss.external.metadata module autofaiss.external.optimize module autofaiss.external.quantize module autofaiss.external.scores module autofaiss.indices module autofaiss.indices.build module autofaiss.indices.distributed module autofaiss.indices.faiss_index_wrapper module

autofaiss.indices.index_factory module autofaiss.indices.index_utils module autofaiss.indices.memory_efficient_flat_index module autofaiss.indices.search module autofaiss.indices.training module autofaiss.metrics module autofaiss.metrics.recalls module autofaiss.metrics.reconstruction module autofaiss.utils module autofaiss.utils.algorithms module autofaiss.utils.array_functions module autofaiss.utils.cast module autofaiss.utils.decorators module autofaiss.utils.path module autofaiss.version module

B

binary_search_on_param() (in module autofaiss.external.optimize)

build_index() (in module autofaiss.external.quantize), [1] build_partitioned_indexes() (in module autofaiss.external.quantize)

C

cast_bytes_to_memory_string() (in module autofaiss.utils.cast) cast_memory_to_bytes() (in module autofaiss.utils.cast) check_if_index_needs_training() (in module autofaiss.external.optimize) check_not_null_not_empty() (in module autofaiss.external.quantize) compute_fast_metrics() (in module autofaiss.external.scores) compute_medium_metrics() (in module autofaiss.external.scores) compute_memory_necessary_for_ivf_flat() (autofaiss.external.metadata.IndexMetadata method) compute_memory_necessary_for_opq_ivf_hnsw_pq() (autofaiss.external.metadata.IndexMetadata method) compute_memory_necessary_for_opq_ivf_pq() (autofaiss.external.metadata.IndexMetadata method) compute_memory_necessary_for_pad_ivf_hnsw_pq() (autofaiss.external.metadata.IndexMetadata method)

compute_memory_necessary_for_training() (autofaiss.external.metadata.IndexMetadata method) compute_memory_necessary_for_training_wrapper() (in module autofaiss.external.metadata) create_and_train_index_from_embedding_dir() (in module autofaiss.indices.training) create_and_train_new_index() (in module autofaiss.indices.training) create_big_index() (in module autofaiss.indices.distributed) create_empty_index() (in module autofaiss.indices.training) create_index() (in module autofaiss.external.build) create_partitioned_indexes() (in module autofaiss.external.build) (in module autofaiss.indices.distributed) create_small_index() (in module autofaiss.indices.distributed)

D

delete_vectors() (autofaiss.indices.memory_efficient_flat_index.MemEfficientFlatIndex method)

discrete_binary_search() (in module autofaiss.utils.algorithms)

E

EFSEARCH (autofaiss.external.descriptions.TunableParam attribute) embedding_reader_or_path (autofaiss.indices.training.TrainedIndex attribute)

estimate_memory_required_for_index_creation() (in module autofaiss.external.build) estimated_index_size_in_bytes() (autofaiss.external.metadata.IndexMetadata method) extract_partition_name_from_path() (in module autofaiss.utils.path)

F

FaissIndexWrapper (class in autofaiss.indices.faiss_index_wrapper) FLAT (autofaiss.external.descriptions.IndexBlock attribute) (autofaiss.external.metadata.IndexType attribute)

format_speed_ms_per_query() (in module autofaiss.indices.index_utils)

G

get_bytes_from_index() (in module autofaiss.indices.index_utils) get_estimated_construction_time_infos() (in module autofaiss.external.build) get_ground_truth() (in module autofaiss.external.scores) get_index_description() (autofaiss.external.metadata.IndexMetadata method) get_index_from_bytes() (in module autofaiss.indices.index_utils) get_index_size() (in module autofaiss.indices.index_utils) get_index_type() (autofaiss.external.metadata.IndexMetadata method) get_min_param_value_for_best_neighbors_coverage() (in module autofaiss.external.optimize)

get_optimal_batch_size() (in module autofaiss.external.optimize) get_optimal_hyperparameters() (in module autofaiss.external.optimize) get_optimal_index_keys_v2() (in module autofaiss.external.optimize) get_optimal_ivf() (in module autofaiss.external.optimize) get_optimal_nb_clusters() (in module autofaiss.external.optimize) get_optimal_quantization() (in module autofaiss.external.optimize) get_optimal_train_size() (in module autofaiss.external.optimize) get_optimize_index_fn() (in module autofaiss.indices.build) get_write_ids_df_to_parquet_fn() (in module autofaiss.indices.build)

H

HNSW (autofaiss.external.descriptions.IndexBlock attribute) (autofaiss.external.metadata.IndexType attribute)

HT (autofaiss.external.descriptions.TunableParam attribute)

I

index_factory() (in module autofaiss.indices.index_factory) index_key (autofaiss.indices.training.TrainedIndex attribute) index_key_to_nb_cluster() (in module autofaiss.external.optimize) index_or_path (autofaiss.indices.training.TrainedIndex attribute) IndexBlock (class in autofaiss.external.descriptions)

IndexMetadata (class in autofaiss.external.metadata) IndexType (class in autofaiss.external.metadata) initialize_direct_map() (in module autofaiss.indices.index_utils) IVF (autofaiss.external.descriptions.IndexBlock attribute) IVF_FLAT (autofaiss.external.metadata.IndexType attribute) IVF_HNSW (autofaiss.external.descriptions.IndexBlock attribute)

K

knn_query() (in module autofaiss.indices.search)

L

load_index() (in module autofaiss.indices.index_utils)

M

main() (in module autofaiss.external.quantize) make_path_absolute() (in module autofaiss.utils.path) MemEfficientFlatIndex (class in autofaiss.indices.memory_efficient_flat_index) module autofaiss autofaiss.external autofaiss.external.build autofaiss.external.descriptions autofaiss.external.metadata autofaiss.external.optimize autofaiss.external.quantize autofaiss.external.scores autofaiss.indices autofaiss.indices.build autofaiss.indices.distributed autofaiss.indices.faiss_index_wrapper autofaiss.indices.index_factory autofaiss.indices.index_utils autofaiss.indices.memory_efficient_flat_index autofaiss.indices.search autofaiss.indices.training autofaiss.metrics autofaiss.metrics.recalls autofaiss.metrics.reconstruction autofaiss.utils autofaiss.utils.algorithms autofaiss.utils.array_functions autofaiss.utils.cast autofaiss.utils.decorators autofaiss.utils.path autofaiss.version

multi_array_split() (in module autofaiss.utils.array_functions)

N

NOT_SUPPORTED (autofaiss.external.metadata.IndexType attribute)

NPROBE (autofaiss.external.descriptions.TunableParam attribute)

O

one_recall_at_r() (in module autofaiss.metrics.recalls) one_recall_at_r_single() (in module autofaiss.metrics.recalls) OPQ (autofaiss.external.descriptions.IndexBlock attribute)

OPQ_IVF_HNSW_PQ (autofaiss.external.metadata.IndexType attribute) OPQ_IVF_PQ (autofaiss.external.metadata.IndexType attribute) optimize_and_measure_index() (in module autofaiss.external.optimize)

P

PAD (autofaiss.external.descriptions.IndexBlock attribute) PAD_IVF_HNSW_PQ (autofaiss.external.metadata.IndexType attribute)

parallel_download_indices_from_remote() (in module autofaiss.indices.index_utils) PQ (autofaiss.external.descriptions.IndexBlock attribute)

Q

quantize_vec_without_modifying_index() (in module autofaiss.indices.index_utils) (in module autofaiss.metrics.reconstruction)

R

r_recall_at_r() (in module autofaiss.metrics.recalls)

r_recall_at_r_single() (in module autofaiss.metrics.recalls) reconstruction_error() (in module autofaiss.metrics.reconstruction)

S

sanitize() (in module autofaiss.utils.array_functions) save_index() (in module autofaiss.indices.index_utils) score_index() (in module autofaiss.external.quantize), [1] search() (autofaiss.indices.faiss_index_wrapper.FaissIndexWrapper method) (autofaiss.indices.memory_efficient_flat_index.MemEfficientFlatIndex method) search_files() (autofaiss.indices.memory_efficient_flat_index.MemEfficientFlatIndex method)

search_numpy() (autofaiss.indices.memory_efficient_flat_index.MemEfficientFlatIndex method) search_speed_test() (in module autofaiss.indices.index_utils) set_search_hyperparameters() (in module autofaiss.indices.index_utils) setup_logging() (in module autofaiss.external.quantize) should_run_once() (in module autofaiss.utils.decorators) speed_test_ms_per_query() (in module autofaiss.indices.index_utils)

T

Timeit (class in autofaiss.utils.decorators) timer() (in module autofaiss.utils.decorators) to_faiss_metric_type() (in module autofaiss.utils.cast)

to_readable_time() (in module autofaiss.utils.cast) TrainedIndex (class in autofaiss.indices.training) TunableParam (class in autofaiss.external.descriptions) tune_index() (in module autofaiss.external.quantize), [1]