ray/doc/source/raysgd/raysgd_ref.rst
2022-01-20 15:30:56 -08:00

77 lines
1.1 KiB
ReStructuredText

RaySGD API Reference
====================
PyTorch
-------
.. _ref-torch-trainer:
TorchTrainer
~~~~~~~~~~~~
.. autoclass:: ray.util.sgd.torch.TorchTrainer
:members:
.. _ref-torch-operator:
PyTorch TrainingOperator
~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: ray.util.sgd.torch.TrainingOperator
:members:
.. _ref-creator-operator:
CreatorOperator
~~~~~~~~~~~~~~~~
.. autoclass:: ray.util.sgd.torch.training_operator.CreatorOperator
:members:
:exclude-members: setup
.. _BaseTorchTrainable-doc:
BaseTorchTrainable
~~~~~~~~~~~~~~~~~~
.. autoclass:: ray.util.sgd.torch.BaseTorchTrainable
:members:
:private-members:
Tensorflow
----------
TFTrainer
~~~~~~~~~
.. autoclass:: ray.util.sgd.tf.TFTrainer
:members:
.. automethod:: __init__
RaySGD Dataset
---------------
Dataset
~~~~~~~
.. autoclass:: ray.util.sgd.data.Dataset
:members:
.. automethod:: __init__
RaySGD Utils
-------------
.. _ref-utils:
Utils
~~~~~
.. autoclass:: ray.util.sgd.utils.AverageMeter
:members:
.. autoclass:: ray.util.sgd.utils.AverageMeterCollection
:members: