ray.workflow.列出所有#

ray.workflow.list_all(status_filter: WorkflowStatus | str | Set[WorkflowStatus | str] | None = None) → List[Tuple[str, WorkflowStatus]][源代码]#

列出所有符合给定状态过滤器的工作流。当返回“可恢复”的工作流时，运行中的工作流在结果列表中排在待处理的工作流之前。

参数:: status_filter – 如果提供，则仅返回具有该状态的工作流。这可以是一个状态或一组状态。状态的字符串形式也是可以接受的，即“RUNNING”/“FAILED”/“SUCCESSFUL”/“CANCELED”/“RESUMABLE”/“PENDING”。

示例

from ray import workflow

@ray.remote
def long_running_job():
    import time
    time.sleep(2)

workflow_task = long_running_job.bind()
wf = workflow.run_async(workflow_task,
    workflow_id="long_running_job")
jobs = workflow.list_all(workflow.RUNNING)
assert jobs == [ ("long_running_job", workflow.RUNNING) ]
ray.get(wf)
jobs = workflow.list_all({workflow.RUNNING})
assert jobs == []

返回:: 包含工作流ID和工作流状态的元组列表

PublicAPI (alpha): 此API处于alpha阶段，可能在稳定之前发生变化。