Skip to content

Commit 4c23525

Browse files
committed
Updating readme
1 parent 7632dc8 commit 4c23525

File tree

2 files changed

+11
-43
lines changed

2 files changed

+11
-43
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: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,25 +82,26 @@ Note: these packages statically link the C and C++ libraries so the `libcuvs` an
8282
Tarball
8383
^^^^^^^
8484

85-
Prerequisites
86-
^^^^^^^^^^^^^
85+
* Install prerequisites
8786

88-
- `NCCL <https://docs.nvidia.com/deeplearning/nccl/install-guide/index.html>` _
89-
- `libopenmp`
90-
- CUDA Toolkit Runtime 12.2+
91-
- Ampere architecture or better (compute capability >= 8.0)
87+
* `NCCL <https://docs.nvidia.com/deeplearning/nccl/install-guide/index.html>` _
88+
* `libopenmp`
89+
* CUDA Toolkit Runtime 12.2+
90+
* Ampere architecture or better (compute capability >= 8.0)
9291

93-
Download the pre-built tarball for your CPU architecture and CUDA version from
92+
* Download the pre-built tarball for your CPU architecture and CUDA version from
9493
`https://developer.nvidia.com/cuvs-downloads <https://developer.nvidia.com/cuvs-downloads>`_
9594

96-
Untar the tarball into a directory
95+
* Untar the tarball into a directory
9796

9897
.. code-block:: bash
98+
9999
tar -xzvf libcuvs-linux-sbsa-26.02.00.189485_cuda12-archive.tar.xz -C /path/to/folder
100100
101-
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.
101+
* 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.
102102

103103
.. code-block:: bash
104+
104105
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/path/to/folder
105106
106107

0 commit comments

Comments
 (0)