Skip to content

Commit fba30d4

Browse files
lranon1aalekhpatel07
authored andcommitted
Update INSTALL.md to ensure AVX2 and AV512 support for python package (facebookresearch#3892)
Summary: Following the current documentation creates the python package without AVX2 or AV512 support. Updated documentation notes that corresponding faiss version must be built before swigfaiss. fixes facebookresearch#3883 Pull Request resolved: facebookresearch#3892 Reviewed By: mengdilin Differential Revision: D63641111 Pulled By: asadoughi fbshipit-source-id: 2f0598ead8cc5b82ed34841c185e6d2a1d068ba5
1 parent f11b164 commit fba30d4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

INSTALL.md

+17
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,22 @@ The `-j` option enables parallel compilation of multiple units, leading to a
167167
faster build, but increasing the chances of running out of memory, in which case
168168
it is recommended to set the `-j` option to a fixed value (such as `-j4`).
169169

170+
If making use of optimization options, build the correct target before swigfaiss.
171+
172+
For AVX2:
173+
174+
``` shell
175+
$ make -C build -j faiss_avx2
176+
```
177+
178+
For AVX512:
179+
180+
``` shell
181+
$ make -C build -j faiss_avx512
182+
```
183+
184+
This will ensure the creation of neccesary files when building and installing the python package.
185+
170186
## Step 3: Building the python bindings (optional)
171187

172188
``` shell
@@ -177,6 +193,7 @@ $ (cd build/faiss/python && python setup.py install)
177193
The first command builds the python bindings for Faiss, while the second one
178194
generates and installs the python package.
179195

196+
180197
## Step 4: Installing the C++ library and headers (optional)
181198

182199
``` shell

0 commit comments

Comments
 (0)