mirror of
https://github.com/vale981/ray
synced 2025-03-06 10:31:39 -05:00
8d5c07b781
This PR adds a user guide to AIR for using Ray Train. It provides a high level overview of the trainers and removes redundant sections. The main file to review is here: doc/source/ray-air/trainer.rst. Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com> Signed-off-by: Richard Liaw <rliaw@berkeley.edu> Signed-off-by: Kai Fricke <kai@anyscale.com> Co-authored-by: Richard Liaw <rliaw@berkeley.edu> Co-authored-by: Kai Fricke <kai@anyscale.com>
71 lines
1.6 KiB
ReStructuredText
71 lines
1.6 KiB
ReStructuredText
.. _train-examples:
|
|
|
|
Ray Train Examples
|
|
==================
|
|
|
|
.. Example .rst files should be organized in the same manner as the
|
|
.py files in ray/python/ray/train/examples.
|
|
|
|
Below are examples for using Ray Train with a variety of models, frameworks,
|
|
and use cases.
|
|
|
|
General Examples
|
|
----------------
|
|
|
|
PyTorch
|
|
~~~~~~~
|
|
|
|
* :doc:`/train/examples/torch_fashion_mnist_example`:
|
|
End-to-end example for PyTorch.
|
|
|
|
* :doc:`/train/examples/transformers/transformers_example`:
|
|
End-to-end example for HuggingFace Transformers (PyTorch).
|
|
|
|
TensorFlow
|
|
~~~~~~~~~~
|
|
|
|
* :doc:`/train/examples/tensorflow_mnist_example`:
|
|
End-to-end example for TensorFlow
|
|
|
|
Horovod
|
|
~~~~~~~
|
|
|
|
* :doc:`/train/examples/horovod/horovod_example`:
|
|
End-to-end example for Horovod (with PyTorch)
|
|
|
|
|
|
Logger/Callback Examples
|
|
------------------------
|
|
* :doc:`/train/examples/mlflow_fashion_mnist_example`:
|
|
Example for logging training to MLflow via the ``MLflowLoggerCallback``
|
|
|
|
|
|
Ray Tune Integration Examples
|
|
-----------------------------
|
|
|
|
* :doc:`/train/examples/tune_tensorflow_mnist_example`:
|
|
End-to-end example for tuning a TensorFlow model.
|
|
|
|
* :doc:`/train/examples/tune_cifar_torch_pbt_example`:
|
|
End-to-end example for tuning a PyTorch model with PBT.
|
|
|
|
..
|
|
TODO implement these examples!
|
|
|
|
Features
|
|
--------
|
|
|
|
* Example for using a custom callback
|
|
* End-to-end example for running on an elastic cluster (elastic training)
|
|
|
|
Models
|
|
------
|
|
|
|
* Example training on Vision model.
|
|
|
|
Benchmarks
|
|
----------
|
|
|
|
* :doc:`/train/examples/torch_data_prefetch_benchmark/benchmark_example`:
|
|
Benchmark example for the PyTorch data transfer auto pipeline.
|
|
|