ray/doc/source/train/api.rst
Richard Liaw 4629a3a649
[air/docs] Update Trainer documentation (#27481)
Co-authored-by: xwjiang2010 <xwjiang2010@gmail.com>
Co-authored-by: Kai Fricke <kai@anyscale.com>
Co-authored-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Eric Liang <ekhliang@gmail.com>
2022-08-05 11:21:19 -07:00

61 lines
1.1 KiB
ReStructuredText

.. _train-api:
Ray Train API
=============
This page covers advanced configurations for specific frameworks using Train.
For different high level trainers and their usage, take a look at the :ref:`AIR Trainer package reference <air-trainer-ref>`.
.. _train-api-backend-config:
Backend Configurations
----------------------
.. _train-api-torch-config:
TorchConfig
~~~~~~~~~~~
.. autoclass:: ray.train.torch.TorchConfig
:noindex:
.. _train-api-tensorflow-config:
TensorflowConfig
~~~~~~~~~~~~~~~~
.. autoclass:: ray.train.tensorflow.TensorflowConfig
:noindex:
.. _train-api-horovod-config:
HorovodConfig
~~~~~~~~~~~~~
.. autoclass:: ray.train.horovod.HorovodConfig
:noindex:
.. _train-api-backend-interfaces:
Backend interfaces (for developers only)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Backend
+++++++
.. autoclass:: ray.train.backend.Backend
BackendConfig
+++++++++++++
.. autoclass:: ray.train.backend.BackendConfig
Deprecated APIs
---------------
These APIs are deprecated and will be removed in a future Ray release:
- ray.train.Trainer
- ray.train.callbacks.*