ray.workflow.cancel

ray.workflow.cancel(workflow_id: str) → None

Cancel a workflow. Workflow checkpoints will still be saved in storage. To

clean up saved checkpoints, see workflow.delete().

Parameters

workflow_id – The workflow to cancel.

Examples

>>> from ray import workflow
>>> some_job = ... 
>>> workflow_task = some_job.bind() 
>>> output = workflow.run_async(workflow_task,  
...     workflow_id="some_job")
>>> workflow.cancel(workflow_id="some_job") 
>>> assert [ 
...     ("some_job", workflow.CANCELED)] == workflow.list_all()

Returns

None

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