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

Document cudf.read_text and cudf.read_avro. #10638

Merged
merged 3 commits into from
Apr 12, 2022
Merged

Document cudf.read_text and cudf.read_avro. #10638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcd0b3e
Add read_text and read_avro to the documentation.
bdice Apr 11, 2022
6caaf71
Fix read_json in See Also.
bdice Apr 12, 2022
c553660
Remove See Also from read_avro.
bdice Apr 12, 2022
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
14 changes: 12 additions & 2 deletions docs/cudf/source/api_docs/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ CSV
read_csv
DataFrame.to_csv

Text
~~~~
.. autosummary::
:toctree: api/

read_text

.. currentmodule:: cudf.io.json

Expand Down Expand Up @@ -43,8 +49,6 @@ ORC
read_orc
DataFrame.to_orc

.. currentmodule:: cudf
galipremsagar marked this conversation as resolved.
Show resolved Hide resolved

HDFStore: PyTables (HDF5)
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
Expand All @@ -71,3 +75,9 @@ Feather
Feather reader and writers are not GPU accelerated. These currently use CPU via Pandas.
This may be GPU accelerated in the future.

Avro
~~~~
.. autosummary::
:toctree: api/

read_avro
5 changes: 0 additions & 5 deletions python/cudf/cudf/utils/ioutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@
0 10 hello
1 20 rapids
2 30 ai

See Also
--------
cudf.read_csv
cudf.read_json
""".format(
remote_data_sources=_docstring_remote_sources
)
Expand Down