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

Fix inconsistency between the building doc and CMakeLists.txt #1248

Merged
merged 3 commits into from
Feb 16, 2023
Merged

Fix inconsistency between the building doc and CMakeLists.txt #1248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8920ac9
Fix inconsistency between the building doc and CMakeLists.txt
yong-wang Feb 6, 2023
8b68942
refine the default of RAFT_COMPILE_LIBRARIES
yong-wang Feb 11, 2023
6143dce
Merge branch 'branch-23.04' into imp-doc-and-cmakelists
vyasr Feb 16, 2023
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
8 changes: 6 additions & 2 deletions cpp/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,11 @@ option(DISABLE_DEPRECATION_WARNINGS "Disable deprecaction warnings " ON)
option(DISABLE_OPENMP "Disable OpenMP" OFF)
option(RAFT_NVTX "Enable nvtx markers" OFF)

option(RAFT_COMPILE_LIBRARIES "Enable building raft shared library instantiations" ${BUILD_TESTS})
set(RAFT_COMPILE_LIBRARIES_DEFAULT OFF)
if(BUILD_TESTS OR BUILD_BENCH)
set(RAFT_COMPILE_LIBRARIES_DEFAULT ON)
endif()
option(RAFT_COMPILE_LIBRARIES "Enable building raft shared library instantiations" ${RAFT_COMPILE_LIBRARIES_DEFAULT})
option(
RAFT_COMPILE_NN_LIBRARY "Enable building raft nearest neighbors shared library instantiations"
${RAFT_COMPILE_LIBRARIES}
Expand All @@ -66,7 +70,7 @@ option(RAFT_COMPILE_DIST_LIBRARY "Enable building raft distant shared library in
${RAFT_COMPILE_LIBRARIES}
)
option(RAFT_ENABLE_NN_DEPENDENCIES "Search for raft::nn dependencies like faiss"
${RAFT_COMPILE_LIBRARIES}
${RAFT_COMPILE_NN_LIBRARY}
)

option(RAFT_ENABLE_thrust_DEPENDENCY "Enable Thrust dependency" ON)
Expand Down
9 changes: 4 additions & 5 deletions docs/source/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,16 +162,15 @@ RAFT's cmake has the following configurable flags available:.
| Flag | Possible Values | Default Value | Behavior |
| --- | --- | --- | --- |
| BUILD_TESTS | ON, OFF | ON | Compile Googletests |
| BUILD_BENCH | ON, OFF | ON | Compile benchmarks |
| BUILD_BENCH | ON, OFF | OFF | Compile benchmarks |
| raft_FIND_COMPONENTS | nn distance | | Configures the optional components as a space-separated list |
| RAFT_COMPILE_LIBRARIES | ON, OFF | OFF | Compiles all `libraft` shared libraries (these are required for Googletests) |
| RAFT_COMPILE_LIBRARIES | ON, OFF | ON if either BUILD_TESTS or BUILD_BENCH is ON; otherwise OFF | Compiles all `libraft` shared libraries (these are required for Googletests) |
| RAFT_COMPILE_NN_LIBRARY | ON, OFF | OFF | Compiles the `libraft-nn` shared library |
| RAFT_COMPILE_DIST_LIBRARY | ON, OFF | OFF | Compiles the `libraft-distance` shared library |
| RAFT_ENABLE_NN_DEPENDENCIES | ON, OFF | OFF | Searches for dependencies of nearest neighbors API, such as FAISS, and compiles them if not found. Needed for `raft::spatial::knn` |
| RAFT_USE_FAISS_STATIC | ON, OFF | OFF | Statically link FAISS into `libraft-nn` |
| RAFT_STATIC_LINK_LIBRARIES | ON, OFF | ON | Build static link libraries instead of shared libraries |
| DETECT_CONDA_ENV | ON, OFF | ON | Enable detection of conda environment for dependencies |
| NVTX | ON, OFF | OFF | Enable NVTX Markers |
| RAFT_NVTX | ON, OFF | OFF | Enable NVTX Markers |
| CUDA_ENABLE_KERNELINFO | ON, OFF | OFF | Enables `kernelinfo` in nvcc. This is useful for `compute-sanitizer` |
| CUDA_ENABLE_LINEINFO | ON, OFF | OFF | Enable the -lineinfo option for nvcc |
| CUDA_STATIC_RUNTIME | ON, OFF | OFF | Statically link the CUDA runtime |
Expand Down Expand Up @@ -388,4 +387,4 @@ Once built and installed, RAFT can be safely uninstalled using `build.sh` by spe
Leaving off the installed components will uninstall everything that's been installed:
```bash
./build.sh --uninstall
```
```