ray/doc/source/workflows/package-ref.rst
Siyuan (Ryans) Zhuang b803792b58
[workflow] Standardize workflow blocking and nonblocking APIs (#26318)
This PR unified the semantics of some workflow APIs.

Those workflow APIs acts on workflow tasks so they could be blocked for a long time. So we have both the blocking and non-blocking versions for them: xxx for blocking and xxx_async for non-blocking APIs.
2022-07-06 13:35:36 -07:00

21 lines
570 B
ReStructuredText

Ray Workflows API
=================
Workflow Execution API
----------------------
.. autofunction:: ray.workflow.run
.. autofunction:: ray.workflow.run_async
Management API
--------------
.. autofunction:: ray.workflow.resume
.. autofunction:: ray.workflow.resume_async
.. autofunction:: ray.workflow.resume_all
.. autofunction:: ray.workflow.list_all
.. autofunction:: ray.workflow.get_status
.. autofunction:: ray.workflow.get_output
.. autofunction:: ray.workflow.get_output_async
.. autofunction:: ray.workflow.get_metadata
.. autofunction:: ray.workflow.cancel