mirror of
https://github.com/vale981/ray
synced 2025-03-09 04:46:38 -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>
100 lines
No EOL
1.5 KiB
ReStructuredText
100 lines
No EOL
1.5 KiB
ReStructuredText
.. _sgd-api:
|
|
|
|
RaySGD API
|
|
==========
|
|
|
|
.. _sgd-api-trainer:
|
|
|
|
Trainer
|
|
-------
|
|
|
|
.. autoclass:: ray.util.sgd.v2.Trainer
|
|
:members:
|
|
|
|
.. _sgd-api-iterator:
|
|
|
|
SGDIterator
|
|
~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.util.sgd.v2.SGDIterator
|
|
:members:
|
|
|
|
.. _sgd-api-backend-config:
|
|
|
|
BackendConfig
|
|
-------------
|
|
|
|
.. autoclass:: ray.util.sgd.v2.BackendConfig
|
|
|
|
.. _sgd-api-torch-config:
|
|
|
|
TorchConfig
|
|
~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.util.sgd.v2.TorchConfig
|
|
|
|
.. _sgd-api-tensorflow-config:
|
|
|
|
TensorflowConfig
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.util.sgd.v2.TensorflowConfig
|
|
|
|
.. _sgd-api-horovod-config:
|
|
|
|
HorovodConfig
|
|
~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.util.sgd.v2.HorovodConfig
|
|
|
|
.. _sgd-api-callback:
|
|
|
|
SGDCallback
|
|
-----------
|
|
|
|
.. autoclass:: ray.util.sgd.v2.SGDCallback
|
|
:members:
|
|
|
|
.. _sgd-api-json-logger-callback:
|
|
|
|
JsonLoggerCallback
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.util.sgd.v2.callbacks.JsonLoggerCallback
|
|
|
|
.. _sgd-api-tbx-logger-callback:
|
|
|
|
TBXLoggerCallback
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.util.sgd.v2.callbacks.TBXLoggerCallback
|
|
|
|
.. _sgd-api-checkpoint-strategy:
|
|
|
|
CheckpointStrategy
|
|
------------------
|
|
|
|
.. autoclass:: ray.util.sgd.v2.CheckpointStrategy
|
|
|
|
Training Function Utilities
|
|
---------------------------
|
|
|
|
sgd.report
|
|
~~~~~~~~~~
|
|
|
|
.. autofunction:: ray.util.sgd.v2.report
|
|
|
|
sgd.load_checkpoint
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autofunction:: ray.util.sgd.v2.load_checkpoint
|
|
|
|
sgd.save_checkpoint
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autofunction:: ray.util.sgd.v2.save_checkpoint
|
|
|
|
sgd.world_rank
|
|
~~~~~~~~~~~~~~
|
|
|
|
.. autofunction:: ray.util.sgd.v2.world_rank |