ipex-llm/docs/readthedocs/source/doc/PythonAPI/Orca/orca.rst
Jiao Wang 5d90ca2dac Update MPI Estimator to support Pytorch IPEX training (#8303)
* update

* update

* update

* update

* update

* update with comments

* update

* update

* style

* style

* add doc

* style

* style
2023-08-28 11:03:29 -07:00

87 lines
1.7 KiB
ReStructuredText

Orca Learn
=========
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.tf2.tf2_ray_estimator
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Orca TF2Estimator with backend of "horovod" or "ray".
.. autoclass:: bigdl.orca.learn.tf2.ray_estimator.TensorFlow2Estimator
:members:
:undoc-members:
:show-inheritance:
orca.learn.tf2.tf2_spark_estimator
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Orca TF2Estimator with backend of "spark".
.. autoclass:: bigdl.orca.learn.tf2.pyspark_estimator.SparkTFEstimator
: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 "ray".
.. autoclass:: bigdl.orca.learn.pytorch.pytorch_ray_estimator.PyTorchRayEstimator
:members:
:undoc-members:
:show-inheritance:
orca.learn.openvino.estimator
------------------------------
.. automodule:: bigdl.orca.learn.openvino.estimator
:members:
:undoc-members:
:show-inheritance:
orca.learn.mpi.mpi_estimator
------------------------------
.. autoclass:: bigdl.orca.learn.mpi.MPIEstimator
:members:
:undoc-members:
:show-inheritance: