autofaiss package

Subpackages

• autofaiss.external package
  • Submodules
  • autofaiss.external.build module
    • add_embeddings_to_index()
    • create_index()
    • create_partitioned_indexes()
    • estimate_memory_required_for_index_creation()
    • get_estimated_construction_time_infos()
  • autofaiss.external.descriptions module
    • IndexBlock
      • IndexBlock.FLAT
      • IndexBlock.HNSW
      • IndexBlock.IVF
      • IndexBlock.IVF_HNSW
      • IndexBlock.OPQ
      • IndexBlock.PAD
      • IndexBlock.PQ
    • TunableParam
      • TunableParam.EFSEARCH
      • TunableParam.HT
      • TunableParam.NPROBE
  • autofaiss.external.metadata module
    • IndexMetadata
      • IndexMetadata.compute_memory_necessary_for_ivf_flat()
      • IndexMetadata.compute_memory_necessary_for_opq_ivf_hnsw_pq()
      • IndexMetadata.compute_memory_necessary_for_opq_ivf_pq()
      • IndexMetadata.compute_memory_necessary_for_pad_ivf_hnsw_pq()
      • IndexMetadata.compute_memory_necessary_for_training()
      • IndexMetadata.estimated_index_size_in_bytes()
      • IndexMetadata.get_index_description()
      • IndexMetadata.get_index_type()
    • IndexType
      • IndexType.FLAT
      • IndexType.HNSW
      • IndexType.IVF_FLAT
      • IndexType.NOT_SUPPORTED
      • IndexType.OPQ_IVF_HNSW_PQ
      • IndexType.OPQ_IVF_PQ
      • IndexType.PAD_IVF_HNSW_PQ
    • compute_memory_necessary_for_training_wrapper()
  • autofaiss.external.optimize module
    • binary_search_on_param()
    • check_if_index_needs_training()
    • get_min_param_value_for_best_neighbors_coverage()
    • get_optimal_batch_size()
    • get_optimal_hyperparameters()
    • get_optimal_index_keys_v2()
    • get_optimal_ivf()
    • get_optimal_nb_clusters()
    • get_optimal_quantization()
    • get_optimal_train_size()
    • index_key_to_nb_cluster()
    • optimize_and_measure_index()
  • autofaiss.external.quantize module
    • build_index()
    • build_partitioned_indexes()
    • check_not_null_not_empty()
    • main()
    • score_index()
    • setup_logging()
    • tune_index()
  • autofaiss.external.scores module
    • compute_fast_metrics()
    • compute_medium_metrics()
    • get_ground_truth()
  • Module contents
• autofaiss.indices package
  • Submodules
  • autofaiss.indices.build module
    • add_embeddings_to_index_local()
    • get_optimize_index_fn()
    • get_write_ids_df_to_parquet_fn()
  • autofaiss.indices.distributed module
    • add_embeddings_to_index_distributed()
    • create_big_index()
    • create_partitioned_indexes()
    • create_small_index()
  • autofaiss.indices.faiss_index_wrapper module
    • FaissIndexWrapper
      • FaissIndexWrapper.add()
      • FaissIndexWrapper.search()
  • autofaiss.indices.index_factory module
    • index_factory()
  • autofaiss.indices.index_utils module
    • format_speed_ms_per_query()
    • get_bytes_from_index()
    • get_index_from_bytes()
    • get_index_size()
    • initialize_direct_map()
    • load_index()
    • parallel_download_indices_from_remote()
    • quantize_vec_without_modifying_index()
    • save_index()
    • search_speed_test()
    • set_search_hyperparameters()
    • speed_test_ms_per_query()
  • autofaiss.indices.memory_efficient_flat_index module
    • MemEfficientFlatIndex
      • MemEfficientFlatIndex.add()
      • MemEfficientFlatIndex.add_all()
      • MemEfficientFlatIndex.add_files()
      • MemEfficientFlatIndex.delete_vectors()
      • MemEfficientFlatIndex.search()
      • MemEfficientFlatIndex.search_files()
      • MemEfficientFlatIndex.search_numpy()
  • autofaiss.indices.search module
    • knn_query()
  • autofaiss.indices.training module
    • TrainedIndex
      • TrainedIndex.embedding_reader_or_path
      • TrainedIndex.index_key
      • TrainedIndex.index_or_path
    • create_and_train_index_from_embedding_dir()
    • create_and_train_new_index()
    • create_empty_index()
  • Module contents
• autofaiss.metrics package
  • Submodules
  • autofaiss.metrics.benchmark module
  • autofaiss.metrics.recalls module
    • one_recall_at_r()
    • one_recall_at_r_single()
    • r_recall_at_r()
    • r_recall_at_r_single()
  • autofaiss.metrics.reconstruction module
    • quantize_vec_without_modifying_index()
    • reconstruction_error()
  • Module contents
• autofaiss.utils package
  • Submodules
  • autofaiss.utils.algorithms module
    • discrete_binary_search()
  • autofaiss.utils.array_functions module
    • multi_array_split()
    • sanitize()
  • autofaiss.utils.cast module
    • cast_bytes_to_memory_string()
    • cast_memory_to_bytes()
    • to_faiss_metric_type()
    • to_readable_time()
  • autofaiss.utils.decorators module
    • Timeit
    • should_run_once()
    • timer()
  • autofaiss.utils.path module
    • extract_partition_name_from_path()
    • make_path_absolute()
  • Module contents

Submodules

autofaiss.version module

Module contents