Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Building faiss static and cpu-only for the ann-benchmarks #1820

Closed
wants to merge 1 commit into from
Closed

Building faiss static and cpu-only for the ann-benchmarks #1820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 51 additions & 19 deletions cpp/bench/ann/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@
# ##################################################################################################
# * benchmark options ------------------------------------------------------------------------------

option(RAFT_ANN_BENCH_USE_FAISS_BFKNN "Include faiss' brute-force knn algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_IVF_FLAT "Include faiss' ivf flat algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_IVF_PQ "Include faiss' ivf pq algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_GPU_BFKNN "Include faiss' GPU brute-force knn algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_FLAT "Include faiss' GPU ivf flat algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_PQ "Include faiss' GPU ivf pq algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_CPU_BFKNN "Include faiss' CPU brute-force knn algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_CPU_IVF_FLAT "Include faiss' CPU ivf flat algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_FAISS_CPU_IVF_PQ "Include faiss' CPU ivf pq algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_RAFT_IVF_FLAT "Include raft's ivf flat algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_RAFT_IVF_PQ "Include raft's ivf pq algorithm in benchmark" ON)
option(RAFT_ANN_BENCH_USE_RAFT_CAGRA "Include raft's CAGRA in benchmark" ON)
Expand All @@ -33,9 +36,9 @@ option(RAFT_ANN_BENCH_SINGLE_EXE
find_package(Threads REQUIRED)

if(BUILD_CPU_ONLY)
set(RAFT_ANN_BENCH_USE_FAISS_BFKNN OFF)
set(RAFT_ANN_BENCH_USE_FAISS_IVF_FLAT OFF)
set(RAFT_ANN_BENCH_USE_FAISS_IVF_PQ OFF)
set(RAFT_ANN_BENCH_USE_FAISS_GPU_BFKNN OFF)
set(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_FLAT OFF)
set(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_PQ OFF)
set(RAFT_ANN_BENCH_USE_RAFT_IVF_FLAT OFF)
set(RAFT_ANN_BENCH_USE_RAFT_IVF_PQ OFF)
set(RAFT_ANN_BENCH_USE_RAFT_CAGRA OFF)
Expand All @@ -44,16 +47,19 @@ else()
# Disable faiss benchmarks on CUDA 12 since faiss is not yet CUDA 12-enabled.
# https://github.com/rapidsai/raft/issues/1627
if(${CMAKE_CUDA_COMPILER_VERSION} VERSION_GREATER_EQUAL 12.0.0)
set(RAFT_ANN_BENCH_USE_FAISS_BFKNN OFF)
set(RAFT_ANN_BENCH_USE_FAISS_IVF_FLAT OFF)
set(RAFT_ANN_BENCH_USE_FAISS_IVF_PQ OFF)
set(RAFT_ANN_BENCH_USE_FAISS_GPU_BFKNN OFF)
set(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_FLAT OFF)
set(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_PQ OFF)
endif()
endif()

set(RAFT_ANN_BENCH_USE_FAISS OFF)
if(RAFT_ANN_BENCH_USE_FAISS_BFKNN
OR RAFT_ANN_BENCH_USE_FAISS_IVFPQ
OR RAFT_ANN_BENCH_USE_FAISS_IFFLAT
if(RAFT_ANN_BENCH_USE_FAISS_GPU_BFKNN
OR RAFT_ANN_BENCH_USE_FAISS_GPU_IVFPQ
OR RAFT_ANN_BENCH_USE_FAISS_GPU_IFFLAT
OR RAFT_ANN_BENCH_USE_FAISS_CPU_BFKNN
OR RAFT_ANN_BENCH_USE_FAISS_CPU_IVFPQ
OR RAFT_ANN_BENCH_USE_FAISS_CPU_IFFLAT
)
set(RAFT_ANN_BENCH_USE_FAISS ON)
endif()
Expand Down Expand Up @@ -88,10 +94,11 @@ endif()

function(ConfigureAnnBench)

set(options OPTIONAL BUILD_CPU_ONLY)
set(oneValueArgs NAME)
set(multiValueArgs PATH LINKS CXXFLAGS INCLUDES)

if(NOT BUILD_CPU_ONLY)
if(NOT BUILD_CPU_ONLY AND NOT ConfigureAnnBench_BUILD_CPU_ONLY)
set(GPU_BUILD ON)
endif()

Expand Down Expand Up @@ -151,6 +158,7 @@ function(ConfigureAnnBench)
${BENCH_NAME}
PUBLIC
RAFT_ANN_BENCH_USE_${ConfigureAnnBench_NAME}=RAFT_ANN_BENCH_USE_${ConfigureAnnBench_NAME}
$<$<BOOL:${ConfigureAnnBench_BUILD_CPU_ONLY}>:BUILD_CPU_ONLY>
)
endif()

Expand All @@ -174,6 +182,7 @@ if(RAFT_ANN_BENCH_USE_HNSWLIB)
ConfigureAnnBench(
NAME HNSWLIB PATH bench/ann/src/hnswlib/hnswlib_benchmark.cpp INCLUDES
${CMAKE_CURRENT_BINARY_DIR}/_deps/hnswlib-src/hnswlib CXXFLAGS "${HNSW_CXX_FLAGS}"
OPTIONAL BUILD_CPU_ONLY
)
endif()

Expand Down Expand Up @@ -213,20 +222,43 @@ if(RAFT_ANN_BENCH_USE_RAFT_CAGRA)
)
endif()

if(RAFT_ANN_BENCH_USE_FAISS_IVF_FLAT)
if(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_FLAT)
ConfigureAnnBench(
NAME FAISS_IVF_FLAT PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss
NAME FAISS_GPU_IVF_FLAT PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss
)
endif()

if(RAFT_ANN_BENCH_USE_FAISS_IVF_PQ)
if(RAFT_ANN_BENCH_USE_FAISS_GPU_IVF_PQ)
ConfigureAnnBench(
NAME FAISS_IVF_PQ PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss
NAME FAISS_GPU_IVF_PQ PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss
)
endif()

if(RAFT_ANN_BENCH_USE_FAISS_BFKNN)
ConfigureAnnBench(NAME FAISS_BFKNN PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss)
if(RAFT_ANN_BENCH_USE_FAISS_GPU_BFKNN)
ConfigureAnnBench(
NAME FAISS_GPU_BFKNN PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss
)
endif()

if(RAFT_ANN_BENCH_USE_FAISS_CPU_IVF_FLAT)
ConfigureAnnBench(
NAME FAISS_CPU_IVF_FLAT PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss_cpu
OPTIONAL BUILD_CPU_ONLY
)
endif()

if(RAFT_ANN_BENCH_USE_FAISS_CPU_IVF_PQ)
ConfigureAnnBench(
NAME FAISS_CPU_IVF_PQ PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss_cpu
OPTIONAL BUILD_CPU_ONLY
)
endif()

if(RAFT_ANN_BENCH_USE_FAISS_CPU_BFKNN)
ConfigureAnnBench(
NAME FAISS_CPU_BFKNN PATH bench/ann/src/faiss/faiss_benchmark.cu LINKS faiss::faiss_cpu
OPTIONAL BUILD_CPU_ONLY
)
endif()

if(RAFT_ANN_BENCH_USE_GGNN)
Expand Down
24 changes: 23 additions & 1 deletion cpp/cmake/thirdparty/get_faiss.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,28 @@ function(find_and_configure_faiss)
NAMESPACE faiss::)
endif()

# Build a second copy of FAISS without GPU support.
# Also make it static for simplicity - without GPU libs it does not take much space
ExternalProject_Add(faiss_cpu_external
PREFIX ${faiss_SOURCE_DIR}
BINARY_DIR ${faiss_BINARY_DIR}/cpu_only
BUILD_IN_SOURCE FALSE
DOWNLOAD_COMMAND ""
CONFIGURE_COMMAND cmake -S ${faiss_SOURCE_DIR} -B ${faiss_BINARY_DIR}/cpu_only -DFAISS_ENABLE_PYTHON=OFF -DFAISS_ENABLE_GPU=OFF -DBUILD_TESTING=OFF -DCMAKE_MESSAGE_LOG_LEVEL=VERBOSE -DBUILD_SHARED_LIBS=OFF
BUILD_COMMAND cmake --build "${faiss_BINARY_DIR}/cpu_only" -j --target faiss
INSTALL_COMMAND ""
TEST_COMMAND ""
BUILD_BYPRODUCTS ${faiss_BINARY_DIR}/cpu_only/faiss/libfaiss.a
)
add_library(faiss_cpu STATIC IMPORTED)
set_property(TARGET faiss_cpu PROPERTY IMPORTED_LOCATION ${faiss_BINARY_DIR}/cpu_only/faiss/libfaiss.a)
get_target_property(FAISS_INCLUDE_DIRECTORIES faiss INCLUDE_DIRECTORIES)
target_include_directories(faiss_cpu INTERFACE ${FAISS_INCLUDE_DIRECTORIES})
add_dependencies(faiss_cpu faiss_cpu_external)
if(TARGET faiss_cpu AND NOT TARGET faiss::faiss_cpu)
add_library(faiss::faiss_cpu ALIAS faiss_cpu)
endif()

# We generate the faiss-config files when we built faiss locally, so always do `find_dependency`
rapids_export_package(BUILD OpenMP raft-ann-bench-exports) # faiss uses openMP but doesn't export a need for it
rapids_export_package(BUILD faiss raft-ann-bench-exports GLOBAL_TARGETS faiss::faiss faiss)
Expand Down Expand Up @@ -84,4 +106,4 @@ find_and_configure_faiss(VERSION 1.7.0
REPOSITORY ${RAFT_FAISS_GIT_REPOSITORY}
PINNED_TAG ${RAFT_FAISS_GIT_TAG}
BUILD_STATIC_LIBS ${RAFT_USE_FAISS_STATIC}
EXCLUDE_FROM_ALL ${RAFT_EXCLUDE_FAISS_FROM_ALL})
EXCLUDE_FROM_ALL ${RAFT_EXCLUDE_FAISS_FROM_ALL})