ipex-llm/docs/readthedocs/source/doc/PythonAPI/Orca/orca.rst
Yu Shan 829ee31f1b Add document for Orca PytorchRayEstimator and PytorchSparkEstimator (#3458)
* add document for pytorch_ray_estimator and pytorch_spark_estimator

* change module to class

* fix typo
2021-11-11 19:41:37 +08:00

76 lines
No EOL
1.4 KiB
ReStructuredText

Orca API
=========
orca.learn.bigdl.estimator
---------------------------
.. automodule:: bigdl.orca.learn.bigdl.estimator
:members:
:undoc-members:
:show-inheritance:
orca.learn.tf.estimator
------------------------
.. automodule:: bigdl.orca.learn.tf.estimator
:members:
:undoc-members:
:show-inheritance:
orca.learn.tf2.estimator
-------------------------
.. automodule:: bigdl.orca.learn.tf2.estimator
:members:
:undoc-members:
:show-inheritance:
orca.learn.pytorch.estimator
-----------------------------
.. automodule:: bigdl.orca.learn.pytorch.estimator
:members:
: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
------------------------------
.. automodule:: bigdl.orca.learn.openvino.estimator
:members:
:undoc-members:
:show-inheritance:
AutoML
------------------------------
.. toctree::
:maxdepth: 2
automl.rst