From 829ee31f1b40cdd1cca72937d46ad5b7b8e45c47 Mon Sep 17 00:00:00 2001 From: Yu Shan Date: Thu, 11 Nov 2021 19:41:37 +0800 Subject: [PATCH] Add document for Orca `PytorchRayEstimator` and `PytorchSparkEstimator` (#3458) * add document for pytorch_ray_estimator and pytorch_spark_estimator * change module to class * fix typo --- .../source/doc/PythonAPI/Orca/orca.rst | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/readthedocs/source/doc/PythonAPI/Orca/orca.rst b/docs/readthedocs/source/doc/PythonAPI/Orca/orca.rst index f52a5d8a..5e038f8b 100644 --- a/docs/readthedocs/source/doc/PythonAPI/Orca/orca.rst +++ b/docs/readthedocs/source/doc/PythonAPI/Orca/orca.rst @@ -35,6 +35,29 @@ orca.learn.pytorch.estimator :undoc-members: :show-inheritance: + +orca.learn.pytorch.pytorch_ray_estimator +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Orca Pytorch Estimator with backend of "horovod" or "torch_distributed". + +.. autoclass:: bigdl.orca.learn.pytorch.pytorch_ray_estimator.PyTorchRayEstimator + :members: + :undoc-members: + :show-inheritance: + + +orca.learn.pytorch.pytorch_spark_estimator +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Orca Pytorch Estimator with backend of "bigdl". + +.. autoclass:: bigdl.orca.learn.pytorch.pytorch_spark_estimator.PyTorchSparkEstimator + :members: + :undoc-members: + :show-inheritance: + + orca.learn.openvino.estimator ------------------------------