Skip to content

Commit

Permalink
[Datasets] Add documentation for bulk parquet read API and file metad…
Browse files Browse the repository at this point in the history
…ata providers. (#24354)

API doc updates for #23179 and #24094. All data docs related to #23179 should be up-to-date once this PR and #24203 are merged.
  • Loading branch information
pdames authored May 12, 2022
1 parent 42e877d commit e2ee214
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/source/data/package-ref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Creating Datasets
.. autofunction:: ray.data.read_csv
.. autofunction:: ray.data.read_json
.. autofunction:: ray.data.read_parquet
.. autofunction:: ray.data.read_parquet_bulk
.. autofunction:: ray.data.read_numpy
.. autofunction:: ray.data.read_text
.. autofunction:: ray.data.read_binary_files
Expand Down Expand Up @@ -123,6 +124,18 @@ Custom Datasource API
.. autoclass:: ray.data.ReadTask
:members:

Datasource File Metadata API
---------------------

.. autoclass:: ray.data.datasource.FileMetadataProvider
:members:

.. autoclass:: ray.data.datasource.BaseFileMetadataProvider
:members:

.. autoclass:: ray.data.datasource.ParquetMetadataProvider
:members:

Built-in Datasources
--------------------

Expand Down

0 comments on commit e2ee214

Please sign in to comment.