Skip to content

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

Merged
rapids-bot[bot] merged 3 commits into
NVIDIA:branch-24.08from
jameslamb:docs/library-name
Jun 27, 2024
Merged

fix library name in docs ('cuvs' not 'pycuvs')#193
rapids-bot[bot] merged 3 commits into
NVIDIA:branch-24.08from
jameslamb:docs/library-name

Conversation

@jameslamb

Copy link
Copy Markdown
Member

The Python library is distributed as conda package cuvs, but the installation docs say pycuvs. This fixes that.

Looked for other uses like this:

git grep -i pycuvs

Didn't find any.

@jameslamb jameslamb added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Jun 17, 2024
@jameslamb jameslamb requested a review from raydouglass June 17, 2024 22:07
Comment thread README.md Outdated
| Python | C++ | C |
|--------|-----|---|
| `pycuvs`| `libcuvs` | `libcuvs_c` |
| `cuvs`| `libcuvs` | `libcuvs_c` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there is a libcuvs_c package, but there is a libcuvs-static: https://github.com/rapidsai/cuvs/blob/branch-24.08/conda/recipes/libcuvs/meta.yaml#L18

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a libcuvs_c shared library, with a C API over libcuvs:

https://github.com/rapidsai/cuvs/blob/9dc3a4dc5085cb5eb92d18ca1eafd5eef3dc405e/cpp/CMakeLists.txt#L556

https://github.com/rapidsai/cuvs/blob/9dc3a4dc5085cb5eb92d18ca1eafd5eef3dc405e/cpp/CMakeLists.txt#L588-L592

But you're right, it doesn't appear there's a conda package being distributed under that name.

I just pushed a commit updating the relevant docs, but maybe we should get another review from @benfred or @cjnolet to be sure the docs are representing these packages the way they'd like.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there would be much point of a libcuvs_c, since it just contains the C-API that requires lubcuvs, so this change makes sense to me. Would like confirmation from @benfred that I'm not misremembering something.

@jameslamb jameslamb requested a review from a team as a code owner June 17, 2024 22:29

@dantegd dantegd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes lgtm

@cjnolet

cjnolet commented Jun 27, 2024

Copy link
Copy Markdown
Contributor

/merge

@rapids-bot rapids-bot Bot merged commit ebfd068 into NVIDIA:branch-24.08 Jun 27, 2024
@jameslamb jameslamb deleted the docs/library-name branch June 27, 2024 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants