ray/doc/source/workflows/package-ref.rst
Siyuan (Ryans) Zhuang 417b72efdc
[workflow] Update workflow docs (#24249)
* update workflow docs

* rename "step" to "task"
2022-05-05 22:22:51 -07:00

25 lines
664 B
ReStructuredText

Ray Workflows API
=================
Core API
---------
.. autofunction:: ray.workflow.step
.. autoclass:: ray.workflow.common.Workflow
:members:
Virtual Actors
--------------
.. autofunction:: ray.workflow.virtual_actor
.. autoclass:: ray.workflow.virtual_actor_class.VirtualActorClass
:members:
Management API
--------------
.. autofunction:: ray.workflow.resume_all
.. autofunction:: ray.workflow.resume
.. autofunction:: ray.workflow.list_all
.. autofunction:: ray.workflow.get_status
.. autofunction:: ray.workflow.get_output
.. autofunction:: ray.workflow.get_metadata
.. autofunction:: ray.workflow.get_actor
.. autofunction:: ray.workflow.cancel