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.

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

Conversation

jameslamb
Copy link
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
README.md Outdated
@@ -36,19 +36,21 @@ cuVS comes with pre-built packages that can be installed through [conda](https:/

| Python | C++ | C |
|--------|-----|---|
| `pycuvs`| `libcuvs` | `libcuvs_c` |
| `cuvs`| `libcuvs` | `libcuvs_c` |
Copy link
Member

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

add_library(

cuvs/cpp/CMakeLists.txt

Lines 588 to 592 in 9dc3a4d

target_link_libraries(
cuvs_c
PUBLIC cuvs::cuvs ${CUVS_CTK_MATH_DEPENDENCIES}
PRIVATE raft::raft
)

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
Member

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
Copy link
Member

@dantegd dantegd left a comment

Choose a reason for hiding this comment

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

changes lgtm

@cjnolet
Copy link
Member

cjnolet commented Jun 27, 2024

/merge

@rapids-bot rapids-bot bot merged commit ebfd068 into rapidsai:branch-24.08 Jun 27, 2024
54 checks passed
@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
Development

Successfully merging this pull request may close these issues.

4 participants