ray/doc/source/workflows/package-ref.rst
Linsong Chu 61bbecdb7d
[Workflow]add doc for metadata (#20156)
This PR adds documentation for Workflow Metadata, which we recently added support in https://github.com/ray-project/ray/pull/19372.

Co-authored-by: Yi Cheng <74173148+iycheng@users.noreply.github.com>
2021-12-20 17:24:07 -08:00

26 lines
712 B
ReStructuredText

Workflows API Reference
=======================
Core API
---------
.. autofunction:: ray.workflow.init
.. 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