Distribute libcuspatial wheels (#1450)

Contributes to rapidsai/build-planning#33 Adds `libcuspatial` wheels, and switches `cuspatial` wheels to using them. ## Notes for Reviewers ### Benefits of these changes Faster CI runs and smaller total footprint on package repositories (because now `libcuspatial` no longer needs to be compiled once per Python version). Smaller `cuspatial` wheels. | whee. l | size (before) | size (this PR) | |:-------------:|-------------:|----------------:| | `libcuspatial` | --- | 17.0M | | `cuspatial`. | 21.0M | 4.1M | | `cuproj ` | 0.9M | 0.9M | |**TOTAL** | **21.9M** | **22.0M** | *NOTES: size = compressed, "before" = 2024-09-02 nightlies (1544e7b), CUDA = 12, Python = 3.11* <details><summary>how I calculated those (click me)</summary> ```shell docker run \ --rm \ -v $(pwd):/opt/work:ro \ -w /opt/work \ --network host \ --env RAPIDS_NIGHTLY_DATE=2024-09-02 \ --env RAPIDS_NIGHTLY_SHA=1544e7b \ --env RAPIDS_PR_NUMBER=1450 \ --env RAPIDS_PY_CUDA_SUFFIX=cu12 \ --env RAPIDS_REPOSITORY=rapidsai/cuspatial \ --env WHEEL_DIR_BEFORE=/tmp/wheels-before \ --env WHEEL_DIR_AFTER=/tmp/wheels-after \ -it rapidsai/ci-wheel:cuda12.5.1-rockylinux8-py3.11 \ bash mkdir -p "${WHEEL_DIR_BEFORE}" mkdir -p "${WHEEL_DIR_AFTER}" py_projects=( cuspatial cuproj ) for project in "${py_projects[@]}"; do # before RAPIDS_BUILD_TYPE=nightly \ RAPIDS_PY_WHEEL_NAME="${project}_${RAPIDS_PY_CUDA_SUFFIX}" \ RAPIDS_REF_NAME="branch-24.10" \ RAPIDS_SHA=${RAPIDS_NIGHTLY_SHA} \ rapids-download-wheels-from-s3 python "${WHEEL_DIR_BEFORE}" # after RAPIDS_BUILD_TYPE=pull-request \ RAPIDS_PY_WHEEL_NAME="${project}_${RAPIDS_PY_CUDA_SUFFIX}" \ RAPIDS_REF_NAME="pull-request/${RAPIDS_PR_NUMBER}" \ rapids-download-wheels-from-s3 python "${WHEEL_DIR_AFTER}" done # after RAPIDS_BUILD_TYPE=pull-request \ RAPIDS_PY_WHEEL_NAME="libcuspatial_${RAPIDS_PY_CUDA_SUFFIX}" \ RAPIDS_REF_NAME="pull-request/${RAPIDS_PR_NUMBER}" \ rapids-download-wheels-from-s3 cpp "${WHEEL_DIR_AFTER}" du -sh ${WHEEL_DIR_BEFORE}/* du -sh ${WHEEL_DIR_BEFORE} du -sh ${WHEEL_DIR_AFTER}/* du -sh ${WHEEL_DIR_AFTER} ``` </details> ### devcontainers job? Once this PR is close to ready, let's merge the devcontainers PR and then re-run the devcontainers CI here. devcontainers PR: rapidsai/devcontainers#387 ### `rapids-metadata` changes? Not necessary, `libcuspatial` is already there: https://github.com/rapidsai/rapids-metadata/blob/9b6307e708511cd9a1990d8bb36606df53bc9e1b/src/rapids_metadata/__init__.py#L89 # Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Bradley Dice (https://github.com/bdice) - Mark Harris (https://github.com/harrism) - Vyas Ramasubramani (https://github.com/vyasr) URL: #1450
rapidsai · Sep 4, 2024 · 0e9d36c · 0e9d36c
1 parent e07d66c
commit 0e9d36c
Show file tree

Hide file tree

Showing 21 changed files with 373 additions and 42 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -66,7 +66,30 @@ jobs:
       node_type: "gpu-v100-latest-1"
       run_script: "ci/build_docs.sh"
       sha: ${{ inputs.sha }}
+  wheel-build-libcuspatial:
+    secrets: inherit
+    uses: rapidsai/shared-workflows/.github/workflows/wheels-build.yaml@branch-24.10
+    with:
+      # build for every combination of arch and CUDA version, but only for the latest Python
+      matrix_filter: group_by([.ARCH, (.CUDA_VER|split(".")|map(tonumber)|.[0])]) | map(max_by(.PY_VER|split(".")|map(tonumber)))
+      build_type: ${{ inputs.build_type || 'branch' }}
+      branch: ${{ inputs.branch }}
+      sha: ${{ inputs.sha }}
+      date: ${{ inputs.date }}
+      script: ci/build_wheel_libcuspatial.sh
+  wheel-publish-libcuspatial:
+    needs: wheel-build-libcuspatial
+    secrets: inherit
+    uses: rapidsai/shared-workflows/.github/workflows/wheels-publish.yaml@branch-24.10
+    with:
+      build_type: ${{ inputs.build_type || 'branch' }}
+      branch: ${{ inputs.branch }}
+      sha: ${{ inputs.sha }}
+      date: ${{ inputs.date }}
+      package-name: libcuspatial
+      package-type: cpp
   wheel-build-cuspatial:
+    needs: wheel-publish-libcuspatial
     secrets: inherit
     uses: rapidsai/shared-workflows/.github/workflows/wheels-build.yaml@branch-24.10
     with:

diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -21,6 +21,7 @@ jobs:
       - conda-notebook-tests
       - docs-build
       - wheel-build-cuspatial
+      - wheel-build-libcuspatial
       - wheel-tests-cuspatial
       - wheel-build-cuproj
       - wheel-tests-cuproj
@@ -83,10 +84,19 @@ jobs:
       arch: "amd64"
       container_image: "rapidsai/ci-conda:latest"
       run_script: "ci/build_docs.sh"
-  wheel-build-cuspatial:
+  wheel-build-libcuspatial:
     needs: checks
     secrets: inherit
     uses: rapidsai/shared-workflows/.github/workflows/wheels-build.yaml@branch-24.10
+    with:
+      # build for every combination of arch and CUDA version, but only for the latest Python
+      matrix_filter: group_by([.ARCH, (.CUDA_VER|split(".")|map(tonumber)|.[0])]) | map(max_by(.PY_VER|split(".")|map(tonumber)))
+      build_type: pull-request
+      script: ci/build_wheel_libcuspatial.sh
+  wheel-build-cuspatial:
+    needs: [checks, wheel-build-libcuspatial]
+    secrets: inherit
+    uses: rapidsai/shared-workflows/.github/workflows/wheels-build.yaml@branch-24.10
     with:
       build_type: pull-request
       script: ci/build_wheel_cuspatial.sh

diff --git a/build.sh b/build.sh
@@ -124,11 +124,6 @@ if hasArg benchmarks; then
     BUILD_BENCHMARKS=ON
 fi
 
-# Append `-DFIND_CUSPATIAL_CPP=ON` to EXTRA_CMAKE_ARGS unless a user specified the option.
-if [[ "${EXTRA_CMAKE_ARGS}" != *"DFIND_CUSPATIAL_CPP"* ]]; then
-    EXTRA_CMAKE_ARGS="${EXTRA_CMAKE_ARGS} -DFIND_CUSPATIAL_CPP=ON"
-fi
-
 # Append `-DFIND_CUPROJ_CPP=ON` to EXTRA_CMAKE_ARGS unless a user specified the option.
 if [[ "${EXTRA_CMAKE_ARGS}" != *"DFIND_CUPROJ_CPP"* ]]; then
     EXTRA_CMAKE_ARGS="${EXTRA_CMAKE_ARGS} -DFIND_CUPROJ_CPP=ON"

diff --git a/ci/build_wheel.sh b/ci/build_wheel.sh
@@ -7,6 +7,25 @@ package_name=$1
 package_dir=$2
 package_type=$3
 
+# The 'libcuspatial' wheel should package 'libcuspatial.so', and all others
+# should exclude it (they dynamically load it if they need it).
+#
+# Capturing that here in argument-parsing to allow this build_wheel.sh
+# script to be re-used by all wheel builds in the project.
+case "${package_dir}" in
+  python/libcuspatial)
+    EXCLUDE_ARGS=(
+      --exclude "libcudf.so"
+    )
+  ;;
+  *)
+    EXCLUDE_ARGS=(
+      --exclude "libcudf.so"
+      --exclude "libcuspatial.so"
+    )
+  ;;
+esac
+
 source rapids-configure-sccache
 source rapids-date-string
 
@@ -20,7 +39,7 @@ python -m pip wheel . -w dist -vvv --no-deps --disable-pip-version-check
 
 mkdir -p final_dist
 python -m auditwheel repair \
-    --exclude libcudf.so \
+    "${EXCLUDE_ARGS[@]}" \
     -w final_dist \
     dist/*
 

diff --git a/ci/build_wheel_cuspatial.sh b/ci/build_wheel_cuspatial.sh
@@ -3,4 +3,15 @@
 
 set -euo pipefail
 
+RAPIDS_PY_CUDA_SUFFIX="$(rapids-wheel-ctk-name-gen ${RAPIDS_CUDA_VERSION})"
+
+# Downloads libcuspatial wheel from this current build,
+# then ensures 'cuspatial' wheel builds always use the 'libcuspatial' just built in the same CI run.
+#
+# Using env variable PIP_CONSTRAINT is necessary to ensure the constraints
+# are used when creating the isolated build environment.
+RAPIDS_PY_WHEEL_NAME="libcuspatial_${RAPIDS_PY_CUDA_SUFFIX}" rapids-download-wheels-from-s3 cpp /tmp/libcuspatial_dist
+echo "libcuspatial-${RAPIDS_PY_CUDA_SUFFIX} @ file://$(echo /tmp/libcuspatial_dist/libcuspatial_*.whl)" > /tmp/constraints.txt
+export PIP_CONSTRAINT="/tmp/constraints.txt"
+
 ci/build_wheel.sh cuspatial python/cuspatial python
diff --git a/ci/build_wheel_libcuspatial.sh b/ci/build_wheel_libcuspatial.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+# Copyright (c) 2024, NVIDIA CORPORATION.
+
+set -euo pipefail
+
+ci/build_wheel.sh libcuspatial python/libcuspatial cpp
diff --git a/ci/test_wheel_cuproj.sh b/ci/test_wheel_cuproj.sh
@@ -21,12 +21,14 @@ fi
 # Download the cuproj and cuspatial built in the previous step
 RAPIDS_PY_WHEEL_NAME="cuproj_${RAPIDS_PY_CUDA_SUFFIX}" rapids-download-wheels-from-s3 python ./dist
 RAPIDS_PY_WHEEL_NAME="cuspatial_${RAPIDS_PY_CUDA_SUFFIX}" rapids-download-wheels-from-s3 python ./dist
+RAPIDS_PY_WHEEL_NAME="libcuspatial_${RAPIDS_PY_CUDA_SUFFIX}" rapids-download-wheels-from-s3 cpp ./dist
 
 # echo to expand wildcard before adding `[extra]` requires for pip
 python -m pip install \
   --no-binary 'fiona' \
   "$(echo ./dist/cuspatial*.whl)" \
   "$(echo ./dist/cuproj*.whl)[test]" \
+  "$(echo ./dist/libcuspatial*.whl)" \
   'fiona>=1.8.19,<1.9'
 
 rapids-logger "pytest cuproj"

diff --git a/ci/test_wheel_cuspatial.sh b/ci/test_wheel_cuspatial.sh
@@ -18,13 +18,15 @@ else
   DEBIAN_FRONTEND=noninteractive apt install -y --no-install-recommends libgdal-dev
 fi
 
-# Download the cuspatial built in the previous step
+# Download the cuspatial and libcuspatial built in the previous step
 RAPIDS_PY_WHEEL_NAME="cuspatial_${RAPIDS_PY_CUDA_SUFFIX}" rapids-download-wheels-from-s3 python ./dist
+RAPIDS_PY_WHEEL_NAME="libcuspatial_${RAPIDS_PY_CUDA_SUFFIX}" rapids-download-wheels-from-s3 cpp ./dist
 
 # echo to expand wildcard before adding `[extra]` requires for pip
 python -m pip install \
   --no-binary 'fiona' \
   "$(echo ./dist/cuspatial*.whl)[test]" \
+  "$(echo ./dist/libcuspatial*.whl)" \
   'fiona>=1.8.19,<1.9'
 
 rapids-logger "pytest cuspatial"

diff --git a/cpp/cmake/thirdparty/get_ranger.cmake b/cpp/cmake/thirdparty/get_ranger.cmake
@@ -1,5 +1,5 @@
 #=============================================================================
-# Copyright (c) 2023, NVIDIA CORPORATION.
+# Copyright (c) 2023-2024, NVIDIA CORPORATION.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -26,8 +26,6 @@ function(find_and_configure_ranger)
     rapids_cpm_find(
       ranger 00.01.00
       GLOBAL_TARGETS "${global_targets}"
-      BUILD_EXPORT_SET cuspatial-exports
-      INSTALL_EXPORT_SET cuspatial-exports
       CPM_ARGS
       GIT_REPOSITORY https://github.com/harrism/ranger.git
       GIT_TAG main

diff --git a/dependencies.yaml b/dependencies.yaml
@@ -18,6 +18,7 @@ files:
       - depends_on_cuml
       - depends_on_cupy
       - depends_on_libcudf
+      - depends_on_libcuspatial
       - depends_on_librmm
       - rapids_build_skbuild
       - run_python_cuspatial
@@ -30,11 +31,13 @@ files:
     output: none
     includes:
       - cuda_version
+      - depends_on_libcuspatial
       - test_libcuspatial
   test_python:
     output: none
     includes:
       - cuda_version
+      - depends_on_libcuspatial
       - py_version
       - test_python_cuspatial
       - test_python_cuproj
@@ -44,6 +47,7 @@ files:
     includes:
       - cuda_version
       - depends_on_cuml
+      - depends_on_libcuspatial
       - test_notebooks
       - notebooks
       - py_version
@@ -57,9 +61,35 @@ files:
     output: none
     includes:
       - cuda_version
+      - depends_on_libcuspatial
       - docs
       - py_version
       - test_cuspatial
+  py_build_libcuspatial:
+    output: [pyproject]
+    pyproject_dir: python/libcuspatial
+    extras:
+      table: build-system
+    includes:
+      - rapids_build_skbuild
+  py_rapids_build_libcuspatial:
+    output: [pyproject]
+    pyproject_dir: python/libcuspatial
+    extras:
+      table: tool.rapids-build-backend
+      key: requires
+    includes:
+      - build_cpp
+      - build_wheels
+      - depends_on_libcudf
+      - depends_on_librmm
+  py_run_libcuspatial:
+    output: [pyproject]
+    pyproject_dir: python/libcuspatial
+    extras:
+      table: project
+    includes:
+      - depends_on_libcudf
   py_build_cuspatial:
     output: [pyproject]
     pyproject_dir: python/cuspatial
@@ -80,6 +110,7 @@ files:
       - build_python
       - build_wheels
       - depends_on_libcudf
+      - depends_on_libcuspatial
       - depends_on_librmm
   py_run_cuspatial:
     output: [pyproject]
@@ -89,6 +120,7 @@ files:
     includes:
       - depends_on_cudf
       - depends_on_libcudf
+      - depends_on_libcuspatial
       - depends_on_rmm
       - run_python_cuspatial
   py_test_cuspatial:
@@ -540,16 +572,39 @@ dependencies:
     common:
       - output_types: conda
         packages:
-          - libcuspatial==24.10.*,>=0.0.0a0
           - libcuspatial-tests==24.10.*,>=0.0.0a0
   test_cuspatial:
     common:
       - output_types: conda
         packages:
-          - libcuspatial==24.10.*,>=0.0.0a0
           - cuspatial==24.10.*,>=0.0.0a0
           - cuproj==24.10.*,>=0.0.0a0
 
+  depends_on_libcuspatial:
+    common:
+      - output_types: conda
+        packages:
+          - &libcuspatial_unsuffixed libcuspatial==24.10.*,>=0.0.0a0
+      - output_types: requirements
+        packages:
+          # pip recognizes the index as a global option for the requirements.txt file
+          - --extra-index-url=https://pypi.nvidia.com
+          - --extra-index-url=https://pypi.anaconda.org/rapidsai-wheels-nightly/simple
+    specific:
+      - output_types: [requirements, pyproject]
+        matrices:
+          - matrix:
+              cuda: "12.*"
+              cuda_suffixed: "true"
+            packages:
+              - libcuspatial-cu12==24.10.*,>=0.0.0a0
+          - matrix:
+              cuda: "11.*"
+              cuda_suffixed: "true"
+            packages:
+              - libcuspatial-cu11==24.10.*,>=0.0.0a0
+          - {matrix: null, packages: [*libcuspatial_unsuffixed]}
+
   depends_on_librmm:
     common:
       - output_types: conda

diff --git a/python/cuspatial/CMakeLists.txt b/python/cuspatial/CMakeLists.txt
@@ -23,34 +23,9 @@ project(
   VERSION "${RAPIDS_VERSION}"
   LANGUAGES CXX CUDA)
 
-option(FIND_CUSPATIAL_CPP "Search for existing cuspatial C++ installations before defaulting to local files"
-       OFF)
-
-# If the user requested it we attempt to find cuspatial.
-if(FIND_CUSPATIAL_CPP)
-  find_package(cuspatial "${RAPIDS_VERSION}")
-else()
-  set(cuspatial_FOUND OFF)
-endif()
-
-if(NOT cuspatial_FOUND)
-  set(BUILD_TESTS OFF)
-  set(BUILD_BENCHMARKS OFF)
-  set(CUDA_STATIC_RUNTIME ON)
-  set(CUSPATIAL_USE_CUDF_STATIC ON)
-  set(CUSPATIAL_EXCLUDE_CUDF_FROM_ALL ON)
-
-  add_subdirectory(../../cpp cuspatial-cpp EXCLUDE_FROM_ALL)
-
-  set(cython_lib_dir cuspatial)
-  install(TARGETS cuspatial DESTINATION ${cython_lib_dir})
-endif()
+find_package(cuspatial "${RAPIDS_VERSION}" REQUIRED)
 
 include(rapids-cython-core)
 rapids_cython_init()
 
 add_subdirectory(cuspatial/_lib)
-
-if(DEFINED cython_lib_dir)
-  rapids_cython_add_rpath_entries(TARGET cuspatial PATHS "${cython_lib_dir}")
-endif()
diff --git a/python/cuspatial/cuspatial/__init__.py b/python/cuspatial/cuspatial/__init__.py
@@ -1,8 +1,16 @@
 # Copyright (c) 2023-2024, NVIDIA CORPORATION.
 
-# load cudf before any other imports, to be sure libcudf's symbols are found
-# in the libcudf.so from the libcudf wheel (if one is installed)
-import cudf
+# If libcuspatial was installed as a wheel, we must request it to load the library
+# symbols. Otherwise, we assume that the library was installed in a system path that ld
+# can find.
+try:
+    import libcuspatial
+except ModuleNotFoundError:
+    pass
+else:
+    libcuspatial.load_library()
+    del libcuspatial
+
 
 from ._version import __git_commit__, __version__
 from .core.geodataframe import GeoDataFrame

diff --git a/python/cuspatial/pyproject.toml b/python/cuspatial/pyproject.toml
@@ -33,6 +33,7 @@ dependencies = [
     "cudf==24.10.*,>=0.0.0a0",
     "geopandas>=0.11.0",
     "libcudf==24.10.*,>=0.0.0a0",
+    "libcuspatial==24.10.*,>=0.0.0a0",
     "numpy>=1.23,<2.0a0",
     "rmm==24.10.*,>=0.0.0a0",
 ] # This list was generated by `rapids-dependency-file-generator`. To make changes, edit ../../dependencies.yaml and run `rapids-dependency-file-generator`.
@@ -137,6 +138,7 @@ requires = [
     "cudf==24.10.*,>=0.0.0a0",
     "cython>=3.0.0",
     "libcudf==24.10.*,>=0.0.0a0",
+    "libcuspatial==24.10.*,>=0.0.0a0",
     "librmm==24.10.*,>=0.0.0a0",
     "ninja",
     "rmm==24.10.*,>=0.0.0a0",