mirror of
https://github.com/vale981/ray
synced 2025-03-09 21:06:39 -04:00
111 lines
1.6 KiB
ReStructuredText
111 lines
1.6 KiB
ReStructuredText
|
|
||
|
|
.. _train-api:
|
||
|
|
|
||
|
|
Ray Train API
|
||
|
|
=============
|
||
|
|
|
||
|
|
.. _train-api-trainer:
|
||
|
|
|
||
|
|
Trainer
|
||
|
|
-------
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.Trainer
|
||
|
|
:members:
|
||
|
|
|
||
|
|
.. _train-api-iterator:
|
||
|
|
|
||
|
|
TrainingIterator
|
||
|
|
~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.TrainingIterator
|
||
|
|
:members:
|
||
|
|
|
||
|
|
.. _train-api-backend-config:
|
||
|
|
|
||
|
|
Backend Configurations
|
||
|
|
----------------------
|
||
|
|
|
||
|
|
.. _train-api-torch-config:
|
||
|
|
|
||
|
|
TorchConfig
|
||
|
|
~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.TorchConfig
|
||
|
|
|
||
|
|
.. _train-api-tensorflow-config:
|
||
|
|
|
||
|
|
TensorflowConfig
|
||
|
|
~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.TensorflowConfig
|
||
|
|
|
||
|
|
.. _train-api-horovod-config:
|
||
|
|
|
||
|
|
HorovodConfig
|
||
|
|
~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.HorovodConfig
|
||
|
|
|
||
|
|
|
||
|
|
Callbacks
|
||
|
|
---------
|
||
|
|
|
||
|
|
.. _train-api-callback:
|
||
|
|
|
||
|
|
TrainingCallback
|
||
|
|
~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.TrainingCallback
|
||
|
|
:members:
|
||
|
|
|
||
|
|
.. _train-api-json-logger-callback:
|
||
|
|
|
||
|
|
JsonLoggerCallback
|
||
|
|
~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.callbacks.JsonLoggerCallback
|
||
|
|
|
||
|
|
.. _train-api-tbx-logger-callback:
|
||
|
|
|
||
|
|
TBXLoggerCallback
|
||
|
|
~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.callbacks.TBXLoggerCallback
|
||
|
|
|
||
|
|
Checkpointing
|
||
|
|
-------------
|
||
|
|
|
||
|
|
.. _train-api-checkpoint-strategy:
|
||
|
|
|
||
|
|
CheckpointStrategy
|
||
|
|
~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autoclass:: ray.train.CheckpointStrategy
|
||
|
|
|
||
|
|
Training Function Utilities
|
||
|
|
---------------------------
|
||
|
|
|
||
|
|
train.report
|
||
|
|
~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autofunction:: ray.train.report
|
||
|
|
|
||
|
|
train.load_checkpoint
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autofunction:: ray.train.load_checkpoint
|
||
|
|
|
||
|
|
train.save_checkpoint
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autofunction:: ray.train.save_checkpoint
|
||
|
|
|
||
|
|
train.world_rank
|
||
|
|
~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autofunction:: ray.train.world_rank
|
||
|
|
|
||
|
|
train.local_rank
|
||
|
|
~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
.. autofunction:: ray.train.local_rank
|