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.

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

Fix links in Dask cuDF documentation #16929

Merged
merged 5 commits into from
Sep 26, 2024

Conversation

rjzamora
Copy link
Member

More follow-up fixes to the recent Dask-cuDF documentation additions.

@rjzamora rjzamora added doc Documentation non-breaking Non-breaking change labels Sep 26, 2024
@rjzamora rjzamora self-assigned this Sep 26, 2024
Comment on lines -301 to +300
* `Use native cuDF spilling whenever possible <Enable cuDF Spilling>`_
* Use a distributed cluster with `Dask-CUDA <https://docs.rapids.ai/api/dask-cuda/stable/>`__ workers
Copy link
Member Author

Choose a reason for hiding this comment

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

I'm honestly not sure how to properly link to a different section within this page, so I'm just linking to the dask-cuda docs, etc. Happy to revise if others have advice.

Copy link
Contributor

Choose a reason for hiding this comment

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

You can do inter-page links with syntax like this: https://www.sphinx-doc.org/en/master/usage/referencing.html#cross-referencing-syntax. No need to wait for this right now though.

Copy link
Contributor

Choose a reason for hiding this comment

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

I just did that for this page, we can do that more broadly in 24.12

Comment on lines 304 to 306
* Avoid shuffling whenever possible
* Use ``split_out=1`` for low-cardinality groupby aggregations
* Use ``broadcast=True`` for joins when at least one collection comprises a small number of partitions (e.g. ``<=5``)

* Use ``split_out=1`` for low-cardinality groupby aggregations
Copy link
Member Author

Choose a reason for hiding this comment

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

Not completely sure how to get a nested list to render "correctly"

Copy link
Contributor

Choose a reason for hiding this comment

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

Fixed it.

Copy link
Contributor

@galipremsagar galipremsagar left a comment

Choose a reason for hiding this comment

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

I pushed some changes that will not hardcode the version URLs. Approving as the docs links and list now look fine.

@galipremsagar galipremsagar added the 5 - Ready to Merge Testing and reviews complete, ready to merge label Sep 26, 2024
@galipremsagar
Copy link
Contributor

/merge

@rapids-bot rapids-bot bot merged commit 742eaad into rapidsai:branch-24.10 Sep 26, 2024
83 checks passed
@rjzamora
Copy link
Member Author

Thanks so much for your help with this @galipremsagar !

@rjzamora rjzamora deleted the fix-links branch September 27, 2024 00:13
copy-pr-bot bot pushed a commit that referenced this pull request Sep 28, 2024
More follow-up fixes to the recent Dask-cuDF documentation additions.

Authors:
  - Richard (Rick) Zamora (https://github.com/rjzamora)
  - GALI PREM SAGAR (https://github.com/galipremsagar)

Approvers:
  - GALI PREM SAGAR (https://github.com/galipremsagar)
  - Vyas Ramasubramani (https://github.com/vyasr)

URL: #16929
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Ready to Merge Testing and reviews complete, ready to merge doc Documentation non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants