ray/doc/source/data/user-guide.rst

.. _data_user_guide :

===========
User Guides
===========

If you’re new to Ray Datasets, we recommend starting with the :ref:`Ray Datasets Quick Start <datasets_getting_started>`.
This user guide will help you navigate the Ray Datasets project and show you how achieve several tasks.

.. toctree::
    :maxdepth: 2

    creating-datasets
    transforming-datasets
    consuming-datasets
    dataset-ml-preprocessing
    dataset-tensor-support
    pipelining-compute
    dataset-internals
    performance-tips
-												[Docs] Ray Data docs target state (#21931)

Preview: [docs](https://ray--21931.org.readthedocs.build/en/21931/data/dataset.html)

The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have

- [x] A Getting Started Guide
- [x] An explicit User / How-To Guide
- [x] A dedicated Key Concepts page
- [x] A consistent naming convention in `Ray Data` whenever is is referred to the project.

This surfaces quite clearly that, apart from the "Getting Started" sections, we really only have one real example. Once we have more, we can create an "Example" section like many other sub-projects have. This will be addressed in https://github.com/ray-project/ray/issues/21838.
											
										
										
											2022-01-27 22:14:36 +01:00
+								.. _data_user_guide :
 								===========
 								User Guides
 								===========
-												Revamp the Getting Started page for Dataset (#24860)

This is part of the Dataset GA doc fix effort to update/improve the documentation.
This PR revamps the Getting Started page.

What are the changes:
- Focus on basic/core features that are bread-and-butter for users, leave the advanced features out
- Focus on high level introduction, leave the detailed spec out (e.g. what are possible batch_types for map_batches() API)
- Use more realistic (yet still simple) data example that's familiar to people (IRIS dataset in this case)
- Use the same data example throughout to make it context-switch free
- Use runnable code rather than faked
- Reference to the code from doc, instead of inlining them in the doc

Co-authored-by: Ubuntu <ubuntu@ip-172-31-32-136.us-west-2.compute.internal>
Co-authored-by: Eric Liang <ekhliang@gmail.com>
											
										
										
											2022-05-18 13:46:23 -07:00
+								If you’re new to Ray Datasets, we recommend starting with the :ref:`Ray Datasets Quick Start <datasets_getting_started>`.
-												[docs] Editing pass over Dataset docs (#26935)


											
										
										
											2022-07-24 19:48:29 -07:00
+								This user guide will help you navigate the Ray Datasets project and show you how achieve several tasks.
-												[Docs] Ray Data docs target state (#21931)

Preview: [docs](https://ray--21931.org.readthedocs.build/en/21931/data/dataset.html)

The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have

- [x] A Getting Started Guide
- [x] An explicit User / How-To Guide
- [x] A dedicated Key Concepts page
- [x] A consistent naming convention in `Ray Data` whenever is is referred to the project.

This surfaces quite clearly that, apart from the "Getting Started" sections, we really only have one real example. Once we have more, we can create an "Example" section like many other sub-projects have. This will be addressed in https://github.com/ray-project/ray/issues/21838.
											
										
										
											2022-01-27 22:14:36 +01:00
 								.. toctree::
 								    :maxdepth: 2
-												[Dataset GA doc] Decompose the monolith of Getting Started page (and get them under User Guide) (#23311)

Improve the Dataset documentation for GA.
											
										
										
											2022-03-18 11:25:43 -07:00
+								    creating-datasets
 								    transforming-datasets
-												[docs] Editing pass over Dataset docs (#26935)


											
										
										
											2022-07-24 19:48:29 -07:00
+								    consuming-datasets
-												[Docs] Ray Data docs target state (#21931)

Preview: [docs](https://ray--21931.org.readthedocs.build/en/21931/data/dataset.html)

The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have

- [x] A Getting Started Guide
- [x] An explicit User / How-To Guide
- [x] A dedicated Key Concepts page
- [x] A consistent naming convention in `Ray Data` whenever is is referred to the project.

This surfaces quite clearly that, apart from the "Getting Started" sections, we really only have one real example. Once we have more, we can create an "Example" section like many other sub-projects have. This will be addressed in https://github.com/ray-project/ray/issues/21838.
											
										
										
											2022-01-27 22:14:36 +01:00
+								    dataset-ml-preprocessing
 								    dataset-tensor-support
-												[docs] Editing pass over Dataset docs (#26935)


											
										
										
											2022-07-24 19:48:29 -07:00
+								    pipelining-compute
 								    dataset-internals
-												[Docs] Ray Data docs target state (#21931)

Preview: [docs](https://ray--21931.org.readthedocs.build/en/21931/data/dataset.html)

The Ray Data project's docs now have a clearer structure and have partly been rewritten/modified. In particular we have

- [x] A Getting Started Guide
- [x] An explicit User / How-To Guide
- [x] A dedicated Key Concepts page
- [x] A consistent naming convention in `Ray Data` whenever is is referred to the project.

This surfaces quite clearly that, apart from the "Getting Started" sections, we really only have one real example. Once we have more, we can create an "Example" section like many other sub-projects have. This will be addressed in https://github.com/ray-project/ray/issues/21838.
											
										
										
											2022-01-27 22:14:36 +01:00
+								    performance-tips