Enable Intel ScalableVectorSearch support #4548

dian-lun-lin · 2025-08-23T00:36:36Z

Pull Request resolved: #4450

This pull request introduces support for Intel ScalableVectorSearch, integrating Intel's proprietary LVQ and LeanVec technologies in binary form. The following index types are now supported: IndexSVSVamana, IndexSVSVamanaLVQ, IndexSVSVamanaLeanVec, and IndexSVSFlat. IndexSVSVamana and IndexSVSFlat utilizes SVS open-source float32 implementation.

Key features and enhancements include:

Implemented search, add, and remove_ids
Implemented filter search and range_search
Enabled SVS open-source fp16 and scalar quantization implementation
Enabled factory methods
Enabled save/load
Enabled Python bindings
Enable fallback mechanism that fallbacks to 8-bit scalar quantization if LVQ/LeanVec is used on non-intel hardware CPUs
Added examples in both Python and C++ under the tutorial/ directory
Added FAISS_ENABLE_SVS flag to allows users to optionally enable SVS

TODOs:

Support more indices such as IndexSVSIVF and IndexSVSFlat with LVQ and LeanVec
Documentation

Support LVQ/LeanVec runtime quantization level

Enable SVS LeanVec

Support SVS index factory

Support SVS fallback for non-intel hardware

SVS factory format update

mdouze · 2025-09-08T19:50:22Z

faiss/impl/index_write.cpp

+        // we only know the number of bytes at the very end.
+        // One solution would be to write a footer and read it in index_read(),
+        // but since the file ends anyway after index_write() is done, we just
+        // assume EOF means end of binary SVS blob.


Would it not be a problem if the SVSVamana is embedded into another index, eg. the coarse quantizer of an IndexIVF? In that case, the index does not end in EOF.

That's correct. I found a simple solution that removes the EOF assumption entirely. So this is no longer a concern.

mdouze · 2025-09-08T19:53:38Z

faiss/IndexSVSFlat.cpp

+    FAISS_THROW_IF_NOT(impl);
+    FAISS_THROW_IF_NOT(k > 0);
+
+    auto queries = svs::data::ConstSimpleDataView<float>(x, n, d);


How is the Flat data represented in memory? As a row-first array?
In that case, would it be possible to implement knn_L2sqr and knn_innerproduct with SVS ?

Yes, it would be row-first array. The ConstSimpleDataView is just a wrapper that wraps the x and does not do any copy.

We also plan to support FP16/int_8 Scalar Quantization/LVQ/LeanVec on Flat, which require our own distance computation to work properly.

What would be the intuition to implement knn_L2sqr and knn_innterproduct with SVS? I think only using the impl->search() is a cleaner way to hide those computation details.

mdouze · 2025-09-08T20:08:45Z

faiss/IndexSVSVamana.cpp

+            svs::threads::StaticPartition(n),
+            [&](auto is, auto SVS_UNUSED(tid)) {
+                for (auto i : is) {
+                    labels[i] = ntotal + i;


NIT how useful is it to parallelize this loop?

My intuition was it could be useful if n is very large. Now I'm thinking std::iota should be enough. I'll make the changes.

mdouze · 2025-09-08T20:09:46Z

faiss/IndexSVSVamana.cpp

+        float* distances,
+        idx_t* labels,
+        const SearchParameters* params) const {
+    FAISS_THROW_IF_NOT(impl);


IIUC !impl means that the index is empty, in which case the labels should all be set to -1 and the distances to +inf

Thank you for pointing this out. I'll make the corresponding changes.

mdouze · 2025-09-08T20:11:18Z

faiss/IndexSVSVamana.cpp

+    FAISS_THROW_IF_NOT_MSG(
+            impl, "Cannot serialize: SVS index not initialized.");
+
+    // Write index to temporary files and concatenate the contents


would it be possible to do I/O without temp files?

This requires some larger changes in SVS, which we would like to contribute separately at a later point.

mdouze · 2025-09-08T21:20:44Z

tests/test_svs.py

+
+        # Test round-trip serialization preserves exact type
+        with tempfile.NamedTemporaryFile() as f:
+            faiss.write_index(index, f.name)


mdouze · 2025-09-08T21:21:14Z

faiss/utils/utils.cpp

 #endif

+#ifdef FAISS_ENABLE_SVS
+    options += "SVS ";


mdouze · 2025-09-08T21:22:12Z

tests/test_svs.py

+import tempfile
+import faiss
+
+


if "SVS" not in faiss.get_compile_options().split():
sys.exit()

Added a skip condition similar to other tests.

mdouze · 2025-09-08T21:22:57Z

tutorial/cpp/11-tmp-svscomp.cpp

Sorry, added by mistake.

mdouze · 2025-09-08T21:24:31Z

faiss/CMakeLists.txt


+if(FAISS_ENABLE_SVS)
+  include(FetchContent)
+  set(SVS_URL "https://github.com/intel/ScalableVectorSearch/releases/download/v1.0.0-dev/svs-shared-library-1.0.0-NIGHTLY-20250820.tar.gz")


This is a binary package right? For what platform?

Yes, this binary package is for Linux

to clarify this - how critical is to support all platforms supported by FAISS? as far this is first round of integration - is it ok to focus on linux only?

* Added index factory datatypes: 'FP16', 'SQ8' * Update CPP and Python tests

delete accidentally added file

Add Float16 and Scalalar Quantization INT8 support to IndexSVSVamana

fix(svs-io): Don't rely on EOF when loading SVS indices

chore(test-svs): remove need for temp files

chore(test-svs): skip tests if compiled without SVS

* basic testing idselector & range_search --------- Co-authored-by: Rafik Saliev <[email protected]>

[SVS] Add support for IDSelecttor in IndexSVSVamana::search() and implement IndexSVSVamana::range_search()

Add Intel license/copyright

Revise based on comments and enable clang format

dian-lun-lin and others added 30 commits July 2, 2025 18:02

init SVS uncompressed data support

8fd27d6

Merge branch 'facebookresearch:main' into svs-init

c499b93

initial naive additional of SVS i/o

0bd1fdd

use Tempfilename

6885f30

Add I/O to example

0215940

revise, add LVQ, and python bindings

d4d1226

on going work

48904f3

cleanup after cherry-picking aaron's latest commits

b4c768a

First implementation of IndexSVSFlat

5cf26a9

implement first feedback

11b44f7

Merge remote-tracking branch 'origin/main' into svs-io

9854e82

Fix tests for LVQ4x4

0df0771

add LVQ4x8

014960d

initial set of SVS python tests

09c0db5

fix some tests

969d595

support LVQ/LeanVec runtime quantization level

9e3c48e

Merge pull request #2 from ahuber21/svs-lvq-leanvec-run-params

a585e9d

Support LVQ/LeanVec runtime quantization level

Fix LVQ in test_svs.cpp

7eb6289

clang-format

6dbb96f

fix impl cleanup in destructor

90b15b6

continue work on C++ & py tests

38b7eea

enable SVS LeanVec

4f36df5

Merge pull request #3 from ahuber21/svs-leanvec

713cc36

Enable SVS LeanVec

I/O support for LeanVec

8f16863

support SVS index factory

034320b

enable clang format

c7c3577

Merge pull request #4 from ahuber21/svs-factory

9ff7b53

Support SVS index factory

streaming write to disk

b2b9819

change how files are streamed

d31bcb1

Update SVS version

483193a

ahuber21 and others added 3 commits September 4, 2025 20:21

Merge pull request #9 from ahuber21/svs-fallback

b634f6a

Support SVS fallback for non-intel hardware

svs factory format update

da72c1a

Merge pull request #10 from ahuber21/svs-factory-format-update

fd52aa1

SVS factory format update

mdouze reviewed Sep 8, 2025

View reviewed changes

rfsaliev and others added 26 commits September 9, 2025 15:08

Add Float16 and SQ I8 support to IndexSVSVamana class

26023b0

* Added index factory datatypes: 'FP16', 'SQ8' * Update CPP and Python tests

delete accidentally added file

741d0ed

Merge pull request #13 from ahuber21/chore/rm-file

4da3db8

delete accidentally added file

Merge pull request #12 from ahuber21/rfsaliev/fp16-sq

53bd413

Add Float16 and Scalalar Quantization INT8 support to IndexSVSVamana

fix(svs-io): Don't rely on EOF when loading SVS indices

7a7931c

Merge pull request #21 from ahuber21/dev/ahuber/improve-io

9e05e00

fix(svs-io): Don't rely on EOF when loading SVS indices

chore(test-svs): remove need for temp files

d7009fc

chore(test-svs): remove need for temp files

d5ccad6

chore(test-svs): remove need for temp files

chore(test-svs): skip tests if compiled without SVS

8cb7a7e

Merge pull request #23 from ahuber21/dev/ahuber/skip-svs-if-not-compiled

40dc90d

chore(test-svs): skip tests if compiled without SVS

[SVS] Add support for IDSelecttor and range_search()

c45d09a

Fix distance comparison in

278e9ba

Define SearchParametersSVSVamana

734e5f3

Add python tests

baa42c9

Fix iterator batch size in range_search()

38fe2ea

Parallelize batch iterators

dce50d9

Code review fixes and range search refactoring

c74b659

Code review s1e2

21f8bf4

basic testing idselector & range_search (#24)

2a8bac7

* basic testing idselector & range_search --------- Co-authored-by: Rafik Saliev <[email protected]>

Fix-update CPP SVS tests

421e582

Merge pull request #17 from ahuber21/rfsaliev/filered-search

009e135

[SVS] Add support for IDSelecttor in IndexSVSVamana::search() and implement IndexSVSVamana::range_search()

Merge branch 'facebookresearch:main' into svs-io

1fcbc1e

update intel license/copyright

a9e5235

Merge pull request #27 from ahuber21/svs-license-copyright

d7b276f

Add Intel license/copyright

revise based on comments and enable clang format

972818c

Merge pull request #28 from ahuber21/svs-revise

ba0e52a

Revise based on comments and enable clang format

		import tempfile
		import faiss

Enable Intel ScalableVectorSearch support #4548

Are you sure you want to change the base?

Enable Intel ScalableVectorSearch support #4548

Uh oh!

Conversation

dian-lun-lin commented Aug 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dian-lun-lin commented Aug 23, 2025 •

edited

Loading