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

Disable librmm and libcudf docs #464

Closed
wants to merge 4 commits into from

Conversation

vyasr
Copy link

@vyasr vyasr commented Dec 18, 2023

These doxygen doc builds are both now incorporated into the Sphinx builds and need not be published separately. The rmm docs were published as part of the 23.12 release, so they can also be removed from the stable pages, but libcudf is only being merged this release so only the nightly can be removed. This PR should be merged after rapidsai/cudf#13846.

@vyasr vyasr requested a review from a team as a code owner December 18, 2023 17:51
Copy link

netlify bot commented Dec 18, 2023

Deploy Preview for docs-rapids-ai ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 1746b3f
🔍 Latest deploy log https://app.netlify.com/sites/docs-rapids-ai/deploys/6581d28a4e5f62000854b548
😎 Deploy Preview https://deploy-preview-464--docs-rapids-ai.netlify.app/api
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jarmak-nv
Copy link
Contributor

jarmak-nv commented Dec 18, 2023

Can't add suggestions since the code wasn't modified, but I think we should add a note in librmm and libcudf pointing users to the RMM/cuDF docs page so people don't get confused when they get to librmm and see there's no stable/nightly docs.

Probably would do it as a newline after the library descriptions.

@vyasr
Copy link
Author

vyasr commented Dec 18, 2023

@jarmak-nv does this change look like what you were intending? I didn't include a newline because I wasn't sure if that would work.

Copy link
Contributor

@jarmak-nv jarmak-nv left a comment

Choose a reason for hiding this comment

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

Approving, but would like to see similar changes in RMM/cuDF's doc intro text as well (and similar comment about testing the linebreak if you have time).

RMM:

RAPIDS Memory Manager (RMM) is a central place for all device memory allocations in cuDF (C++ and Python) and other RAPIDS libraries. In addition, it is a replacement allocator for CUDA Device Memory (and CUDA Managed Memory) and a pool allocator to make CUDA device memory allocation / deallocation faster and asynchronous. As of 23.12 we have integrated librmm's docs alongside RMM's docs for a unified experience.

cuDF:

cuDF is a Python GPU DataFrame library (built on the Apache Arrow columnar memory format) for loading, joining, aggregating, filtering, and otherwise manipulating data. As of 24.02 we have integrated libcudf's docs alongside cuDF's docs for a unified experience.

_data/docs.yml Outdated Show resolved Hide resolved
_data/docs.yml Outdated Show resolved Hide resolved
_data/docs.yml Outdated Show resolved Hide resolved
_data/docs.yml Outdated Show resolved Hide resolved
@jarmak-nv
Copy link
Contributor

😞 \n is a no go. Thanks for trying!

_data/docs.yml Outdated Show resolved Hide resolved
_data/docs.yml Outdated Show resolved Hide resolved
@vyasr
Copy link
Author

vyasr commented Dec 19, 2023

Worth a shot! @jarmak-nv feel free to merge whenever you approve. I can make the changes to cudf/rmm separately.

@jarmak-nv
Copy link
Contributor

👍 Will do once rapidsai/cudf#13846 goes in

@vyasr vyasr marked this pull request as draft January 11, 2024 19:16
@vyasr
Copy link
Author

vyasr commented Jan 11, 2024

We're no longer planning to remove the cudf doxygen docs in rapidsai/cudf#13846. We want to spend a bit more time iterating on them until everyone is happy with their appearance. I'll reopen this PR from draft once more of those changes are completed and I'll update this PR at that time based on the timeline.

@vyasr
Copy link
Author

vyasr commented Feb 22, 2024

The rmm piece is done in #478. I'm going to close this PR for now. I can reopen it for cudf if and when we're ready to make the change for just cudf.

@vyasr vyasr closed this Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants