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

Doc: interleave columns pandas compat #15383

Merged
merged 14 commits into from
May 2, 2024
Merged

Doc: interleave columns pandas compat #15383

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e89017b
note on pandas conpat in interleave_columns
Mar 25, 2024
5606d03
use .to_numpy method
Mar 25, 2024
26b237b
add func link in couple other places
Mar 25, 2024
af752c6
use intersphinx mapping at top of doc string
Mar 25, 2024
decf24c
Merge branch 'branch-24.06' into doc-interleave_columns-pandas-compat
raybellwaves Mar 26, 2024
bff1b7a
Merge branch 'branch-24.06' into doc-interleave_columns-pandas-compat
raybellwaves Mar 30, 2024
3ff6a60
Merge branch 'rapidsai:branch-24.06' into doc-interleave_columns-pand…
raybellwaves Apr 14, 2024
ad37234
add correct mapping path and use :meth:
raybellwaves Apr 14, 2024
edf4a65
switch pandas-compat back in documentation.md
raybellwaves Apr 14, 2024
eccb53a
try method
raybellwaves Apr 14, 2024
f883248
apply updated conf
Apr 22, 2024
68c2c3d
Merge branch 'rapidsai:branch-24.06' into doc-interleave_columns-pand…
raybellwaves Apr 22, 2024
aeab0ba
DOC: add interleave_columns to pandas-compat
Apr 22, 2024
b1beb32
Merge branch 'branch-24.06' into doc-interleave_columns-pandas-compat
galipremsagar Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cudf/source/developer_guide/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ The directive should be used inside docstrings like so:
Docstring body

.. pandas-compat::
**$API_NAME**
:func:`pandas.API_NAME`

Explanation of differences
```
Expand Down
8 changes: 6 additions & 2 deletions python/cudf/cudf/core/dataframe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4320,7 +4320,7 @@ def query(self, expr, local_dict=None):
"""
Query with a boolean expression using Numba to compile a GPU kernel.

See pandas.DataFrame.query.
See :func:`pandas.DataFrame.query`.

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

.. pandas-compat::
**DataFrame.query**
:func:`pandas.DataFrame.query`
Copy link
Contributor

Choose a reason for hiding this comment

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

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?

Copy link
Contributor Author

@raybellwaves raybellwaves Mar 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

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")}
)


One difference from pandas is that ``query`` currently only
supports numeric, datetime, timedelta, or bool dtypes.
Expand Down Expand Up @@ -7541,6 +7541,10 @@ def interleave_columns(self):
Returns
-------
The interleaved columns as a single column

.. pandas-compat::
This method does not exist in pandas but it can be run
as `pd.Series(np.vstack(df.to_numpy()).reshape((-1,)))`.
"""
if ("category" == self.dtypes).any():
raise ValueError(
Expand Down
Loading