ray/doc/source/workflows/package-ref.rst

Ray Workflow 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
[Workflow] Cleanup workflow docs (#27197) * cleanup workflow docs Signed-off-by: Siyuan Zhuang <suquark@gmail.com> 2022-07-29 13:03:50 -07:00			`Ray Workflow API`
[docs] landing page (fixes #21750) (#21859) Co-authored-by: Richard Liaw <rliaw@berkeley.edu> 2022-01-27 02:14:25 +01:00			`=================`
Initial version of workflow documentation (#18138) 2021-08-27 16:20:48 -07:00
[workflow] Deprecate workflow.create (#26106) 2022-07-02 21:24:05 -07:00			`Workflow Execution API`
			`----------------------`

			`.. autofunction:: ray.workflow.run`
			`.. autofunction:: ray.workflow.run_async`


Initial version of workflow documentation (#18138) 2021-08-27 16:20:48 -07:00			`Management API`
			`--------------`
[workflow] Move `experimental/workflow` to `workflow` (#18521) 2021-09-13 17:45:18 -07:00			`.. autofunction:: ray.workflow.resume`
[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			`.. autofunction:: ray.workflow.resume_async`
			`.. autofunction:: ray.workflow.resume_all`
[workflow] Move `experimental/workflow` to `workflow` (#18521) 2021-09-13 17:45:18 -07:00			`.. autofunction:: ray.workflow.list_all`
			`.. autofunction:: ray.workflow.get_status`
			`.. autofunction:: ray.workflow.get_output`
[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			`.. autofunction:: ray.workflow.get_output_async`
[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 20:24:07 -05:00			`.. autofunction:: ray.workflow.get_metadata`
[workflow] Move `experimental/workflow` to `workflow` (#18521) 2021-09-13 17:45:18 -07:00			`.. autofunction:: ray.workflow.cancel`