Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix library name in docs ('cuvs' not 'pycuvs') #193

Merged
merged 3 commits into from
Jun 27, 2024
Merged

fix library name in docs ('cuvs' not 'pycuvs') #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f323975
fix library name in docs ('cuvs' not 'pycuvs')
jameslamb Jun 17, 2024
fcab49c
update libcuvs package name too
jameslamb Jun 17, 2024
889e716
Merge branch 'branch-24.08' into docs/library-name
jameslamb Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,23 @@ cuVS contains state-of-the-art implementations of several algorithms for running

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:

| Python | C++ | C |
|--------|-----|---|
| `pycuvs`| `libcuvs` | `libcuvs_c` |
| Python | C/C++ |
|--------|-----------------------------|
| `cuvs` | `libcuvs`, `libcuvs-static` |

### Stable release

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:
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:

```bash
mamba install -c conda-forge -c nvidia -c rapidsai pycuvs
mamba install -c conda-forge -c nvidia -c rapidsai cuvs
```

### Nightlies
If installing a version that has not yet been released, the `rapidsai` channel can be replaced with `rapidsai-nightly`:

```bash
mamba install -c conda-forge -c nvidia -c rapidsai-nightly pycuvs=24.08
mamba install -c conda-forge -c nvidia -c rapidsai-nightly cuvs=24.08
```

Please see the [Build and Install Guide](docs/source/build.md) for more information on installing cuVS and building from source.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ C Package

.. code-block:: bash

mamba install -c rapidsai -c conda-forge -c nvidia libcuvs_c cuda-version=12.0
mamba install -c rapidsai -c conda-forge -c nvidia libcuvs cuda-version=12.0

Python Package
~~~~~~~~~~~~~~
Expand Down
Loading