Beta.workflow v3.stages

Stage types in a read-only workflow graph snapshot.

Stage Objects

@dataclass(frozen=True, repr=False)
class Stage(Generic[SettingsT, TaskT])

Identity and outgoing connections for one stage in the loaded graph.

get_tasks

def get_tasks(*,
              statuses: Optional[Sequence[TaskStatus]] = None,
              sort: Optional[TaskSort] = None) -> Iterator[TaskT]

Iterate permitted current tasks, fetching pages lazily without claiming work. Arguments are validated immediately; request errors may arise during iteration. This is a changing queue, not a snapshot. Terminal stages use newest-arrival ordering and do not accept filters.

StartStage Objects

@dataclass(frozen=True, repr=False)
class StartStage(Stage[Union[StartStageSettingsV1, UnknownStageSettings],
                       Task])

Background processing at workflow entry.

AnnotationStage Objects

@dataclass(frozen=True, repr=False)
class AnnotationStage(Stage[Union[AnnotationStageSettingsV1,
                                  UnknownStageSettings], AnnotationTask])

Manual annotation of targets.

submit_tasks

def submit_tasks(tasks: Sequence[Task],
                 *,
                 pathway_id: Optional[Union[UUID, str]] = None,
                 pathway_name: Optional[str] = None,
                 comment: Optional[str] = None) -> None

Submit up to 100 tasks atomically through one pathway with an optional comment, without replaying sent requests.

ReviewStage Objects

@dataclass(frozen=True, repr=False)
class ReviewStage(Stage[Union[ReviewStageSettingsV1, UnknownStageSettings],
                        ReviewTask])

Manual review of targets and labels.

submit_tasks

def submit_tasks(tasks: Sequence[Task],
                 *,
                 pathway_id: Optional[Union[UUID, str]] = None,
                 pathway_name: Optional[str] = None,
                 comment: Optional[str] = None) -> None

Submit up to 100 tasks atomically without changing individual label decisions. One pathway and optional comment apply to every task. Sent requests are not replayed.

ExternalStage Objects

@dataclass(frozen=True, repr=False)
class ExternalStage(Stage[Union[ExternalStageSettingsV1, UnknownStageSettings],
                          ExternalTask])

Work held for an external integration.

submit_tasks

def submit_tasks(tasks: Sequence[Task],
                 *,
                 pathway_id: Optional[Union[UUID, str]] = None,
                 pathway_name: Optional[str] = None) -> None

Submit up to 100 tasks atomically through one pathway, without replaying sent requests.

CompleteStage Objects

@dataclass(frozen=True, repr=False)
class CompleteStage(Stage[Union[CompleteStageSettingsV1, UnknownStageSettings],
                          Task])

Terminal stage for the Complete outcome.

ArchiveStage Objects

@dataclass(frozen=True, repr=False)
class ArchiveStage(Stage[Union[ArchiveStageSettingsV1, UnknownStageSettings],
                         Task])

Terminal stage for the Archive outcome.

SkipStage Objects

@dataclass(frozen=True, repr=False)
class SkipStage(Stage[Union[SkipStageSettingsV1, UnknownStageSettings], Task])

Terminal stage for the Skip outcome.

PercentageRouterStage Objects

@dataclass(frozen=True, repr=False)
class PercentageRouterStage(Stage[Union[PercentageRouterStageSettingsV1,
                                        UnknownStageSettings], Task])

Targets are routed by the configured pathway allocations.

CollaboratorRouterStage Objects

@dataclass(frozen=True, repr=False)
class CollaboratorRouterStage(Stage[Union[CollaboratorRouterStageSettingsV1,
                                          UnknownStageSettings], Task])

Route targets using the user who last processed them at a manual stage.

UnknownStage Objects

@dataclass(frozen=True, repr=False)
class UnknownStage(Stage[UnknownStageSettings, Task])

An unfamiliar stage available for discovery, not specialized operations.

Get Started

General

Data

Ontologies

Projects

Labels

DICOM

Beta.workflow v3.stages

Stage Objects

get_tasks

StartStage Objects

AnnotationStage Objects

submit_tasks

ReviewStage Objects

submit_tasks

ExternalStage Objects

submit_tasks

CompleteStage Objects

ArchiveStage Objects

SkipStage Objects

PercentageRouterStage Objects

CollaboratorRouterStage Objects

UnknownStage Objects