mirror of
https://github.com/vale981/ray
synced 2025-03-09 21:06:39 -04:00
380a653787
* [SGD] update SGDv2 user guide docs * Update doc/source/raysgd/v2/user_guide.rst Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> * add new line * update docs * fix header line length * lint * lint * lint * lint * fix remaining lint issues * Update doc/source/raysgd/v2/user_guide.rst Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com> * Update doc/source/raysgd/v2/user_guide.rst Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com> * address comments * address comments * add TODO for iterator API * Update doc/source/raysgd/v2/user_guide.rst Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com> * address comments * address comments * add tune doc * restructure table of contents * add examples; rename example files to include example suffix * add quick start, porting code * address comments Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Amog Kamsetty <amogkam@users.noreply.github.com>
76 lines
1.7 KiB
ReStructuredText
76 lines
1.7 KiB
ReStructuredText
.. _sgd-v2-examples:
|
|
|
|
RaySGD Examples
|
|
===============
|
|
|
|
.. Example .rst files should be organized in the same manner as the
|
|
.py files in ray/python/ray/util/sgd/v2/examples.
|
|
|
|
Below are examples for using RaySGD with a variety of models, frameworks, and use cases.
|
|
|
|
General Examples
|
|
----------------
|
|
|
|
PyTorch
|
|
~~~~~~~
|
|
|
|
* :doc:`/raysgd/v2/examples/train_linear_example`:
|
|
Simple example for PyTorch.
|
|
|
|
* :doc:`/raysgd/v2/examples/train_fashion_mnist_example`:
|
|
End-to-end example for PyTorch.
|
|
|
|
* :doc:`/raysgd/v2/examples/transformers/transformers_example`:
|
|
End-to-end example for HuggingFace Transformers (PyTorch).
|
|
|
|
TensorFlow
|
|
~~~~~~~~~~
|
|
|
|
* :doc:`/raysgd/v2/examples/tensorflow_mnist_example`:
|
|
End-to-end example for TensorFlow
|
|
|
|
Horovod
|
|
~~~~~~~~~~
|
|
|
|
* :doc:`/raysgd/v2/examples/horovod/horovod_example`:
|
|
End-to-end example for Horovod (with PyTorch)
|
|
|
|
|
|
..
|
|
TODO
|
|
|
|
* :doc:`/raysgd/v2/examples/TODO`:
|
|
Simple example for TensorFlow
|
|
|
|
* :doc:`/raysgd/v2/examples/TODO`:
|
|
Simple example for Horovod (with TensorFlow)
|
|
|
|
|
|
Iterator API Examples
|
|
---------------------
|
|
|
|
* :doc:`/raysgd/v2/examples/mlflow_fashion_mnist_example`:
|
|
Example for using the Iterator API for custom MLFlow integration.
|
|
|
|
Ray Tune Integration Examples
|
|
-----------------------------
|
|
|
|
* :doc:`/raysgd/v2/examples/tune_linear_example`:
|
|
Simple example for tuning a PyTorch model.
|
|
|
|
* :doc:`/raysgd/v2/examples/tune_tensorflow_mnist_example`:
|
|
End-to-end example for tuning a TensorFlow model.
|
|
|
|
..
|
|
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.
|