Skip to content

Commit 3fdc228

Browse files
committed
DOC-5799: search: document procedure for building with Intel binaries
1 parent 36e5487 commit 3fdc228

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

content/develop/ai/search-and-query/vectors/svs-compression.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,3 +102,27 @@ The strong performance of LVQ and LeanVec stems from their ability to adapt to t
102102
A minimum number of representative vectors is required during index initialization to train the compression parameters (see the [TRAINING_THRESHOLD]({{< relref "/develop/ai/search-and-query/vectors/#svs-vamana-index" >}}) parameter). A random sample from the dataset typically works well.
103103
* **Handling data drift:**
104104
If the characteristics of incoming vectors change significantly over time (that is, a data distribution shift), compression quality may degrade. This is a general limitation of all data-dependent compression methods,not just LVQ and LeanVec. When the data no longer resembles the original training sample, the learned representation becomes less effective.
105+
106+
## Build Redis Open Source with Intel SVS support
107+
108+
By default, Redis Open Source with the Redis Query Engine supports SVS-VAMANA indexing with the global 8-bit quantisation. To compile Redis with the Intel SVS-VAMANA optimisations, LeanVec and LVQ, for Intel platforms, follow the instructions below.
109+
110+
{{ warning }}
111+
If you are using Redis Open Source under the AGPLv3 or SSPLv1 licenses, you cannot use it together with the Intel Optimization binaries (LeanVec and LVQ). The reason is that the Intel SVS license is not compatible with those licenses.
112+
The LeanVec and LVQ techniques are closed source and are only available for use with Redis Open Source when distributed under the RSALv2 license.
113+
For more details, please refer to the [information provided by Intel](https://github.com/intel/ScalableVectorSearch).
114+
{{ /warning }}
115+
116+
### Build Redis Open Source
117+
118+
Follow the [Redis Open Source build instructions]({{< relref "/operate/oss_and_stack/install/build-stack" >}}). Before executing `make`, define the following environment variable.
119+
120+
```sh
121+
export BUILD_INTEL_SVS_OPT=yes
122+
```
123+
124+
Alternatively, you can define the `BUILD_INTEL_SVS_OPT` variable as part of the `make` command:
125+
126+
```sh
127+
make BUILD_INTEL_SVS_OPT=yes
128+
```

0 commit comments

Comments
 (0)