Skip to content

Commit ebfd068

Browse files
authored
fix library name in docs ('cuvs' not 'pycuvs') (#193)
The Python library is distributed as conda package `cuvs`, but the installation docs say `pycuvs`. This fixes that. Looked for other uses like this: ```shell git grep -i pycuvs ``` Didn't find any. Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Dante Gama Dessavre (https://github.com/dantegd) URL: #193
1 parent 581c9cc commit ebfd068

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,23 @@ cuVS contains state-of-the-art implementations of several algorithms for running
3434

3535
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). Different packages are available for the different languages supported by cuVS:
3636

37-
| Python | C++ | C |
38-
|--------|-----|---|
39-
| `pycuvs`| `libcuvs` | `libcuvs_c` |
37+
| Python | C/C++ |
38+
|--------|-----------------------------|
39+
| `cuvs` | `libcuvs`, `libcuvs-static` |
4040

4141
### Stable release
4242

43-
It is recommended to use [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) to install the desired packages. The following command will install the Python package. You can substitute `pycuvs` for any of the packages in the table above:
43+
It is recommended to use [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html) 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:
44+
4445
```bash
45-
mamba install -c conda-forge -c nvidia -c rapidsai pycuvs
46+
mamba install -c conda-forge -c nvidia -c rapidsai cuvs
4647
```
4748

4849
### Nightlies
4950
If installing a version that has not yet been released, the `rapidsai` channel can be replaced with `rapidsai-nightly`:
51+
5052
```bash
51-
mamba install -c conda-forge -c nvidia -c rapidsai-nightly pycuvs=24.08
53+
mamba install -c conda-forge -c nvidia -c rapidsai-nightly cuvs=24.08
5254
```
5355

5456
Please see the [Build and Install Guide](docs/source/build.md) for more information on installing cuVS and building from source.

docs/source/build.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ C Package
5050

5151
.. code-block:: bash
5252
53-
mamba install -c rapidsai -c conda-forge -c nvidia libcuvs_c cuda-version=12.0
53+
mamba install -c rapidsai -c conda-forge -c nvidia libcuvs cuda-version=12.0
5454
5555
Python Package
5656
~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)