ray.workflow.run_async#

ray.workflow.run_async(dag: ray.dag.dag_node.DAGNode, *args, workflow_id: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs) → <MagicMock name='mock.ObjectRef' id='140264774837504'>[source]#

Run a workflow asynchronously.

If the workflow with the given id already exists, it will be resumed.

Parameters

  • workflow_id – A unique identifier that can be used to resume the workflow. If not specified, a random id will be generated.

  • metadata – The metadata to add to the workflow. It has to be able to serialize to json.

Returns

The running result as ray.ObjectRef.

PublicAPI (alpha): This API is in alpha and may change before becoming stable.