Alibek Zhakubayev 261d8f25aa Add IVFSQTurboQSearchParameters to __init__.pyi stub (#5304) ...

Summary:
Pull Request resolved: https://github.com/facebookresearch/faiss/pull/5304

Add IVFSQTurboQSearchParameters to the authoritative __init__.pyi type stub.

TurboQuant was added to ScalarQuantizer in D102408184, which introduced
IVFSQTurboQSearchParameters in IndexScalarQuantizer.h. The struct controls
two new per-search parameters:
- qb: query quantization bits for MSE pre-screening (0 = float path,
  1-8 = integer popcount path)
- int_qjl: use integer popcount for the QJL sign-bit stage (requires qb > 0)

IndexScalarQuantizer.h is `%include`d in swigfaiss.swig so SWIG wraps the
struct at runtime. However, __init__.pyi (the authoritative Pyre type source
since D107274305) was not updated when the struct was added. Any Pyre-checked
code that uses IVFSQTurboQSearchParameters receives [missing-attribute] errors.

Pattern matches the approach used in D107508282, which added
SearchParametersHNSW and SearchParametersPQ for the same gap.

Reviewed By: limqiying, mnorris11

Differential Revision: D108001955

fbshipit-source-id: 6cfbb0dddea1e09562b8185888c571aea229b747

2026-06-11 12:56:37 -07:00

..

index_io_backward_compatibility

Re-enable backwards compatibility tests for rabitq now that 1.14.1 released (#4924)

2026-03-13 19:32:05 -07:00

CMakeLists.txt

CI: cross-compile for riscv64 with RVV dynamic dispatch (#5184)

2026-05-07 08:50:12 -07:00

common_faiss_tests.py

Introduce RVV (#5156)

2026-05-05 16:54:09 -07:00

external_module_test.py

Re-add example of how to build, link, and test an external SWIG module"" (#3981)

2024-10-23 07:34:38 -07:00

test_approx_topk.cpp

Convert approx_topk and residual_quantizer_encode_steps to SIMDLevel dynamic dispatch (#4923)

2026-03-14 15:12:14 -07:00

test_autotune.py

Parameterize existing tests with @for_all_simd_levels (#5134)

2026-04-22 02:28:03 -07:00

test_binary_autotune.py

support SearchParameters for IndexBinary (#4761)

2026-02-04 00:03:15 -08:00

test_binary_factory.py

Add IndexBinaryIDMap2 support to index binary factory (#4603)

2025-10-14 16:47:57 -07:00

test_binary_flat.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_binary_hash.cpp

Fix IndexBinaryMultiHash::reset() not clearing hash maps and avoid unnecessary copies (#5100)

2026-04-14 23:35:31 -07:00

test_binary_hashindex.py

Parameterize existing tests with @for_all_simd_levels (#5134)

2026-04-22 02:28:03 -07:00

test_binary_io.py

Strengthen roundtrip tests by doing serialization after deserialization (#4851)

2026-03-02 16:30:12 -08:00

test_binary_search_params.py

Parameterize existing tests with @for_all_simd_levels (#5134)

2026-04-22 02:28:03 -07:00

test_build_blocks.py

Fix PCA training bug and memory safety issues in VectorTransform.cpp (#5138)

2026-04-22 15:29:57 -07:00

test_callback_py.py

Reduce memory usage in timeout callback tests (#4745)

2026-01-05 15:00:20 -08:00

test_callback.cpp

Reduce memory usage in timeout callback tests (#4745)

2026-01-05 15:00:20 -08:00

test_clone.py

Fix clone_index null return for IndexRowwiseMinMax (#5220)

2026-05-18 14:35:48 -07:00

test_clustering_initialization.py

Add k-means++ and AFK-MC² centroid initialization methods (#4740)

2025-12-26 08:43:09 -08:00

test_clustering.py

Add early stopping to k-means clustering (#4741)

2025-12-29 14:05:23 -08:00

test_common_ivf_empty_index.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_contrib_with_scipy.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_contrib.py

Support IndexIDMap/IndexIDMap2 in reverse_index_factory (#5266)

2026-06-02 10:49:01 -07:00

test_cppcontrib_sa_decode.cpp

Fix CQS signal readability-braces-around-statements in fbcode/faiss/tests (#4457)

2025-07-25 02:37:10 -07:00

test_cppcontrib_uintreader.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_custom_result_handler.cpp

generic result handlers for most indexes (#4762)

2026-01-21 13:58:27 -08:00

test_dealloc_invlists.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_disable_pq_sdc_tables.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_distances_dispatch.cpp

Add C++ per-SIMD-level tests for distance utility functions (#5154)

2026-04-29 09:37:46 -07:00

test_distances_simd.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_documentation.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_extra_distances.py

Roll out @for_all_simd_levels to key test files (#5061)

2026-04-08 10:56:41 -07:00

test_factory_tools.cpp

Add TurboQuant (CPU) (#5049)

2026-04-24 16:32:53 -07:00

test_factory.py

Fix memory leak warning for unordered_multimap in IndexIVFFlatDedup Python binding (#1667) (#5145)

2026-04-28 13:10:11 -07:00

test_fast_scan_distance_to_code.cpp

Implement distance_to_code for IVFRaBitQFastScanScanner (#4822)

2026-02-20 19:39:13 -08:00

test_fast_scan_ivf.py

Fix lints associated with early stop facilities for IVF (#5172)

2026-05-04 10:25:15 -07:00

test_fast_scan.py

Fix FastScan DD regression by threading SIMD level through kernel functions (#5210)

2026-05-18 09:16:10 -07:00

test_fastscan_filter.cpp

introduce SingleQueryResultCollectHandler (#4926)

2026-03-18 14:05:55 -07:00

test_fastscan_filter.py

Fix python_unnecessary_generator_set_comprehension issues in faiss/tests/test_fastscan_filter.py (#5215)

2026-05-18 14:28:41 -07:00

test_fastscan_perf.cpp

Enable dynamic dispatch build on Windows (#5127)

2026-04-23 13:31:11 -07:00

test_flat_panorama.py

Fix Panorama segfault (#5200)

2026-05-22 11:36:07 -07:00

test_graph_based.py

IndexHNSW: use HNSW::is_similarity for IP/similarity metrics + tests (#5226)

2026-05-30 02:02:42 -07:00

test_hamming_utils.py

Add per-SIMD-level tests for hamming.h utils + fix crosshamming bug (#5153)

2026-04-29 05:15:25 -07:00

test_hamming.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_heap.cpp

faiss: initialize ids_tab to -1 in Top1BlockResultHandler::begin_multiple (#5249)

2026-05-28 13:28:59 -07:00

test_hnsw_panorama.py

Fix Panorama segfault (#5200)

2026-05-22 11:36:07 -07:00

test_hnsw.cpp

avoid runtime checks in VisitedTable (#5234)

2026-05-30 02:02:42 -07:00

test_index_accuracy.py

Add tolerance and assertion log to test_OIVFPQ (#5188)

2026-05-06 23:11:37 -07:00

test_index_binary_from_float.py

Parameterize existing tests with @for_all_simd_levels (#5134)

2026-04-22 02:28:03 -07:00

test_index_binary.py

Fix broken fbcode//faiss/tests:test_index_binary - test_replicas (test_index_binary.TestReplicasAndS (#5258)

2026-05-29 19:25:51 -07:00

test_index_composite.py

Add CappedInvertedLists for per-list size limiting (#4880)

2026-03-19 11:55:22 -07:00

test_index.py

Add database-parallel flat search for few-query workloads (#5000)

2026-04-30 07:48:17 -07:00

test_io_corrupted.cpp

Fix NSG off-by-one neighbor ID check (#4804)

2026-02-12 21:09:31 -08:00

test_io.py

Fix peak-memory spike when loading IVF invlists via IO_FLAG_MMAP_IFC (#5122)

2026-05-04 08:58:51 -07:00

test_ivf_early_termination.cpp

Fix lints associated with early stop facilities for IVF (#5172)

2026-05-04 10:25:15 -07:00

test_ivf_flat_panorama.py

Fix Panorama segfault (#5200)

2026-05-22 11:36:07 -07:00

test_ivf_index.cpp

Add iterator callbacks for distance computation and heap admission (#5082)

2026-04-11 01:04:37 -07:00

test_ivflib.py

Fix cloning for IVFFlatPanorama (#4887)

2026-03-09 13:37:57 -07:00

test_ivfpq_codec.cpp

facebook-unused-include-check in fbcode/faiss (#4029)

2024-11-15 13:53:46 -08:00

test_ivfpq_indexing.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_local_search_quantizer.py

Parameterize existing tests with @for_all_simd_levels (#5134)

2026-04-22 02:28:03 -07:00

test_lowlevel_ivf.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_merge_index.py

Parameterize existing tests with @for_all_simd_levels (#5134)

2026-04-22 02:28:03 -07:00

test_merge.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_meta_index.py

Add attribute validation to prevent silent failures in SWIG wrappers (#4583)

2025-09-19 15:12:21 -07:00

test_mmap.cpp

Enable dynamic dispatch build on Windows (#5127)

2026-04-23 13:31:11 -07:00

test_nndescent.cpp

Fix correctness bugs in NNDescent Nhood copy/move operations and gen_random bounds (#5072)

2026-04-09 20:12:31 -07:00

test_NSG_compressed_graph.cpp

avoid runtime checks in VisitedTable (#5234)

2026-05-30 02:02:42 -07:00

test_omp_exception_safety.cpp

Fix OMP exception safety in IndexHNSW search (#5133)

2026-04-24 12:53:56 -07:00

test_omp_threads_py.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_omp_threads.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_ondisk_ivf.cpp

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_pairs_decoding.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_params_override.cpp

Introduce early stop facilities for IVF, attempt 2 (#5160)

2026-05-01 12:23:05 -07:00

test_partition.py

Roll out @for_all_simd_levels to key test files (#5061)

2026-04-08 10:56:41 -07:00

test_partitioning.cpp

Work around GCC 12 miscompilation of AVX2 histogram (#5124)

2026-05-05 00:46:37 -07:00

test_pq_code_distance.cpp

Inline PQ code distance kernels into scanner TUs (#5159)

2026-05-04 07:35:56 -07:00

test_pq_encoding.cpp

Add FastScanCodeScanner dispatch boundary with per-SIMD TUs (#4897)

2026-03-12 02:15:42 -07:00

test_pqfs_unaligned.cpp

Enable dynamic dispatch build on Windows (#5127)

2026-04-23 13:31:11 -07:00

test_product_quantizer.py

Add NoneSIMDLevel context manager for cross-level reference checks (#5158)

2026-05-02 14:30:13 -07:00

test_rabitq_fastscan.py

Stabilize RaBitQ tests on AVX512_SPR by switching to cross-level equivalence (#5277)

2026-06-06 12:58:58 -07:00

test_rabitq.py

Stabilize RaBitQ tests on AVX512_SPR by switching to cross-level equivalence (#5277)

2026-06-06 12:58:58 -07:00

test_RCQ_cropping.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_read_index_deserialize.cpp

Validate bool fields during deserialization (#5279)

2026-06-04 18:16:44 -07:00

test_referenced_objects.py

Fix IDSelector leak via SearchParameters.sel setter (#5208)

2026-05-13 10:45:56 -07:00

test_refine_panorama.py

Fix Panorama segfault (#5200)

2026-05-22 11:36:07 -07:00

test_refine.py

Parameterize existing tests with @for_all_simd_levels (#5134)

2026-04-22 02:28:03 -07:00

test_residual_quantizer.py

Add NoneSIMDLevel context manager for cross-level reference checks (#5158)

2026-05-02 14:30:13 -07:00

test_rowwise_minmax.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_scalar_quantizer_correctness.py

TurboQuant in ScalarQuantizer: full Algorithm 2 (QJL stage) with SIMD and optimizations (#5170)

2026-06-04 07:59:24 -07:00

test_scalar_quantizer.cpp

TurboQuant in ScalarQuantizer: full Algorithm 2 (QJL stage) with SIMD and optimizations (#5170)

2026-06-04 07:59:24 -07:00

test_search_params.py

Introduce early stop facilities for IVF, attempt 2 (#5160)

2026-05-01 12:23:05 -07:00

test_simd_dispatch.py

Fix AVX512_SPR dispatch on AMD: require AVX512_FP16 CPUID (#5281)

2026-06-07 21:00:32 -07:00

test_simd_levels_x86_avx2.cpp

Introduce Dynamic Dispatch infrastructure with SIMDConfig (#4780)

2026-02-09 01:19:35 -08:00

test_simd_levels_x86_avx512.cpp

Introduce Dynamic Dispatch infrastructure with SIMDConfig (#4780)

2026-02-09 01:19:35 -08:00

test_simd_levels.cpp

Introduce RVV (#5156)

2026-05-05 16:54:09 -07:00

test_simd_perf.cpp

Remove flaky test (#5169)

2026-05-01 09:55:55 -07:00

test_simdlib.cpp

Remove bare simdlib type aliases from simdlib_dispatch.h (#5069)

2026-04-09 04:19:54 -07:00

test_single_query_collect_handler.cpp

introduce SingleQueryResultCollectHandler (#4926)

2026-03-18 14:05:55 -07:00

test_sliding_ivf.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_sorting.cpp

Fix race condition, memory management, debug output, and hashtable lookup in sorting.cpp (#5078)

2026-04-10 17:59:30 -07:00

test_standalone_codec.py

Add TurboQuant (CPU) (#5049)

2026-04-24 16:32:53 -07:00

test_super_kmeans_foundations.cpp

Add SuperKMeans: faster k-means via ADSampling+PDX progressive pruning (#5168)

2026-05-07 11:15:29 -07:00

test_super_kmeans.py

Add SuperKMeans: faster k-means via ADSampling+PDX progressive pruning (#5168)

2026-05-07 11:15:29 -07:00

test_svs_metric.cpp

Fix deadly signal in to_svs_metric() for unsupported metrics (#5032)

2026-04-03 15:08:59 -07:00

test_svs_py.py

SVS static vamana support (#5224)

2026-06-01 10:47:38 -07:00

test_svs.cpp

SVS static vamana support (#5224)

2026-06-01 10:47:38 -07:00

test_swig_wrapper.py

Add IVFSQTurboQSearchParameters to __init__.pyi stub (#5304)

2026-06-11 12:56:37 -07:00

test_threaded_index.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_transfer_invlists.cpp

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_util.h

fix: resolve compiler warnings in test files (#4944)

2026-03-20 10:21:55 -07:00

test_utils.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_wheel_smoke_gpu.py

Add faiss-gpu pip wheel packaging (#5131)

2026-05-28 10:46:55 -07:00

test_wheel_smoke.py

Fix flaky test_hnsw smoke test by increasing efSearch (#5222)

2026-05-18 15:44:59 -07:00

test_zerocopy.cpp

Enable dynamic dispatch build on Windows (#5127)

2026-04-23 13:31:11 -07:00

torch_test_contrib.py

PQ with pytorch (#4116)

2025-01-06 09:48:32 -08:00

torch_test_neural_net.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00