hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-09 12:56:46 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc/source/raysgd/raysgd_ref.rst

87 lines
1.4 KiB
ReStructuredText
Raw Normal View History

[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
RaySGD API Reference
====================
PyTorch
-------
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
[RaySGD] Rename PyTorch API endpoints to start with Torch (#7425) * Start renaming pytorch to torch * Rename PyTorchTrainer to TorchTrainer * Rename PyTorch runners to Torch runners * Finish renaming API * Rename to torch in tests * Finish renaming docs + tests * Run format + fix DeprecationWarning * fix * move tests up * rename Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-03-03 16:44:42 -08:00
.. _ref-torch-trainer:
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
[RaySGD] Rename PyTorch API endpoints to start with Torch (#7425) * Start renaming pytorch to torch * Rename PyTorchTrainer to TorchTrainer * Rename PyTorch runners to Torch runners * Finish renaming API * Rename to torch in tests * Finish renaming docs + tests * Run format + fix DeprecationWarning * fix * move tests up * rename Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-03-03 16:44:42 -08:00
TorchTrainer
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
~~~~~~~~~~~~
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
[RaySGD] Rename PyTorch API endpoints to start with Torch (#7425) * Start renaming pytorch to torch * Rename PyTorchTrainer to TorchTrainer * Rename PyTorch runners to Torch runners * Finish renaming API * Rename to torch in tests * Finish renaming docs + tests * Run format + fix DeprecationWarning * fix * move tests up * rename Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-03-03 16:44:42 -08:00
.. autoclass:: ray.util.sgd.torch.TorchTrainer
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
:members:
[RaySGD] Rename PyTorch API endpoints to start with Torch (#7425) * Start renaming pytorch to torch * Rename PyTorchTrainer to TorchTrainer * Rename PyTorch runners to Torch runners * Finish renaming API * Rename to torch in tests * Finish renaming docs + tests * Run format + fix DeprecationWarning * fix * move tests up * rename Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-03-03 16:44:42 -08:00
.. _ref-torch-operator:
[raysgd] Custom training operator (#7211)
2020-03-01 21:22:48 -08:00
PyTorch TrainingOperator
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
~~~~~~~~~~~~~~~~~~~~~~~~
[raysgd] Custom training operator (#7211)
2020-03-01 21:22:48 -08:00
[RaySGD] Rename PyTorch API endpoints to start with Torch (#7425) * Start renaming pytorch to torch * Rename PyTorchTrainer to TorchTrainer * Rename PyTorch runners to Torch runners * Finish renaming API * Rename to torch in tests * Finish renaming docs + tests * Run format + fix DeprecationWarning * fix * move tests up * rename Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-03-03 16:44:42 -08:00
.. autoclass:: ray.util.sgd.torch.TrainingOperator
[raysgd] Custom training operator (#7211)
2020-03-01 21:22:48 -08:00
:members:
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
.. _ref-creator-operator:
CreatorOperator
~~~~~~~~~~~~~~~~
.. autoclass:: ray.util.sgd.torch.training_operator.CreatorOperator
:members:
:exclude-members: setup
.. _ref-lightning-operator:
Pytorch Lightning LightningOperator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: ray.util.sgd.torch.lightning_operator.LightningOperator
:members:
:exclude-members: setup, train_epoch, train_batch, validate, validate_batch, state_dict, load_state_dict
[tune/raysgd] Tune API for TorchTrainer + Fix State Restoration (#7547)
2020-03-30 10:58:49 -07:00
.. _BaseTorchTrainable-doc:
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
[tune/raysgd] Tune API for TorchTrainer + Fix State Restoration (#7547)
2020-03-30 10:58:49 -07:00
BaseTorchTrainable
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
~~~~~~~~~~~~~~~~~~
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
[tune/raysgd] Tune API for TorchTrainer + Fix State Restoration (#7547)
2020-03-30 10:58:49 -07:00
.. autoclass:: ray.util.sgd.torch.BaseTorchTrainable
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
:members:
[tune/raysgd] Tune API for TorchTrainer + Fix State Restoration (#7547)
2020-03-30 10:58:49 -07:00
:private-members:
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
Tensorflow
----------
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
TFTrainer
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
~~~~~~~~~
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
Add ray.util package and move libraries from experimental (#7100)
2020-02-18 13:43:19 -08:00
.. autoclass:: ray.util.sgd.tf.TFTrainer
[sgd] Refactor PyTorch SGD Documentation. (#6910) * Refactor documentation and directory structurre * update loss * ,ore examples * fix comments * more code * svgs * formatting * more_docs * more writing * comments ready * move * whitespace * examples * fix * bold * pytorch * batch * fix * fix test * Apply suggestions from code review * quarantinegp * tests/ * fix missing
2020-01-29 08:51:01 -08:00
:members:
.. automethod:: __init__
[SGD] Dataset API (#7839)
2020-06-01 15:48:15 -07:00
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
RaySGD Dataset
---------------
[SGD] Dataset API (#7839)
2020-06-01 15:48:15 -07:00
Dataset
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
~~~~~~~
[SGD] Dataset API (#7839)
2020-06-01 15:48:15 -07:00
.. autoclass:: ray.util.sgd.data.Dataset
:members:
.. automethod:: __init__
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
RaySGD Utils
-------------
[SGD][Docs] docs for training/ validation results (#10181)
2020-08-19 17:22:28 -07:00
.. _ref-utils:
Utils
[SGD] Add PTL Docs (#12440) Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
2020-11-28 10:09:38 -08:00
~~~~~
[SGD][Docs] docs for training/ validation results (#10181)
2020-08-19 17:22:28 -07:00
.. autoclass:: ray.util.sgd.utils.AverageMeter
:members:
.. autoclass:: ray.util.sgd.utils.AverageMeterCollection
:members:
Reference in a new issue Copy permalink