Update INSTALL.md #1456
Update INSTALL.md #1456
Conversation
Added doc + placeholders on how to compile demos and tests with cmake
INSTALL.md
Outdated
| @@ -310,6 +304,8 @@ libfaiss.so (or libfaiss.dylib) | |||
| the executable should be linked to one of these. If you use | |||
| the static version (.a), add the LDFLAGS used in the Makefile. | |||
|
|
|||
| ** is this up-to-date? Does cmake generate dynamic libs? ** | |||
There was a problem hiding this comment.
CMake generate shared libs iff the -DBUILD_SHARED_LIBS=ON option is passed to the cmake invocation.
| which you can build by calling | ||
| `make demo_ivfpq_indexing` | ||
| which you can build by calling |
There was a problem hiding this comment.
Looks like the command disappeared.
There was a problem hiding this comment.
build: $ make -C build demo_ivfpq_indexing
run: $ ./build/demo_ivfpq_indexing
| which you can build by calling | ||
| `make demo_ivfpq_indexing` | ||
| which you can build by calling |
There was a problem hiding this comment.
build: $ make -C build demo_ivfpq_indexing
run: $ ./build/demo_ivfpq_indexing
INSTALL.md
Outdated
|
|
||
| It makes a small index, stores it and performs some searches. A normal | ||
| runtime is around 20s. With a fast machine and Intel MKL's BLAS it | ||
| runs in 2.5s. | ||
|
|
||
| To run the whole test suite: | ||
|
|
||
| `make test` (for the CPU part) | ||
| ** how to run the C++ tests ** |
There was a problem hiding this comment.
Does not work
(faiss_latest_cmake) matthijs@devfair0144:~/faiss_versions/faiss_latest_cmake$ make -C build test
make: Entering directory '/private/home/matthijs/faiss_versions/faiss_latest_cmake/build'
make: *** No rule to make target 'test'. Stop.
make: Leaving directory '/private/home/matthijs/faiss_versions/faiss_latest_cmake/build'
(faiss_latest_cmake) matthijs@devfair0144:~/faiss_versions/faiss_latest_cmake$ make -C build tests
make: Entering directory '/private/home/matthijs/faiss_versions/faiss_latest_cmake/build'
make: *** No rule to make target 'tests'. Stop.
make: Leaving directory '/private/home/matthijs/faiss_versions/faiss_latest_cmake/build'
There was a problem hiding this comment.
In order to build the tests, they need to be enabled via -DBUILD_TESTING=ON. The option should be ON by default, but it is currently not, I'll send a fix.
INSTALL.md
Outdated
| make demos | ||
| ./demos/demo_sift1M | ||
| ``` | ||
| ** how to compile demo_sift1M ** |
There was a problem hiding this comment.
$ make -C build demo_sift1M
There was a problem hiding this comment.
Does not work due to MKL linking
https://gist.github.com/mdouze/975b681c1a45f03664851d646a6f4243
There was a problem hiding this comment.
$ cmake -B build -DBLA_VENDOR=Intel10_64_dyn -DFAISS_ENABLE_GPU=OFF .
$ make -C build -j demo_sift1M
works fine for me. There may be an issue with your MKL installation?
| SWIG generates two wrapper files: a Python file `swigfaiss.py` and a | ||
| C++ file that must be compiled to a dynamic library (`_swigfaiss.so`). | ||
| There is an AVX2 variant of the files, suffixed with `_avx2`. |
There was a problem hiding this comment.
This part is not really relevant to installing, and is probably more confusing than helpful to new users.
There was a problem hiding this comment.
Will move it to the packaging section.
INSTALL.md
Outdated
|
|
||
| Testing the GPU implementation | ||
| ------------------------------ | ||
|
|
||
| Compile the example with | ||
|
|
||
| ** update ** |
There was a problem hiding this comment.
$ make -C build demo_ivfpq_indexing_gpu
INSTALL.md
Outdated
| ** update ** | ||
| ``` | ||
| export PYTHONPATH=. | ||
| python demos/demo_auto_tune.py |
There was a problem hiding this comment.
At the moment, running the python tests involves the following:
$ make -C build swigfaiss
$ (cd build/faiss/python && setup.py build)
$ PYTHONPATH=./build/faiss/python/build/lib python -m unittest discover ./tests
There was a problem hiding this comment.
@mdouze has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
Added doc + placeholders on how to compile demos and tests with cmake