mirror of
https://github.com/vale981/ray
synced 2025-03-06 02:21:39 -05:00
9a0c1f5e0a
Refactor Datasets API docs for easier navigation: [Ray Datasets API](https://ray--27592.org.readthedocs.build/en/27592/data/api/api.html) ### Changes 1. Create a new Datasets API base page. 2. Split existing APIs into separate pages. 3. Split `Dataset` and `DatasetPipeline` methods into separate sections. 1. Used `autosummary` to generate overview tables at the top of each of these pages. Open to other suggestions e.g. moving the summary to the top of each section instead. 2. **Note:** Every time we add a new method we need to explicitly add it here as well. 4. Add Input/Output APIs. 1. I chose to split these primarily by data format rather than type, since it's easier to navigate, and the existing [Creating Datasets](https://docs.ray.io/en/master/data/creating-datasets.html) User Guide already does the latter. 6. Add `Block` and `DataBatch` (should we add these aliases?) 7. Remove existing `package-ref`. |
||
|---|---|---|
| .. | ||
| api.rst | ||
| data_representations.rst | ||
| dataset.rst | ||
| dataset_context.rst | ||
| dataset_pipeline.rst | ||
| grouped_dataset.rst | ||
| input_output.rst | ||
| random_access_dataset.rst | ||
| utility.rst | ||