mirror of
https://github.com/vale981/ray
synced 2025-03-07 02:51:39 -05:00
f9b71a8bf6
This PR consolidates both #21667 and #21759 (look there for features), but improves on them in the following way: - [x] we reverted renaming of existing projects `tune`, `rllib`, `train`, `cluster`, `serve`, `raysgd` and `data` so that links won't break. I think my consolidation efforts with the `ray-` prefix were a little overeager in that regard. It's better like this. Only the creation of `ray-core` was a necessity, and some files moved into the `rllib` folder, so that should be relatively benign. - [x] Additionally, we added Algolia `docsearch`, screenshot below. This is _much_ better than our current search. Caveat: there's a sphinx dependency that needs to be replaced (`sphinx-tabs`) by another, newer one (`sphinx-panels`), as the former prevents loading of the `algolia.js` library. Will follow-up in the next PR (hoping this one doesn't get re-re-re-re-reverted).
75 lines
1.7 KiB
ReStructuredText
75 lines
1.7 KiB
ReStructuredText
Data API Reference
|
|
=====================
|
|
|
|
Creating a Dataset
|
|
------------------
|
|
.. autofunction:: ray.data.range
|
|
.. autofunction:: ray.data.range_arrow
|
|
.. autofunction:: ray.data.range_tensor
|
|
.. autofunction:: ray.data.read_csv
|
|
.. autofunction:: ray.data.read_json
|
|
.. autofunction:: ray.data.read_parquet
|
|
.. 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_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
|
|
|
|
.. _dataset-api:
|
|
|
|
Dataset API
|
|
-----------
|
|
|
|
.. autoclass:: ray.data.Dataset
|
|
:members:
|
|
|
|
.. _dataset-pipeline-api:
|
|
|
|
DatasetPipeline API
|
|
-------------------
|
|
|
|
.. autoclass:: ray.data.dataset_pipeline.DatasetPipeline
|
|
:members:
|
|
|
|
GroupedDataset API
|
|
------------------
|
|
|
|
.. autoclass:: ray.data.grouped_dataset.GroupedDataset
|
|
:members:
|
|
|
|
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:
|
|
|
|
Utility
|
|
-------
|
|
.. autofunction:: ray.data.set_progress_bars
|