Skip to content

[DOC] Make pylibcudf docs more visible #17803

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

Jump to bottom
Merged
merged 10 commits into from
Jan 30, 2025
Merged

[DOC] Make pylibcudf docs more visible #17803

merged 10 commits into from
Jan 30, 2025

Conversation

Matt711
Copy link
Contributor

@Matt711 Matt711 commented Jan 24, 2025

Description

Closes #17190

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@Matt711 Matt711 added feature request New feature or request non-breaking Non-breaking change doc Documentation and removed feature request New feature or request labels Jan 24, 2025
@Matt711 Matt711 changed the title [FEA] Make pylibcudf docs more visible [DOC] Make pylibcudf docs more visible Jan 24, 2025
@Matt711 Matt711 requested review from vyasr and wence- January 24, 2025 00:22
@vyasr
Copy link
Contributor

vyasr commented Jan 25, 2025

A few high-level notes:

  • It looks like there are a bunch of warnings in the doc builds now, could you take a look at those?
    -As part of this PR I think we should update the main landing page for the cudf docs. That page doesn't even mention cudf-polars, let alone pylibcudf (or libcudf). Let's get that a bit more updated.
  • We probably ought to mention in the top-level page that the packages are a stack, with cudf classic, cudf.pandas, and cudf-polars all built on top of pylibcudf. Ideally we would have a diagram but that's probably out of scope for this PR.
  • We need a pylibcudf-specific landing page like this one for cudf.pandas. Nothing too fancy to start with; a brief description of the library and its goals would suffice.
  • Our developer guide is woefully out of date. I wrote it before cudf.pandas existed. We now need to update that for cudf.pandas, cudf-polars, and pylibcudf. I would suggest in this PR just adding some sort of warning banner indicating that this page needs significant updates and that all information should be taken with a grain of salt.

@copy-pr-bot copy-pr-bot
Copy link

copy-pr-bot bot commented Jan 28, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@Matt711
Copy link
Contributor Author

Matt711 commented Jan 28, 2025

/ok to test

@Matt711
Copy link
Contributor Author

Matt711 commented Jan 28, 2025

/ok to test

@Matt711 Matt711 added the 3 - Ready for Review Ready for review by team label Jan 29, 2025
@Matt711
Copy link
Contributor Author

Matt711 commented Jan 29, 2025

/ok to test

Matt711
Matt711 commented Jan 29, 2025
View reviewed changes
docs/cudf/source/pylibcudf/index.rst
It aims to match native C++ performance of libcuDF while integrating seamlessly with community protocols like ``__cuda_array_interface__``, and common libraries such as CuPy and Numba.
Both our zero-code pandas accelerator (``cudf.pandas``) and our polars GPU execution engine (``cudf.polars``) are built on top of pylibcuDF.

Ex: Reading data from a parquet file
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let me know if you have an example in mind for the home page @GregoryKimball

wence-
wence- approved these changes Jan 29, 2025
View reviewed changes
Copy link
Contributor

@wence- wence- left a comment

Choose a reason for hiding this comment

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

Some small suggestions for improvement, overall I think this looks good, so approving in its current state.

@Matt711
Copy link
Contributor Author

Matt711 commented Jan 30, 2025

/ok to test

@Matt711
Copy link
Contributor Author

Matt711 commented Jan 30, 2025

/merge

@rapids-bot rapids-bot bot merged commit ca06c39 into rapidsai:branch-25.02 Jan 30, 2025
91 checks passed
@Matt711 Matt711 mentioned this pull request Feb 4, 2025
Merged
3 tasks
rapids-bot bot pushed a commit that referenced this pull request Feb 4, 2025
@Matt711
Fix incorrect example in pylibcudf docs (#17912)
2bada0d 
Fixes incorrect pylibcudf/libcudf example created in #17803.

Authors:
  - Matthew Murray (https://github.com/Matt711)

Approvers:
  - Vyas Ramasubramani (https://github.com/vyasr)

URL: #17912
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wence- wence- wence- approved these changes

@vyasr vyasr Awaiting requested review from vyasr

@GregoryKimball GregoryKimball Awaiting requested review from GregoryKimball

Assignees

@Matt711 Matt711

Labels
3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEA] Make pylibcudf docs more visible
3 participants
@Matt711 @vyasr @wence-