- ray.workflow.cancel(workflow_id: str) None [source]#
- Cancel a workflow. Workflow checkpoints will still be saved in storage. To
clean up saved checkpoints, see
workflow_id – The workflow to cancel.
>>> 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()
PublicAPI (alpha): This API is in alpha and may change before becoming stable.