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

[REVIEW] Add IO docs page in cudf documentation #9145

Merged
merged 2 commits into from
Aug 31, 2021
Merged

[REVIEW] Add IO docs page in cudf documentation #9145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71d0077
add IO docs page.
galipremsagar Aug 30, 2021
e3be240
add IO docs page.
galipremsagar Aug 30, 2021
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
1 change: 1 addition & 0 deletions docs/cudf/source/api_docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ This page provides a list of all publicly accessible modules, methods and classe
general_functions
general_utilities
window
io

72 changes: 72 additions & 0 deletions docs/cudf/source/api_docs/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
.. _api.io:

============
Input/output
============
.. currentmodule:: cudf

CSV
~~~
.. autosummary::
:toctree: api/

read_csv
DataFrame.to_csv


.. currentmodule:: cudf.io.json

JSON
~~~~
.. autosummary::
:toctree: api/

read_json
to_json

.. currentmodule:: cudf

Parquet
~~~~~~~
.. autosummary::
:toctree: api/

read_parquet
DataFrame.to_parquet

ORC
~~~
.. autosummary::
:toctree: api/

read_orc
DataFrame.to_orc

.. currentmodule:: cudf

HDFStore: PyTables (HDF5)
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

read_hdf
DataFrame.to_hdf

.. warning::

HDF reader and writers are not GPU accelerated. These currently use CPU via Pandas.
This may be GPU accelerated in the future.

Feather
~~~~~~~
.. autosummary::
:toctree: api/

read_feather
DataFrame.to_feather

.. warning::

Feather reader and writers are not GPU accelerated. These currently use CPU via Pandas.
This may be GPU accelerated in the future.

2 changes: 1 addition & 1 deletion python/cudf/cudf/utils/ioutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -904,7 +904,7 @@

See Also
--------
cudf.to_csv
cudf.io.csv.to_csv
""".format(
remote_data_sources=_docstring_remote_sources
)
Expand Down