Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[air] Refactor Docs for re-emphasizing libraries (3/n) #36912

Merged
merged 51 commits into from
Jul 27, 2023
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
1618356
remove key concepts and preprocessors
richardliaw Jun 28, 2023
260b9be
move train-check-ingest
richardliaw Jun 28, 2023
8427a37
move serving guide
richardliaw Jun 28, 2023
a741a49
move predictors
richardliaw Jun 28, 2023
edf43b2
toc-consistency
richardliaw Jun 28, 2023
baaf2e7
move train guides
richardliaw Jun 28, 2023
7f89e62
move-toc
richardliaw Jun 28, 2023
3acc2eb
update toc"
richardliaw Jul 18, 2023
8395798
Merge branch 'master' into air-docs-refactor
richardliaw Jul 19, 2023
c7d1320
merge-fail
richardliaw Jul 19, 2023
37c7863
ray
richardliaw Jul 19, 2023
38c2a58
mergefail
richardliaw Jul 19, 2023
8fb86fd
update-paths
richardliaw Jul 19, 2023
f6f2485
fix references
richardliaw Jul 19, 2023
66eb904
unite-checkpoint-ref
richardliaw Jul 19, 2023
34ff37f
cleanup parts
richardliaw Jul 19, 2023
f677d53
Apply suggestions from code review
richardliaw Jul 19, 2023
51129be
orphan a couple files
richardliaw Jul 21, 2023
169b490
orphan the rest and rename
richardliaw Jul 21, 2023
ee1c6b7
Merge branch 'master' into air-docs-refactor
richardliaw Jul 21, 2023
ab7d46e
remove links
richardliaw Jul 21, 2023
75ab720
some-changes
richardliaw Jul 21, 2023
a336985
rmeovespace
richardliaw Jul 21, 2023
f10d085
orphaning
richardliaw Jul 22, 2023
235ac66
chagnes
richardliaw Jul 22, 2023
96b28d7
nit
richardliaw Jul 22, 2023
0f82847
fix
richardliaw Jul 22, 2023
c42b283
air
richardliaw Jul 22, 2023
a1f218c
update
richardliaw Jul 22, 2023
cf47312
fix
richardliaw Jul 22, 2023
6df37ae
fix-stuff
richardliaw Jul 24, 2023
a754732
rename and add section
richardliaw Jul 24, 2023
493235b
Merge branch 'master' into air-docs-refactor
richardliaw Jul 25, 2023
a7d252c
remove extra serve file
richardliaw Jul 25, 2023
3c389e9
merge
richardliaw Jul 25, 2023
240c715
Merge branch 'master' into air-docs-refactor
richardliaw Jul 25, 2023
da0fe77
merge-fail
richardliaw Jul 25, 2023
9c5d032
remove-ecosystem
richardliaw Jul 25, 2023
a2207f1
update
richardliaw Jul 25, 2023
b28c30a
fixup
richardliaw Jul 25, 2023
f93e1bc
Merge branch 'master' into air-docs-refactor
richardliaw Jul 25, 2023
8db8612
remove-label
richardliaw Jul 25, 2023
3785bf4
update-predictors
richardliaw Jul 26, 2023
60f693b
Merge branch 'fix-tests' into air-docs-refactor
richardliaw Jul 26, 2023
229a1d4
update
richardliaw Jul 26, 2023
c3f7738
remove a ton of files
richardliaw Jul 26, 2023
e2b5bc7
Merge branch 'master' into air-docs-refactor
richardliaw Jul 26, 2023
66d3477
update-fix-test
richardliaw Jul 26, 2023
42d0dc2
fixlink
richardliaw Jul 26, 2023
36eaa57
fix-comments
richardliaw Jul 27, 2023
82eea5e
remove-extra
richardliaw Jul 27, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 46 additions & 45 deletions doc/source/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,51 +41,6 @@ parts:
- file: ray-core/examples/map_reduce
- file: ray-core/api/index

- file: ray-air/getting-started
title: "Ray AI Runtime (AIR)"
sections:
- file: ray-air/key-concepts
- file: ray-air/user-guides
sections:
- file: ray-air/preprocessors
- file: ray-air/trainers
- file: ray-air/check-ingest
- file: ray-air/tuner
- file: ray-air/predictors
- file: ray-air/computer-vision
- file: ray-air/examples/serving_guide
- file: ray-air/deployment
- file: ray-air/examples/index
sections:
- file: ray-air/examples/torch_image_example
- file: ray-air/examples/torch_detection
- file: ray-air/examples/convert_existing_pytorch_code_to_ray_air
- file: ray-air/examples/convert_existing_tf_code_to_ray_air
- file: ray-air/examples/tfx_tabular_train_to_serve
- file: ray-air/examples/huggingface_text_classification
- file: ray-air/examples/sklearn_example
- file: ray-air/examples/xgboost_example
- file: ray-air/examples/analyze_tuning_results
- file: ray-air/examples/lightgbm_example
- file: ray-air/examples/torch_incremental_learning
- file: ray-air/examples/rl_serving_example
- file: ray-air/examples/rl_online_example
- file: ray-air/examples/rl_offline_example
- file: ray-air/examples/upload_to_comet_ml
- file: ray-air/examples/upload_to_wandb
- file: ray-air/examples/feast_example
- file: ray-air/examples/automl_with_ray_air
- file: ray-air/examples/batch_tuning
- file: ray-air/examples/batch_forecasting
- file: ray-air/examples/stablediffusion_batch_prediction
- file: ray-air/examples/gptj_deepspeed_fine_tuning
- file: ray-air/examples/gptj_batch_prediction
- file: ray-air/examples/gptj_serving
- file: ray-air/examples/dreambooth_finetuning
- file: ray-air/examples/dolly_lightning_fsdp_finetuning
- file: ray-air/api/api
- file: ray-air/benchmarks

- file: data/data
title: Ray Data
sections:
Expand All @@ -111,10 +66,17 @@ parts:
title: "Configuring Ray Train"
- file: train/dl_guide
title: "Deep Learning Guide"
- file: train/hf_trainers
title: "Hugging Face Trainers"
- file: train/gbdt
title: "XGBoost/LightGBM guide"
- file: train/architecture
title: "Ray Train Architecture"
- file: train/train-with-tune
title: "Using Ray Train with Ray Tune"
- file: train/check-ingest
title: "Configuring Training Datasets"
- file: train/predictors
- file: train/examples
title: "Examples"
sections:
Expand Down Expand Up @@ -282,6 +244,7 @@ parts:
- file: serve/advanced-guides/managing-java-deployments
- file: serve/advanced-guides/migration
- file: serve/advanced-guides/deploy-vm
- file: serve/advanced-guides/from-predictor
- file: serve/architecture
- file: serve/tutorials/index
sections:
Expand Down Expand Up @@ -317,6 +280,44 @@ parts:
- file: rllib/rllib-examples
- file: rllib/package_ref/index

- file: ray-air/getting-started
title: "Ray AIR"
richardliaw marked this conversation as resolved.
Show resolved Hide resolved
sections:
- file: ray-air/user-guides
sections:
- file: ray-air/computer-vision
- file: ray-air/deployment
- file: ray-air/examples/index
sections:
- file: ray-air/examples/opt_deepspeed_batch_inference
- file: ray-air/examples/torch_image_example
- file: ray-air/examples/torch_detection
- file: ray-air/examples/convert_existing_pytorch_code_to_ray_air
- file: ray-air/examples/convert_existing_tf_code_to_ray_air
- file: ray-air/examples/tfx_tabular_train_to_serve
- file: ray-air/examples/huggingface_text_classification
- file: ray-air/examples/sklearn_example
- file: ray-air/examples/xgboost_example
- file: ray-air/examples/analyze_tuning_results
- file: ray-air/examples/lightgbm_example
- file: ray-air/examples/torch_incremental_learning
- file: ray-air/examples/rl_serving_example
- file: ray-air/examples/rl_online_example
- file: ray-air/examples/rl_offline_example
- file: ray-air/examples/upload_to_comet_ml
- file: ray-air/examples/upload_to_wandb
- file: ray-air/examples/feast_example
- file: ray-air/examples/automl_with_ray_air
- file: ray-air/examples/batch_tuning
- file: ray-air/examples/batch_forecasting
- file: ray-air/examples/stablediffusion_batch_prediction
- file: ray-air/examples/gptj_deepspeed_fine_tuning
- file: ray-air/examples/gptj_batch_prediction
- file: ray-air/examples/gptj_serving
- file: ray-air/examples/dreambooth_finetuning
- file: ray-air/examples/dolly_lightning_fsdp_finetuning
- file: ray-air/benchmarks

- file: ray-more-libs/index
title: More Libraries
sections:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Ray AIR provides several common preprocessors out of the box and interfaces to d
Overview
--------

The most common way of using a preprocessor is by passing it as an argument to the constructor of a :ref:`Trainer <air-trainers>` in conjunction with a :ref:`Ray Data <data>`.
The most common way of using a preprocessor is by passing it as an argument to the constructor of a Ray Train :ref:`Trainer <train-getting-started>` in conjunction with a :ref:`Ray Data dataset <data>`.
For example, the following code trains a model with a preprocessor that normalizes the data.

.. literalinclude:: doc_code/preprocessors.py
Expand Down Expand Up @@ -119,7 +119,7 @@ Predictor
A ``Predictor`` can be constructed from a saved ``Checkpoint``. If the ``Checkpoint`` contains a ``Preprocessor``,
then the ``Preprocessor`` calls ``transform_batch`` on input batches prior to performing inference.

In the following example, we show the Batch Predictor flow. The same logic applies to the :ref:`Online Inference flow <air-key-concepts-online-inference>`.
In the following example, we show the Batch Predictor flow.

.. literalinclude:: doc_code/preprocessors.py
:language: python
Expand Down
1 change: 1 addition & 0 deletions doc/source/data/user-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ show you how achieve several tasks.
batch_inference
data-internals
performance-tips
preprocessors
2 changes: 1 addition & 1 deletion doc/source/ray-air/api/checkpoint.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _air-checkpoint-ref:
.. _checkpoint-api-ref:

Ray AIR Checkpoint
==================
Expand Down
8 changes: 4 additions & 4 deletions doc/source/ray-air/computer-vision.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ Training vision models
:dedent:

For more in-depth examples, read :doc:`/ray-air/examples/torch_image_example` and
:ref:`Using Trainers <air-trainers>`.
:ref:`Using Trainers <train-getting-started>`.

.. tab-item:: TensorFlow

Expand All @@ -203,7 +203,7 @@ Training vision models
:end-before: __tensorflow_trainer_stop__
:dedent:

For more information, read :ref:`Using Trainers <air-trainers>`.
For more information, check out :ref:`the Ray Train documentation <train-getting-started>`.

Creating checkpoints
--------------------
Expand Down Expand Up @@ -316,7 +316,7 @@ To NumPy ndarrays like this:
:dedent:

For more in-depth examples, read :doc:`/ray-air/examples/torch_image_example`
and :doc:`/ray-air/examples/serving_guide`.
and :ref:`Ray Serve <serve-getting-started>`

.. tab-item:: TensorFlow

Expand All @@ -336,4 +336,4 @@ To NumPy ndarrays like this:
:end-before: __tensorflow_online_predict_stop__
:dedent:

For more information, read :doc:`/ray-air/examples/serving_guide`.
For more information, see :ref:`Ray Serve <serve-getting-started>`.
19 changes: 18 additions & 1 deletion doc/source/ray-air/examples/automl_with_ray_air.ipynb
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"cells": [
{
"attachments": {},
"cell_type": "markdown",
"id": "596e2463",
"metadata": {},
Expand All @@ -9,6 +10,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "676f0ada",
"metadata": {},
Expand All @@ -21,7 +23,7 @@
"2. Perform temporal cross-validation on each model configuration in parallel.\n",
"3. Pick the best performing model as the output of the AutoML system.\n",
"\n",
"We see that these steps fit into the framework of a hyperparameter optimization problem that can be tackled with the [Ray AIR Tuner](air-tuner)!\n",
"We see that these steps fit into the framework of a hyperparameter optimization problem that can be tackled with [Ray Tune](tune-main)!\n",
"\n",
"In this notebook, we will show how to:\n",
"1. **Create an AutoML system with Ray AIR** for time series forecasting.\n",
Expand All @@ -32,6 +34,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "9e01bef8",
"metadata": {},
Expand All @@ -53,6 +56,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "aff15de3",
"metadata": {},
Expand Down Expand Up @@ -94,6 +98,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "d38cba4c-3984-4c2a-9a01-aefb610b92ce",
"metadata": {},
Expand All @@ -104,6 +109,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "01ee6bbe",
"metadata": {},
Expand Down Expand Up @@ -263,6 +269,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "af8b9544",
"metadata": {},
Expand Down Expand Up @@ -387,6 +394,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "cfbaf59f",
"metadata": {},
Expand All @@ -413,6 +421,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "64c9e1f6",
"metadata": {},
Expand Down Expand Up @@ -458,6 +467,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "36848e64",
"metadata": {},
Expand Down Expand Up @@ -501,6 +511,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "bb8074dc",
"metadata": {},
Expand All @@ -519,6 +530,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "fc695a89",
"metadata": {},
Expand Down Expand Up @@ -554,6 +566,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "3a4e68f5",
"metadata": {},
Expand Down Expand Up @@ -583,6 +596,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "482fd99f",
"metadata": {},
Expand Down Expand Up @@ -611,6 +625,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "cd6099cd",
"metadata": {},
Expand Down Expand Up @@ -677,6 +692,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "cf72f95d",
"metadata": {},
Expand Down Expand Up @@ -739,6 +755,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"id": "6b9af73a",
"metadata": {},
Expand Down
Loading