Add skeleton API and prose documentation for dask-cudf #12725
Conversation
Now with autodoc and some prose.
|
cc: @jacobtomlinson, @beckernick, @quasiben who may have comments on the scope/suggestions. As ever, cross-linking with sphinx is painful, but I think I have it warning free for now. Since most of the docstrings are inherited from dask.dataframe, which in turn pastes them in from pandas, some of the cross-linking takes us off-site. I don't know a good way to fix that really. |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## branch-23.04 #12725 +/- ##
===============================================
Coverage ? 85.81%
===============================================
Files ? 158
Lines ? 25154
Branches ? 0
===============================================
Hits ? 21587
Misses ? 3567
Partials ? 0 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
docs/dask_cudf/source/index.rst
Outdated
| dataframe is already a Dask one or not. If you have a Dask dataframe, | ||
| then :func:`dask_cudf.from_dask_dataframe` will convert for you; if |
There was a problem hiding this comment.
You can also do ddf.to_backend("cudf") now that #12380 was merged :)
There was a problem hiding this comment.
@wence- can you add in a bit about ddf.to_backend("cudf") then we'll merge in
There was a problem hiding this comment.
Done, although the intersphinxing didn't work because dask/dask#10093
| @@ -25,6 +25,7 @@ Top-level conversions | |||
|
|
|||
| cudf.to_numeric | |||
| cudf.from_dlpack | |||
| cudf.from_pandas | |||
There was a problem hiding this comment.
For some reason this has never been linked in the cuDF API docs!
docs/dask_cudf/source/index.rst
Outdated
| dataframe is already a Dask one or not. If you have a Dask dataframe, | ||
| then :func:`dask_cudf.from_dask_dataframe` will convert for you; if |
There was a problem hiding this comment.
Done, although the intersphinxing didn't work because dask/dask#10093
|
/merge |
|
Thanks @wence- ! |
follow up PR for #12725 Authors: - Benjamin Zaitlen (https://github.com/quasiben) - AJ Schmidt (https://github.com/ajschmidt8) Approvers: - GALI PREM SAGAR (https://github.com/galipremsagar) - Sevag H (https://github.com/sevagh) URL: #12982
Description
Start building out documentation for dask-cudf, so that we have something other than the "10 minutes to ..." notebook.
In particular, this provides API documentation, and cross-linking to related projects such as Dask-CUDA.