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

Jump to bottom

DOC: Add documentation for cudf.pandas in the Developer Guide #15889

Merged
merged 4 commits into from
Jun 5, 2024
Merged

DOC: Add documentation for cudf.pandas in the Developer Guide #15889

merged 4 commits into from
Jun 5, 2024

Conversation

Matt711
Copy link
Contributor

@Matt711 Matt711 commented May 30, 2024 •
edited
Loading

Description

This PR provides documentation for cudf.pandas in the Developer Guide. It will describe the fast-slow proxy wrapping scheme as well as document the CUDF_PANDAS_DEBUGGING environment variable created in PR #15837 for issue #14975.

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 self-assigned this May 30, 2024
@Matt711 Matt711 added doc Documentation cudf.pandas Issues specific to cudf.pandas labels May 30, 2024
@Matt711 Matt711 requested a review from wence- May 30, 2024 15:47
@Matt711 Matt711 added the non-breaking Non-breaking change label May 30, 2024
@Matt711 Matt711 force-pushed the doc/cudf-pandas-dev-guide branch from f272e01 to 3e44e32 Compare June 3, 2024 19:39
@Matt711 Matt711 marked this pull request as ready for review June 3, 2024 19:40
@Matt711 Matt711 requested review from a team and isVoid and removed request for a team and isVoid June 3, 2024 19:40
vyasr
vyasr requested changes Jun 3, 2024
View reviewed changes
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

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

Thanks for adding this! These docs will be super helpful for future devs.

Can you reflow the lines? We generally aim for one sentence per line.

docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
@github-actions github-actions bot removed the cudf.pandas Issues specific to cudf.pandas label Jun 4, 2024
@Matt711 Matt711 added cudf.pandas Issues specific to cudf.pandas 3 - Ready for Review Ready for review by team labels Jun 4, 2024
vyasr
vyasr approved these changes Jun 4, 2024
View reviewed changes
Copy link
Contributor

@vyasr vyasr left a comment

Choose a reason for hiding this comment

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

I have a number of suggestions for improvement, but they're largely small and/or cosmetic so I'm going ahead and approving now. Feel free to merge once you've addressed them. Thanks for this! It'll definitely be valuable.

docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
wence-
wence- requested changes Jun 5, 2024
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.

Thanks @Matt711 this is a great start. I had, like Vyas, a few wording suggestions. The longer ones are probably for discussion rather than just accepting as is...

docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Outdated Show resolved Hide resolved
docs/cudf/source/developer_guide/cudf_pandas.md Show resolved Hide resolved
@github-actions github-actions bot removed the cudf.pandas Issues specific to cudf.pandas label Jun 5, 2024
@Matt711 Matt711 added the cudf.pandas Issues specific to cudf.pandas label Jun 5, 2024
@Matt711
Copy link
Contributor Author

Matt711 commented Jun 5, 2024

/merge

@rapids-bot rapids-bot bot merged commit 20aa444 into rapidsai:branch-24.08 Jun 5, 2024
70 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vyasr vyasr vyasr approved these changes

@wence- wence- wence- approved these changes

Assignees

@Matt711 Matt711

Labels
3 - Ready for Review Ready for review by team cudf.pandas Issues specific to cudf.pandas doc Documentation non-breaking Non-breaking change
Projects
cuDF Python
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Matt711 @wence- @vyasr