Skip to content

Commit

Permalink
Document cudf.read_text and cudf.read_avro. (#10638)
Browse files Browse the repository at this point in the history
This adds documentation for `cudf.read_text` and `cudf.read_avro`.

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - GALI PREM SAGAR (https://github.com/galipremsagar)
  - Vukasin Milovanovic (https://github.com/vuule)

URL: #10638
  • Loading branch information
bdice authored Apr 12, 2022
1 parent 09b080d commit 3c13ef1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
14 changes: 12 additions & 2 deletions docs/cudf/source/api_docs/io.rst
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

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
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

0 comments on commit 3c13ef1

Please sign in to comment.