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: use intersphinx mapping in pandas-compat ext #15846

Merged
merged 17 commits into from
Jul 19, 2024
Merged

DOC: use intersphinx mapping in pandas-compat ext #15846

merged 17 commits into from
Jul 19, 2024
+72 −60

Conversation

raybellwaves
Copy link
Contributor

@raybellwaves raybellwaves commented May 23, 2024 •
edited
Loading

If #15704 is merged

This PR changes the header in the admonition (pandas compat box) to be hyperlinked to the pandas docs instead of just text. See https://raybellwaves.github.io/compatsphinxext/compat.html which is the docs of a minimal repo where I have been testing

@raybellwaves raybellwaves requested a review from a team as a code owner May 23, 2024 22:04
@copy-pr-bot copy-pr-bot
Copy link

copy-pr-bot bot commented May 23, 2024

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.

@github-actions github-actions bot added the Python Affects Python cuDF API. label May 23, 2024
@raybellwaves raybellwaves mentioned this pull request May 24, 2024
Closed
@raybellwaves raybellwaves mentioned this pull request Jun 10, 2024
Merged
3 tasks
@bdice bdice changed the base branch from branch-24.06 to branch-24.08 June 10, 2024 19:57
@bdice bdice added doc Documentation non-breaking Non-breaking change labels Jun 10, 2024
@bdice
Copy link
Contributor

bdice commented Jun 10, 2024

/ok to test

bdice
bdice reviewed Jun 10, 2024
View reviewed changes
Copy link
Contributor

@bdice bdice 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 one suggestion.

python/cudf/cudf/core/column/lists.py Outdated Show resolved Hide resolved
@charlesbluca charlesbluca added the 0 - Waiting on Author Waiting for author to respond to review label Jun 13, 2024
@bdice
Copy link
Contributor

bdice commented Jul 7, 2024

/ok to test

@raybellwaves
Copy link
Contributor Author

Apologies for lack of response here. Using this comments to give an update on where I am with this. The goal here is to switch https://docs.rapids.ai/api/cudf/stable/user_guide/pandascompat/ to the use the new sphinx extension which links back to pandas docs.

I've listed the changes that have to be made (we may as well try and get them in one sweep) by listing the order they appear in https://docs.rapids.ai/api/cudf/stable/user_guide/pandascompat/. A check means the changes render as expected. An empty box means a note is missing.

Looking at the list below there are quite a few dups. I'll look to see if I can remove those before continuing here.

  • DataFrame.transpose, DataFrame.T
  • DataFrame.agg
  • DataFrame.all, Series.all
  • DataFrame.any, Series.any
  • DataFrame.count
  • DataFrame.diff
  • DataFrame.empty, Series.empty
  • DataFrame.eval
  • DataFrame.from_arrow
  • DataFrame.interleave_columns
  • DataFrame.join
  • DataFrame.kurtosis
  • DataFrame.kurtosis (not sure why this appears twice)
  • DataFrame.max, Series.max
  • DataFrame.median, Series.median
  • DataFrame.merge
  • DataFrame.min, Series.min
  • DataFrame.mode
  • DataFrame.nlargest
  • DataFrame.nsmallest
  • DataFrame.product, Series.product
  • DataFrame.product, Series.product (not sure why this appears twice)
  • DataFrame.quantile
  • DataFrame.query
  • DataFrame.reindex
  • DataFrame.rename
  • DataFrame.replace, Series.replace
  • DataFrame.resample, Series.resample
  • DataFrame.sample, Series.sample
  • DataFrame.skew, Series.skew, Frame.skew
  • DataFrame.sort_index, Series.sort_index
  • DataFrame.sort_values, Series.sort_values
  • DataFrame.std, Series.std
  • DataFrame.sum, Series.sum
  • DataFrame.transpose, DataFrame.T
  • DataFrame.truncate, Series.truncate
  • DataFrame.var, Series.var
  • DataFrame.where, Series.where
  • DataFrame.all, Series.all
  • DataFrame.any, Series.any (not sure why this appears twice)
  • DataFrame.max, Series.max (not sure why this appears twice)
  • DataFrame.min, Series.min (not sure why this appears twice)
  • DataFrame.where, Series.where
  • DataFrame.all, Series.all (not sure why this appears twice)
  • DataFrame.any, Series.any (not sure why this appears twice)
  • Series.count
  • Series.cov
  • DataFrame.empty, Series.empty
  • DataFrame.kurtosis (not sure they appears three times)
  • DataFrame.kurtosis (not sure they appears four times)
  • Series.map
  • DataFrame.max, Series.max (not sure why this appears three times)
  • DataFrame.median, Series.median (not sure why this appears twice)
  • DataFrame.min, Series.min (not sure why this appears three times)
  • DataFrame.product, Series.product (not sure why this appears three times)
  • DataFrame.product, Series.product (not sure why this appears four times)
  • Series.reindex
  • Series.rename
  • DataFrame.replace, Series.replace (not sure why this appears twice)
  • DataFrame.resample, Series.resample (not sure why this appears twice)
  • DataFrame.sample, Series.sample (not sure why this appears twice)
  • DataFrame.skew, Series.skew, Frame.skew
  • DataFrame.sort_index, Series.sort_index (not sure why this appears twice)
  • Series.sort_values
  • DataFrame.std, Series.std (not sure why this appears twice)
  • DataFrame.sum, Series.sum (not sure why this appears twice)
  • DataFrame.truncate, Series.truncate
  • DataFrame.var, Series.var
  • DataFrame.where, Series.where (not sure why this appears three times)
  • ListMethods.sort_values
  • StringMethods.contains
  • StringMethods.count
  • StringMethods.endswith
  • StringMethods.extract
  • StringMethods.findall
  • StringMethods.match
  • StringMethods.partition
  • StringMethods.replace
  • DataFrameGroupBy.idxmax
  • DataFrameGroupBy.idxmin
  • DataFrameGroupBy.nunique
  • GroupBy.shift
  • GroupBy.apply
  • GroupBy.first
  • GroupBy.idxmax
  • GroupBy.idxmin
  • GroupBy.last
  • GroupBy.max
  • GroupBy.mean
  • GroupBy.median
  • GroupBy.min
  • GroupBy.nunique
  • GroupBy.prod
  • GroupBy.shift
  • GroupBy.sum
  • GroupBy.nunique
  • series.DatetimeProperties.strftime
  • DataFrame.merge
  • cudf.to_numeric

@raybellwaves raybellwaves mentioned this pull request Jul 11, 2024
Closed
@bdice
Copy link
Contributor

bdice commented Jul 11, 2024

@raybellwaves I merged in the upstream a few days ago to check on the CI output. There were a few failures in the previous doc build (logs link):

/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.T:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty

/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.from_arrow:40: WARNING: py:meth reference target not found: pandas.DataFrame.from_arrow
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.interleave_columns:17: WARNING: py:meth reference target not found: pandas.DataFrame.interleave_columns
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.transpose:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/column/lists.py:docstring of cudf.core.column.lists.ListMethods.sort_values:41: WARNING: py:meth reference target not found: pandas.Series.list.sort_values
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/tools/numeric.py:docstring of cudf.core.tools.numeric.to_numeric:78: WARNING: py:meth reference target not found: pandas.to_numeric
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.T:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.from_arrow:40: WARNING: py:meth reference target not found: pandas.DataFrame.from_arrow
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.interleave_columns:17: WARNING: py:meth reference target not found: pandas.DataFrame.interleave_columns
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.transpose:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/column/lists.py:docstring of cudf.core.column.lists.ListMethods.sort_values:41: WARNING: py:meth reference target not found: pandas.Series.list.sort_values
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/tools/numeric.py:docstring of cudf.core.tools.numeric.to_numeric:78: WARNING: py:meth reference target not found: pandas.to_numeric

I see you broke off #16258, but I would be happy to merge this PR with a larger set of changes if you can fix those docs errors. If you need help fixing the docs errors, please ask!

@raybellwaves
Copy link
Contributor Author

@raybellwaves I merged in the upstream a few days ago to check on the CI output. There were a few failures in the previous doc build (logs link):

/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.T:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty

/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.from_arrow:40: WARNING: py:meth reference target not found: pandas.DataFrame.from_arrow
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.interleave_columns:17: WARNING: py:meth reference target not found: pandas.DataFrame.interleave_columns
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.transpose:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/column/lists.py:docstring of cudf.core.column.lists.ListMethods.sort_values:41: WARNING: py:meth reference target not found: pandas.Series.list.sort_values
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/tools/numeric.py:docstring of cudf.core.tools.numeric.to_numeric:78: WARNING: py:meth reference target not found: pandas.to_numeric
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.T:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.DataFrame.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.from_arrow:40: WARNING: py:meth reference target not found: pandas.DataFrame.from_arrow
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.interleave_columns:17: WARNING: py:meth reference target not found: pandas.DataFrame.interleave_columns
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/dataframe.py:docstring of cudf.core.dataframe.DataFrame.transpose:12: WARNING: py:meth reference target not found: pandas.DataFrame.T
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.DataFrame.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/series.py:docstring of cudf.Series.empty:64: WARNING: py:meth reference target not found: pandas.Series.empty
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/column/lists.py:docstring of cudf.core.column.lists.ListMethods.sort_values:41: WARNING: py:meth reference target not found: pandas.Series.list.sort_values
/opt/conda/envs/docs/lib/python3.11/site-packages/cudf/core/tools/numeric.py:docstring of cudf.core.tools.numeric.to_numeric:78: WARNING: py:meth reference target not found: pandas.to_numeric

I see you broke off #16258, but I would be happy to merge this PR with a larger set of changes if you can fix those docs errors. If you need help fixing the docs errors, please ask!

Sounds good.

@raybellwaves
Copy link
Contributor Author

Should be ready to test again

@mroeschke
Copy link
Contributor

/ok to test

@raybellwaves
Copy link
Contributor Author

i'm still missingcudf.core.window.ExponentialMovingWindow

@raybellwaves
Copy link
Contributor Author

raybellwaves commented Jul 12, 2024 •
edited
Loading

should be ready to test again. Apologies for the multiple commits

Looks okay locally:

Screenshot 2024-07-11 at 8 06 08 PM

@bdice
Copy link
Contributor

bdice commented Jul 12, 2024

/ok to test

@vyasr
Copy link
Contributor

vyasr commented Jul 15, 2024

/ok to test

vyasr
vyasr approved these changes Jul 19, 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.

Looks great, thanks!

@vyasr
Copy link
Contributor

vyasr commented Jul 19, 2024

/merge

@rapids-bot rapids-bot bot merged commit 2bbeee9 into rapidsai:branch-24.08 Jul 19, 2024
79 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charlesbluca charlesbluca charlesbluca left review comments

@bdice bdice bdice left review comments

@vyasr vyasr vyasr approved these changes

@mroeschke mroeschke Awaiting requested review from mroeschke mroeschke is a code owner automatically assigned from rapidsai/cudf-python-codeowners

Assignees
No one assigned
Labels
0 - Waiting on Author Waiting for author to respond to review doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
cuDF/Dask/Numba/UCX
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@raybellwaves @bdice @mroeschke @vyasr @charlesbluca