Rust publishing updates (#789)

This PR adds automation for publishing the `cuvs` and `cuvs-sys` rust
crates.

I updated the rust usage
[README](https://github.com/rapidsai/cuvs/pull/789/files#diff-bcb0eb230db7a19167a81000c18bfb176049613f522d077479aa702384af7097)
to include simple steps to import the `cuvs` module in any consuming
rust project. I've added conda environment files that would facilitate
the installation steps described in the
[README](https://github.com/rapidsai/cuvs/pull/789/files#diff-bcb0eb230db7a19167a81000c18bfb176049613f522d077479aa702384af7097).

---

**Testing the changes in this PR included the following steps**:

- I first replicated local builds of the `cuvs` rust module.
- Then I attempted a build of the rust example in the `examples`
directory which imports the current `cuvs` library as is, and
successfully ran the rust example project.
- I updated the rust bindings to use different package names and
published both as:
    - [jawe-cuvs-iii](https://crates.io/crates/jawe-cuvs-iii) (cuvs)
- [jave-cuvs-sys-iii](https://crates.io/crates/jawe-cuvs-sys-iii)
(cuvs-sys)
- I published by running the `publish-rust.yaml` workflow. First run can
be found
[here](https://github.com/rapidsai/cuvs/actions/runs/14158410647/job/39660631194),
and a second run
[here](https://github.com/rapidsai/cuvs/actions/runs/14205715742/job/39802866340).
- After publishing, I locally compiled the example rust module by
importing the published modules (`jawe-cuvs-iii` & `jawe-cuvs-sys-iii`)
and was able to successfully run the example rust project
- I also tested the build & imports on both ARM and AMD architectures.
<details>
<summary>Cargo run output </summary>

```
# cargo run
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.05s
     Running `target/debug/cuvs-rust-example`
using ivf_pq::index_params nrows 65536, dim 512, n_lists 256, pq_dim 128
[ 18669][17:16:49:911962][info  ] optimizing graph
[ 18669][17:16:50:057608][info  ] Graph optimized, creating index
Indexed 65536x512 datapoints into cagra index
Neighbors [[0, 6880, 12927, 59705, 45003, 33779, 39003, 56796, 6491, 34338],
 [1, 28206, 47512, 44788, 14031, 49376, 43330, 3429, 41428, 49044],
 [2, 45154, 4777, 62753, 45378, 13104, 4082, 46221, 65234, 45638],
 [3, 41243, 59296, 4950, 55157, 32839, 42927, 10811, 37504, 57827]], shape=[4, 10], strides=[10, 1], layout=Cc (0x5), const ndim=2
Distances [[0.0, 68.72183, 69.83197, 70.23868, 71.08637, 71.15034, 71.60148, 71.71672, 71.82242, 71.90005],
 [0.0, 68.85643, 69.43584, 69.72554, 69.883835, 70.03081, 70.05081, 70.1477, 70.169556, 70.26346],
 [0.0, 69.09878, 69.42933, 70.06172, 70.10106, 70.16475, 70.19414, 70.64023, 70.64905, 70.71358],
 [0.0, 64.99479, 65.39395, 66.827286, 66.99862, 67.110855, 67.57162, 67.779526, 67.964035, 68.002716]], shape=[4, 10], strides=[10, 1], layout=Cc (0x5), const ndim=2
```
</details>

Author: AyodeAwe

.github/workflows/build.yaml

@@ -47,6 +47,10 @@ jobs:
       node_type: "gpu-l4-latest-1"
       run_script: "ci/build_rust.sh"
       sha: ${{ inputs.sha }}
+  rust-publish:
+    needs: rust-build
+    secrets: inherit
+    uses: ./.github/workflows/publish-rust.yaml
   go-build:
     needs: cpp-build
     secrets: inherit

.github/workflows/publish-rust.yaml

@@ -0,0 +1,59 @@
+name: publish
+
+on:
+  workflow_call:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  rust-publish:
+    runs-on: ubuntu-latest
+    container:
+      image: rapidsai/ci-conda:latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check if release build
+        id: check_release
+        run: |
+          if rapids-is-release-build; then
+            echo "is_release=true" >> $GITHUB_OUTPUT
+          else
+            echo "is_release=false" >> $GITHUB_OUTPUT
+          fi
+      - name: Setup and publish crates
+        if: steps.check_release.outputs.is_release == 'true'
+        run: |
+          . /opt/conda/etc/profile.d/conda.sh
+
+          rapids-dependency-file-generator \
+            --output conda \
+            --file-key rust \
+            --matrix "cuda=${RAPIDS_CUDA_VERSION%.*};arch=$(arch);py=${RAPIDS_PY_VERSION}" \
+            | tee env.yaml
+
+          rapids-mamba-retry env create --yes -f env.yaml -n rust
+
+          set +eu
+          conda activate rust
+          set -eu
+
+          LIBCLANG_PATH=$(dirname "$(find /opt/conda -name libclang.so | head -n 1)")
+          export LIBCLANG_PATH
+          echo "LIBCLANG_PATH=$LIBCLANG_PATH"
+
+          # Publish sys crate first
+          pushd ./rust/cuvs-sys
+          cargo publish --token ${CARGO_REGISTRY_TOKEN}
+          popd
+
+          # Wait for crates.io index update
+          sleep 30
+
+          # Publish main crate
+          pushd ./rust/cuvs
+          cargo publish --token ${CARGO_REGISTRY_TOKEN}
+          popd
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.GPUTESTER_CRATES_TOKEN }}

conda/environments/rust_cuda-128_arch-aarch64.yaml

@@ -0,0 +1,33 @@
+# This file is generated by `rapids-dependency-file-generator`.
+# To make changes, edit ../../dependencies.yaml and run `rapids-dependency-file-generator`.
+channels:
+- rapidsai
+- rapidsai-nightly
+- dask/label/dev
+- conda-forge
+- nvidia
+dependencies:
+- c-compiler
+- clang-tools==16.0.6
+- clang==16.0.6
+- cmake>=3.30.4
+- cuda-cudart-dev
+- cuda-nvcc
+- cuda-nvtx-dev
+- cuda-profiler-api
+- cuda-version=12.8
+- cxx-compiler
+- gcc_linux-aarch64=13.*
+- libclang==16.0.6
+- libcublas-dev
+- libcurand-dev
+- libcusolver-dev
+- libcusparse-dev
+- libcuvs==25.4.*,>=0.0.0a0
+- libraft==25.4.*,>=0.0.0a0
+- make
+- nccl>=2.19
+- ninja
+- rust
+- sysroot_linux-aarch64==2.28
+name: rust_cuda-128_arch-aarch64

conda/environments/rust_cuda-128_arch-x86_64.yaml

@@ -0,0 +1,33 @@
+# This file is generated by `rapids-dependency-file-generator`.
+# To make changes, edit ../../dependencies.yaml and run `rapids-dependency-file-generator`.
+channels:
+- rapidsai
+- rapidsai-nightly
+- dask/label/dev
+- conda-forge
+- nvidia
+dependencies:
+- c-compiler
+- clang-tools==16.0.6
+- clang==16.0.6
+- cmake>=3.30.4
+- cuda-cudart-dev
+- cuda-nvcc
+- cuda-nvtx-dev
+- cuda-profiler-api
+- cuda-version=12.8
+- cxx-compiler
+- gcc_linux-64=13.*
+- libclang==16.0.6
+- libcublas-dev
+- libcurand-dev
+- libcusolver-dev
+- libcusparse-dev
+- libcuvs==25.4.*,>=0.0.0a0
+- libraft==25.4.*,>=0.0.0a0
+- make
+- nccl>=2.19
+- ninja
+- rust
+- sysroot_linux-64==2.28
+name: rust_cuda-128_arch-x86_64

dependencies.yaml

@@ -81,7 +81,10 @@ files:
       - depends_on_libcuvs
       - depends_on_cuvs
   rust:
-    output: none
+    output: conda
+    matrix:
+      cuda: ["12.8"]
+      arch: [x86_64, aarch64]
     includes:
       # clang/libclang only needed for bindgen support
       - clang

examples/rust/README.md

@@ -5,3 +5,29 @@ This template project provides a drop-in sample to for using cuVS in a rust proj
 First, please refer to our [installation docs](https://docs.rapids.ai/api/cuvs/stable/build.html#cuda-gpu-requirements) for the minimum requirements to use cuVS. Note that you will have to have the libcuvs.so and libcuvs_c.so binaries installed to compile this example project.
 
 Once the minimum requirements are satisfied, this example template application can be built using 'cargo build', and this directory can be copied directly in order to build a new application with cuVS.
+
+You may follow these steps to quickly get set up:
+
+```bash
+conda env create --name rust -f conda/environments/rust_cuda-128_arch-x86_64.yaml
+conda activate rust
+```
+You may prefer to use `mamba`, as it provides significant speedup over `conda`.
+
+1. Set up the required environment variables:
+```bash
+LIBCLANG_PATH=$(dirname "$(find /opt/conda -name libclang.so | head -n 1)")
+export LIBCLANG_PATH
+echo "LIBCLANG_PATH=$LIBCLANG_PATH"
+```
+
+2. Add the cuvs dependency in your project:
+```TOML
+# Cargo.toml
+[dependencies]
+cuvs = ">=24.6.0"
+#...rest of your dependencies
+```
+Then you can run your project with `cargo run`.
+
+See [main.rs](./src/main.rs) for an example implementation.