WIP: [DO NOT MERGE] introduce libcuvs wheels #594

jameslamb · 2025-01-21T05:04:45Z

Contributes to rapidsai/build-planning#33.

Proposes packaging libcuvs as a wheel, which is then re-used by cuvs-cu{11,12}.

Similar changes were recently made in RAFT: rapidsai/raft#2531

As part of this, also proposes:

introducing a new CMake option, CUVS_COMPILE_DYNAMIC_ONLY, to allow building/installing only the dynamic shared library (i.e. skipping the static library)
enforcing rapids-cmake's preferred CMake style (similar introduce libraft wheels raft#2531 (comment))

Notes for Reviewers

if you see this note, this is not yet ready for review

Benefits of these changes

smaller wheels (see "Size Changes" below)
fewer CI resources used for cuVS wheels (no more re-compiling for every Python minor version)
faster, cheaper cuML wheel builds (WIP: [DO NOT MERGE] introduce libcuml wheels cuml#6199 (comment))
other benefits mentioned in Support dynamic linking between RAPIDS wheels build-planning#33

Wheel contents

libcuvs:

libcuvs.so and libcuvs_c.so (shared library)
cuVS headers
vendored dependencies (hnswlib)

cuvs:

cuvs Python / Cython code and compiled Cython extensions

Size changes (CUDA 12, Python 3.12, x86_64)

| wheel | num files (before) | num files (this PR) | size (before) | size (this PR) |
|:------------- -:|------------------:|-----------------:|--------------:|-------------:|
| libcuvs | --- | --- | --- | --- |
| cuvs | --- | --- | --- | --- |
|TOTAL | --- | --- | --- | --- |

How I tested this

copy-pr-bot · 2025-01-21T05:04:49Z

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

jameslamb · 2025-01-21T16:11:38Z

/ok to test

jameslamb · 2025-01-21T20:14:44Z

/ok to test

bdice · 2025-01-21T22:37:47Z

.github/workflows/build.yaml

+      branch: ${{ inputs.branch }}
+      sha: ${{ inputs.sha }}
+      date: ${{ inputs.date }}
+      package-name: cuvs


Suggested change

package-name: cuvs

package-name: libcuvs

bdice · 2025-01-21T22:40:13Z

ci/check_style.sh

@@ -14,5 +14,12 @@ rapids-dependency-file-generator \
 rapids-mamba-retry env create --yes -f env.yaml -n checks
 conda activate checks

+# get config for cmake-format checks


The diff from this change doesn't appear to be too large, so I am okay with including it in this PR.

bdice · 2025-01-21T22:40:37Z

ci/release/update-version.sh

@@ -44,8 +44,9 @@ echo "${NEXT_FULL_TAG}" > VERSION
 DEPENDENCIES=(
  dask-cuda
  cuvs
-  pylibraft
+  libraft


Suggested change

libraft

libcuvs

libraft

bdice · 2025-01-21T22:53:10Z

python/libcuvs/pyproject.toml

+[project.entry-points."cmake.prefix"]
+libcuvs = "libcuvs"
+
+[tool.isort]


Do we need all the isort settings here?

I think yes. It could probably be reduced (I'll do that) but at least the formatting options I think should stay.

Given that this project seems to:

not set any defaults for isort in its pyproject.toml

prefer to have sub-directory-specific configuration for isort

cuvs/.pre-commit-config.yaml

Lines 8 to 10 in f1de1b2

# Use the config file specific to each subproject so that each

# project can specify its own first/third-party packages.

args: ["--config-root=python/", "--resolve-all-configs"]

jameslamb · 2025-01-21T23:04:30Z

python/libcuvs/CMakeLists.txt

+endif()
+
+# --- RAFT ---#
+set(CUVS_USE_RAFT_STATIC OFF)


One of the wheel-test jobs (CUDA 11.8, arm64) is failing, with a few cases like this:

FAILED python/cuvs/cuvs/test/test_ivf_pq.py::test_ivf_pq_search_params[params2] - cuvs.common.exceptions.CuvsException: cuBLAS error encountered at: file=/pyenv/versions/3.10.16/lib/python3.10/site-packages/libraft/include/raft/linalg/detail/cublaslt_wrappers.hpp line=261: call='cublasLtMatmul(resource::get_cublaslt_handle(res), mm_desc->desc, alpha, a_ptr, mm_desc->a, b_ptr, mm_desc->b, beta, c_ptr, mm_desc->c, c_ptr, mm_desc->c, &(mm_desc->heuristics.algo), nullptr, 0, stream)', Reason=13:CUBLAS_STATUS_EXECUTION_FAILED Obtained 49 stack frames #1 in /pyenv/versions/3.12.8/lib/python3.12/site-packages/libcuvs/lib64/libcuvs.so: raft::cublas_error::cublas_error(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) +0xb0 [0xfffdca6a5360] #2 in /pyenv/versions/3.12.8/lib/python3.12/site-packages/libcuvs/lib64/libcuvs.so: void raft::linalg::detail::legacy_matmul<false, float, float, float, float>(raft::resources const&, bool, bool, unsigned long, unsigned long, unsigned long, float const*, float const*, unsigned long, float const*, unsigned long, float const*, float*, unsigned long, CUstream_st*) +0x6c0 [0xfffdca6c4900]

(build link)

All the failures are in one set of test cases:

FAILED python/cuvs/cuvs/test/test_ivf_pq.py

I don't think those are related to this PR... I see them on other PRs like #593 (which only remove whitespace):
https://github.com/rapidsai/cuvs/actions/runs/12875298461/job/35896833763?pr=593

jameslamb · 2025-01-21T23:23:46Z

build.sh

-SKBUILD_EXTRA_CMAKE_ARGS="${EXTRA_CMAKE_ARGS}"
-if [[ "${EXTRA_CMAKE_ARGS}" != *"DFIND_CUVS_CPP"* ]]; then
-    SKBUILD_EXTRA_CMAKE_ARGS="${SKBUILD_EXTRA_CMAKE_ARGS};-DFIND_CUVS_CPP=ON"
-fi


Just picking a mostly-arbitrary place on the diff to start this thread... the rust build is failing here.

warning: argument unused during compilation: '-L/opt/conda/envs/rust/targets/x86_64-linux/lib' [-Wunused-command-line-argument] warning: argument unused during compilation: '-L/opt/conda/envs/rust/targets/x86_64-linux/lib/stubs' [-Wunused-command-line-argument] /usr/include/limits.h:124:16: fatal error: 'limits.h' file not found clang diag: warning: argument unused during compilation: '-L/opt/conda/envs/rust/targets/x86_64-linux/lib' [-Wunused-command-line-argument] clang diag: warning: argument unused during compilation: '-L/opt/conda/envs/rust/targets/x86_64-linux/lib/stubs' [-Wunused-command-line-argument] thread 'main' panicked at cuvs-sys/build.rs:97:10: Unable to generate cagra_c bindings: ClangDiagnostic("/usr/include/limits.h:124:16: fatal error: 'limits.h' file not found\n")

(build link)

I strongly suspect it's related to this PR, because I've seen it on multiple runs and because that build is succeeding on branch builds and other PRs. For example, it just passed 6 minutes ago on #596: https://github.com/rapidsai/cuvs/actions/runs/12895689316/job/35960708413?pr=596

jameslamb added 3 commits January 20, 2025 18:47

introduce libcuvs wheels

fbe777d

enforce cmake-format checks

941c711

more changes

1a07f09

jameslamb added improvement Improves an existing functionality non-breaking Introduces a non-breaking change DO NOT MERGE labels Jan 21, 2025

github-actions bot added ci cpp CMake Python labels Jan 21, 2025

jameslamb added 3 commits January 20, 2025 21:35

stop building and installing static library

0f7c7d8

more build deps

591bcff

fix copy-paste error

0bc1f0a

jameslamb added 2 commits January 21, 2025 12:14

fix RPATHs and sizes

7e04e6d

Merge branch 'branch-25.02' into libcuvs-wheels

270081e

jameslamb mentioned this pull request Jan 21, 2025

WIP: add libcuvs Python builds rapidsai/devcontainers#440

Draft

bdice reviewed Jan 21, 2025

View reviewed changes

jameslamb commented Jan 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: [DO NOT MERGE] introduce libcuvs wheels #594

WIP: [DO NOT MERGE] introduce libcuvs wheels #594

jameslamb commented Jan 21, 2025 •

edited

Loading

copy-pr-bot bot commented Jan 21, 2025

jameslamb commented Jan 21, 2025

jameslamb commented Jan 21, 2025

bdice Jan 21, 2025

bdice Jan 21, 2025

bdice Jan 21, 2025

bdice Jan 21, 2025

jameslamb Jan 21, 2025

jameslamb Jan 21, 2025

jameslamb Jan 21, 2025

	# Use the config file specific to each subproject so that each
	# project can specify its own first/third-party packages.
	args: ["--config-root=python/", "--resolve-all-configs"]

WIP: [DO NOT MERGE] introduce libcuvs wheels #594

Are you sure you want to change the base?

WIP: [DO NOT MERGE] introduce libcuvs wheels #594

Conversation

jameslamb commented Jan 21, 2025 • edited Loading

Notes for Reviewers

Benefits of these changes

Wheel contents

Size changes (CUDA 12, Python 3.12, x86_64)

How I tested this

copy-pr-bot bot commented Jan 21, 2025

jameslamb commented Jan 21, 2025

jameslamb commented Jan 21, 2025

bdice Jan 21, 2025

Choose a reason for hiding this comment

bdice Jan 21, 2025

Choose a reason for hiding this comment

bdice Jan 21, 2025

Choose a reason for hiding this comment

bdice Jan 21, 2025

Choose a reason for hiding this comment

jameslamb Jan 21, 2025

Choose a reason for hiding this comment

jameslamb Jan 21, 2025

Choose a reason for hiding this comment

jameslamb Jan 21, 2025

Choose a reason for hiding this comment

jameslamb commented Jan 21, 2025 •

edited

Loading