.. _data_api:

Ray Datasets API
================

Creating Datasets
-----------------

.. autofunction:: ray.data.range
.. autofunction:: ray.data.range_table
.. autofunction:: ray.data.range_tensor
.. 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
.. autofunction:: ray.data.read_datasource
.. autofunction:: ray.data.from_items
.. autofunction:: ray.data.from_arrow
.. autofunction:: ray.data.from_arrow_refs
.. autofunction:: ray.data.from_huggingface
.. autofunction:: ray.data.from_spark
.. autofunction:: ray.data.from_dask
.. autofunction:: ray.data.from_modin
.. autofunction:: ray.data.from_mars
.. autofunction:: ray.data.from_pandas
.. autofunction:: ray.data.from_pandas_refs
.. autofunction:: ray.data.from_numpy
.. autofunction:: ray.data.from_numpy_refs

.. _dataset-api:

Dataset API
-----------

.. autoclass:: ray.data.Dataset
    :members:

.. _dataset-pipeline-api:

Block API
---------

.. autoclass:: ray.data.block.BlockExecStats
    :members:

.. autoclass:: ray.data.block.BlockMetadata
    :members:

.. autoclass:: ray.data.block.BlockAccessor
    :members:

DatasetContext API
------------------

.. autoclass:: ray.data.context.DatasetContext
    :members:

DatasetPipeline API
-------------------

.. autoclass:: ray.data.dataset_pipeline.DatasetPipeline
    :members:

GroupedDataset API
------------------

.. autoclass:: ray.data.grouped_dataset.GroupedDataset
    :members:

Aggregate API
-------------

.. autoclass:: ray.data.aggregate.AggregateFn
    :members:

.. autoclass:: ray.data.aggregate.Count
    :members:

.. autoclass:: ray.data.aggregate.Sum
    :members:

.. autoclass:: ray.data.aggregate.Max
    :members:

.. autoclass:: ray.data.aggregate.Mean
    :members:

.. autoclass:: ray.data.aggregate.Std
    :members:

.. autoclass:: ray.data.aggregate.AbsMax
    :members:

RandomAccessDataset API
-----------------------

.. autoclass:: ray.data.random_access_dataset.RandomAccessDataset
    :members:

.. _dataset-tensor-extension-api:

Tensor Column Extension API
---------------------------

.. autoclass:: ray.data.extensions.tensor_extension.TensorDtype
    :members:

.. autoclass:: ray.data.extensions.tensor_extension.TensorArray
    :members:

.. autoclass:: ray.data.extensions.tensor_extension.ArrowTensorType
    :members:

.. autoclass:: ray.data.extensions.tensor_extension.ArrowTensorArray
    :members:

Custom Datasource API
---------------------

.. autoclass:: ray.data.Datasource
    :members:

.. autoclass:: ray.data.ReadTask
    :members:

Datasource Partitioning API
---------------------------

.. autoclass:: ray.data.datasource.PartitionStyle
    :members:

.. autoclass:: ray.data.datasource.PathPartitionScheme
    :members:

.. autoclass:: ray.data.datasource.PathPartitionEncoder
    :members:

.. autoclass:: ray.data.datasource.PathPartitionParser
    :members:

.. autoclass:: ray.data.datasource.PathPartitionFilter

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

.. autoclass:: ray.data.datasource.BinaryDatasource
    :members:

.. autoclass:: ray.data.datasource.CSVDatasource
    :members:

.. autoclass:: ray.data.datasource.FileBasedDatasource
    :members:

.. autoclass:: ray.data.datasource.ImageFolderDatasource

.. autoclass:: ray.data.datasource.JSONDatasource
    :members:

.. autoclass:: ray.data.datasource.NumpyDatasource
    :members:

.. autoclass:: ray.data.datasource.ParquetDatasource
    :members:

.. autoclass:: ray.data.datasource.RangeDatasource
    :members:

.. autoclass:: ray.data.datasource.SimpleTensorFlowDatasource
    :members:

.. autoclass:: ray.data.datasource.SimpleTorchDatasource
    :members:

Table Row API
---------------------

.. autoclass:: ray.data.row.TableRow
    :members:

Utility
-------
.. autofunction:: ray.data.set_progress_bars