Doc: interleave columns pandas compat #15383

raybellwaves · 2024-03-25T03:41:03Z

Description

Add a pandas_compat note to DataFrame.interleave_columns

copy-pr-bot · 2024-03-25T03:41:07Z

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.

bdice · 2024-03-25T16:33:29Z

/ok to test

bdice · 2024-03-25T16:34:43Z

python/cudf/cudf/core/dataframe.py

@@ -4379,7 +4379,7 @@ def query(self, expr, local_dict=None):
        1 2018-10-08

        .. pandas-compat::
-            **DataFrame.query**
+            :func:`pandas.DataFrame.query`


We've been just putting the API name in bold and not cross-linking it with intersphinx. I generally like using intersphinx but we'll have to see how it renders. If this change is accepted, would you be willing to make all the other .. pandas-compat:: sections match with an intersphinx reference in a second PR?

If this change is accepted, would you be willing to make all the other .. pandas-compat:: sections match with an intersphinx reference in a second PR?

Should be ok.

~~Any idea why the docs build was skipped? https://github.com/rapidsai/cudf/actions/runs/8423601396/job/23067371447?pr=15383~~
I see a couple of checks failed below so it never made it to docs build
(https://github.com/rapidsai/cudf/actions/runs/8423601396/job/23066700203?pr=15383
conda_build.exceptions.DependencyNeedsBuildingError: Unsatisfiable dependencies for platform linux-aarch64: {MatchSpec("libkvikio=24.06"), MatchSpec("libcudf==24.06.00a39=cuda11_240325_gaf752c6cd0_39"), MatchSpec("rmm=24.06")}

https://github.com/rapidsai/cudf/actions/runs/8423601396/job/23066700960?pr=15383
conda_build.exceptions.DependencyNeedsBuildingError: Unsatisfiable dependencies for platform linux-aarch64: {MatchSpec("rmm=24.06"), MatchSpec("libcudf==24.06.00a39=cuda12_240325_gaf752c6cd0_39"), MatchSpec("libkvikio=24.06")}
)

bdice · 2024-03-26T19:20:04Z

We'll need #15392 to merge to 24.04, then forward-merge 24.04 to 24.06, then merge 24.06 into this PR before the docs will build correctly.

raybellwaves · 2024-03-30T19:38:49Z

Had some issues with the pandas sphinx intermapping as well displaying a mapping in the pandas-compat directive (https://github.com/orgs/sphinx-doc/discussions/12212). I'll open back up if I make any progress

…as-compat

vyasr · 2024-04-17T22:55:55Z

I'm holding off reviewing this until #15531 is in and we know that the pandas intersphinx mapping is working as expected. Happy to pick it back up again afterwards!

raybellwaves · 2024-04-18T02:05:28Z

@vyasr no rush. I think i want to take a look at the pandas-compat sphinx extension first

This PR add pandas to intersphinx mapping to make it easy to link to pandas docs from the RAPIDS docs. There is likely other opportunities to use the pandas intersphinx mapping e.g. #15383 but I think they can be subsequent PRs. I've tested this locally and confirm it works as expected (i.e. the note in the docstring at https://docs.rapids.ai/api/cudf/stable/user_guide/api_docs/api/cudf.dataframe.query/#cudf.DataFrame.query is now hyperlinked to https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.query.html ![Screenshot 2024-04-14 at 2 15 33 AM](https://github.com/rapidsai/cudf/assets/17162724/193076e2-202e-4e74-9305-be1dbcdfa82b) Apologies about the other linting. I can revert if need be Authors: - Ray Bell (https://github.com/raybellwaves) - GALI PREM SAGAR (https://github.com/galipremsagar) - Matthew Roeschke (https://github.com/mroeschke) Approvers: - GALI PREM SAGAR (https://github.com/galipremsagar) URL: #15531

vyasr · 2024-04-20T00:32:38Z

OK sounds good. Now that #15531 is merged feel free to ping again when you think this PR is ready for another look.

…as-compat

raybellwaves · 2024-04-22T01:55:51Z

OK sounds good. Now that #15531 is merged feel free to ping again when you think this PR is ready for another look.

This is ready for review now.

galipremsagar · 2024-04-22T14:37:35Z

/okay to test

wence-

Looks good, thanks!

wence- · 2024-05-02T17:03:22Z

/merge

This PR allows the PandasCompat sphinx ext to contain resolved references. For example, you can now add intersphinx mapping to the content of the admonition. ### Motivation I enjoy connecting the PyData communities and this PR allows for more opportunities to use intersphinx mapping to link back to the pandas docs. ### History I first tried this in a previous PR (#15383 (comment)) and commented here (#15383 (comment)) that I may get around to investigating this further. I finally had to time to work on this and made a bit of progress. ### Testing I created a separate repo for this at https://github.com/raybellwaves/compatsphinxext which deploys straight to https://raybellwaves.github.io/compatsphinxext you can see it's working as expected here: https://raybellwaves.github.io/compatsphinxext/compat.html. You should be able to fork that and tinker pretty quickly. ### Further work This could be cleaned up (for example I couldn't get the [source] to display in the admonition as I worked from the latest sphinx todo extension (https://github.com/sphinx-doc/sphinx/blob/master/sphinx/ext/todo.py)). The existing pandas-compat Admonition's could be switched to this if agreed. In addition, the documentation around how to write pandas-compat entries going forward (https://github.com/rapidsai/cudf/blob/branch-24.06/docs/cudf/source/developer_guide/documentation.md#comparing-to-pandas) will also have to be updated. Longer term the extension could be published and used across RAPIDS libraries where there are differences in compatibility with PyData libraries e.g. pandas, network, scikit-learn to simplify linking to those dos. I'm not sure if I'll have time to work on this though. Authors: - Ray Bell (https://github.com/raybellwaves) - Vyas Ramasubramani (https://github.com/vyasr) Approvers: - Bradley Dice (https://github.com/bdice) URL: #15704

Ray Bell added 2 commits March 24, 2024 23:19

note on pandas conpat in interleave_columns

e89017b

use .to_numpy method

5606d03

raybellwaves requested a review from a team as a code owner March 25, 2024 03:41

raybellwaves requested review from wence- and galipremsagar March 25, 2024 03:41

github-actions bot added the Python Affects Python cuDF API. label Mar 25, 2024

Ray Bell added 2 commits March 24, 2024 23:51

add func link in couple other places

26b237b

use intersphinx mapping at top of doc string

af752c6

bdice added doc Documentation non-breaking Non-breaking change labels Mar 25, 2024

bdice reviewed Mar 25, 2024

View reviewed changes

raybellwaves added 2 commits March 26, 2024 17:03

Merge branch 'branch-24.06' into doc-interleave_columns-pandas-compat

decf24c

Merge branch 'branch-24.06' into doc-interleave_columns-pandas-compat

bff1b7a

raybellwaves marked this pull request as draft March 30, 2024 19:37

raybellwaves mentioned this pull request Apr 9, 2024

[DOC] pandas intersphinx mapping not working #15487

Closed

raybellwaves added 4 commits April 14, 2024 00:38

Merge branch 'rapidsai:branch-24.06' into doc-interleave_columns-pand…

3ff6a60

…as-compat

add correct mapping path and use :meth:

ad37234

switch pandas-compat back in documentation.md

edf4a65

try method

eccb53a

raybellwaves mentioned this pull request Apr 14, 2024

DOC: add pandas intersphinx mapping #15531

Merged

3 tasks

Ray Bell and others added 2 commits April 21, 2024 21:46

apply updated conf

f883248

Merge branch 'rapidsai:branch-24.06' into doc-interleave_columns-pand…

68c2c3d

…as-compat

DOC: add interleave_columns to pandas-compat

aeab0ba

raybellwaves marked this pull request as ready for review April 22, 2024 01:55

Merge branch 'branch-24.06' into doc-interleave_columns-pandas-compat

b1beb32

wence- approved these changes May 2, 2024

View reviewed changes

rapids-bot bot merged commit 6882870 into rapidsai:branch-24.06 May 2, 2024
70 checks passed

raybellwaves mentioned this pull request May 9, 2024

Update PandasCompat.py to resolve references #15704

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc: interleave columns pandas compat #15383

Doc: interleave columns pandas compat #15383

raybellwaves commented Mar 25, 2024 •

edited by wence-

copy-pr-bot bot commented Mar 25, 2024

bdice commented Mar 25, 2024

bdice Mar 25, 2024

raybellwaves Mar 25, 2024 •

edited

bdice commented Mar 26, 2024

raybellwaves commented Mar 30, 2024 •

edited

vyasr commented Apr 17, 2024

raybellwaves commented Apr 18, 2024

vyasr commented Apr 20, 2024 •

edited

raybellwaves commented Apr 22, 2024 •

edited

galipremsagar commented Apr 22, 2024

wence- left a comment

wence- commented May 2, 2024

Doc: interleave columns pandas compat #15383

Doc: interleave columns pandas compat #15383

Conversation

raybellwaves commented Mar 25, 2024 • edited by wence-

Description

copy-pr-bot bot commented Mar 25, 2024

bdice commented Mar 25, 2024

bdice Mar 25, 2024

Choose a reason for hiding this comment

raybellwaves Mar 25, 2024 • edited

Choose a reason for hiding this comment

bdice commented Mar 26, 2024

raybellwaves commented Mar 30, 2024 • edited

vyasr commented Apr 17, 2024

raybellwaves commented Apr 18, 2024

vyasr commented Apr 20, 2024 • edited

raybellwaves commented Apr 22, 2024 • edited

galipremsagar commented Apr 22, 2024

wence- left a comment

Choose a reason for hiding this comment

wence- commented May 2, 2024

raybellwaves commented Mar 25, 2024 •

edited by wence-

raybellwaves Mar 25, 2024 •

edited

raybellwaves commented Mar 30, 2024 •

edited

vyasr commented Apr 20, 2024 •

edited

raybellwaves commented Apr 22, 2024 •

edited