Skip to content

Commit ee1d282

Browse files
authored
Adding simple tarball install to build and install docs (#1868)
This is meant to be a very simple few steps to install the tarball (which is just untarring the tarball and making sure the proper pre-reqs are installed). Build from source and comprehensive "is it installed correctly?" materials will come later. Authors: - Corey J. Nolet (https://github.com/cjnolet) Approvers: - Ben Frederickson (https://github.com/benfred) URL: #1868
1 parent 105c61e commit ee1d282

File tree

2 files changed

+34
-35
lines changed

2 files changed

+34
-35
lines changed

README.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -77,40 +77,7 @@ cuVS is built on top of the RAPIDS RAFT library of high performance machine lear
7777

7878
## Installing cuVS
7979

80-
cuVS comes with pre-built packages that can be installed through [conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html#managing-python) and [pip](https://pip.pypa.io/en/stable/). Different packages are available for the different languages supported by cuVS:
81-
82-
| Python | C/C++ |
83-
|--------|-----------|
84-
| `cuvs` | `libcuvs` |
85-
86-
### Stable release
87-
88-
It is recommended to use [mamba](https://conda.github.io/conda-libmamba-solver/user-guide/) to install the desired packages. The following command will install the Python package. You can substitute `cuvs` for any of the packages in the table above:
89-
90-
```bash
91-
conda install -c rapidsai -c conda-forge cuvs
92-
```
93-
94-
The cuVS Python package can also be installed through [pip](https://docs.rapids.ai/install#pip>).
95-
96-
```bash
97-
# CUDA 13
98-
pip install cuvs-cu13 --extra-index-url=https://pypi.nvidia.com
99-
100-
# CUDA 12
101-
pip install cuvs-cu12 --extra-index-url=https://pypi.nvidia.com
102-
```
103-
104-
### Nightlies
105-
If installing a version that has not yet been released, the `rapidsai` channel can be replaced with `rapidsai-nightly`:
106-
107-
```bash
108-
# CUDA 13
109-
conda install -c rapidsai-nightly -c conda-forge cuvs=26.04 cuda-version=13.1
110-
111-
# CUDA 12
112-
conda install -c rapidsai-nightly -c conda-forge cuvs=26.04 cuda-version=12.9
113-
```
80+
cuVS comes with pre-built packages that can be installed through [conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html#managing-python) and [pip](https://pip.pypa.io/en/stable/) or [tarball](https://developer.nvidia.com/cuvs-downloads). Different packages are available for the different languages supported by cuVS.
11481

11582
> [!NOTE]
11683
> If compiled binary size is a concern, please note that the cuVS builds for CUDA 13 are roughly half the size of CUDA 12 builds. This is a result of improved compression rates in the newer supported CUDA drivers. We will be adopting the newer drivers for CUDA 12 builds in Spring of 2026, which will ultimately bring them down to roughly the size of the CUDA 13 builds. In the meantime, the NVIDIA cuVS team is continuing to shave down the binary sizes for all supported CUDA versions. If binary size is an issue for you, please consider linking to cuVS statically either by building from source or using pre-built `libcuvs-static` conda package.

docs/source/build.rst

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The cuVS software development kit provides APIs for C, C++, Python, and Rust lan
99

1010
* `Python through Pip`_
1111

12+
* `Tarball`_
13+
1214
- `Build from source`_
1315

1416
* `Prerequisites`_
@@ -77,12 +79,42 @@ The cuVS Python package can also be `installed through pip <https://docs.rapids.
7779
7880
Note: these packages statically link the C and C++ libraries so the `libcuvs` and `libcuvs_c` shared libraries won't be readily available to use in your code.
7981

82+
Tarball
83+
^^^^^^^
84+
85+
Install Dependencies
86+
~~~~~~~~~~~~~~~~~~~~
87+
88+
1. `NCCL <https://docs.nvidia.com/deeplearning/nccl/install-guide/index.html>` _
89+
2. `libopenmp`
90+
3. CUDA Toolkit Runtime 12.2+
91+
4. Ampere architecture or better (compute capability >= 8.0)
92+
93+
Download & Extract
94+
~~~~~~~~~~~~~~~~~~
95+
96+
Download the pre-built tarball for your CPU architecture and CUDA version from
97+
`https://developer.nvidia.com/cuvs-downloads <https://developer.nvidia.com/cuvs-downloads>`_
98+
99+
Untar the tarball into a directory.
100+
101+
.. code-block:: bash
102+
103+
tar -xzvf libcuvs-linux-sbsa-26.02.00.189485_cuda12-archive.tar.xz -C /path/to/folder
104+
105+
106+
Add cuVS to your system library load path. This should be done in the appropriate profile configuration (for e.g. `.bashrc`, `.bash_profile`) to maintain the setting across sessions.
107+
108+
.. code-block:: bash
109+
110+
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/folder
111+
112+
80113
Build from source
81114
-----------------
82115

83116
The core cuVS source code is written in C++ and wrapped through a C API. The C API is wrapped around the C++ APIs and the other supported languages are built around the C API.
84117

85-
86118
Prerequisites
87119
^^^^^^^^^^^^^
88120

0 commit comments

Comments
 (0)