Workflows and Stages

Workflow Basics

Encord SDK supports programmatic use of Workflows with the following: WorkflowStage, WorkflowAction, and Task. Typical use would be querying a WorkflowStage to get Tasks matching some criteria, and then executing a WorkflowAction against Tasks (for example: assigning, submitting annotation tasks, or accepting review tasks). The type of actions available depends on the stage queried. Here is a short description of major parts of the Workflows SDK:

WorkflowStage

WorkflowStage: Move your tasks through a Workflow Project using the WorkflowStage class. However, tasks CANNOT “teleport” through your Workflow. Tasks must move through the Workflow in logical order.
These are the stages currently supported:
- AnnotationStage
- ReviewStage
- ConsensusAnnotationStage
- ConsensusReviewStage
- FinalStage (Complete and Archive)

WorkflowAction

WorkflowAction: Applies an action to a task in a workflow stage The following actions are supported:
- assign: Assigns a user to one or more tasks.
- submit: Moves a task to the next stage.
- release: Releases a task from the current user.
- accept: Accepts a task.
- reject: Rejects a task.

Task

Task: Exposes a simple version of the tasks available in a Project.

TaskStatus

TaskStatus: The following statuses are available: The following statuses are available for ANNOTATE tasks:
- NEW: Tasks that are unassigned.
- ASSIGNED: Tasks that are assigned to a user.
- RELEASED: Tasks that were released from an assigned user.
- REOPENED: Tasks that were reopened.
- SKIPPED: Tasks that were skipped by annotators.
- COMPLETED: Tasks that are in the Complete stage. Used for Annotation sub-tasks in Consensus Annotation tasks.

Consensus Annotation tasks consist of 1 or more Annotation sub-tasks.

The following statuses are available for REVIEW and CONSENSUS REVIEW tasks:

NEW: Tasks that are unassigned.
ASSIGNED: Tasks that are assigned to a user.
RELEASED: Tasks that were released from an assigned user.
REOPENED: Tasks that were reopened.

In Consensus Projects, tasks in the COMPLETE and ARCHIVE blocks CANNOT be reopened.

View all stages in a Workflow

The following code provides you with the method to view all stages in a Workflow in a Project. The code is the same for Consensus and Non-Consensus Projects.

Routers are not displayed in the list of stages when using the SDK.

# Import dependencies
from encord import EncordUserClient, Project


SSH_PATH = "<file-path-to-private-key-file>"
PROJECT_HASH = "<unique-id-for-project>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

# Print all Workflow stages
for idx, stage in enumerate(project.workflow.stages):
    print(f"Stage #{idx}: {stage}")

Non-Consensus Project This is an example of a non-Consensus Workflow graph.

Consensus Workflow Project This is an example of a Consensus Workflow graph.

Non-Consensus Projects

In the SDK, a class is defined for every stage type. This allows you to see what properties and actions each stage offers. The following stages are supported for non-Consensus Projects:

AnnotationStage
ReviewStage
FinalStage (Complete and Archive)

class AnnotationStage(WorkflowStage):
	uuid: str
	title: str
  
  def get_tasks()
    

Tasks provides programmatic access to your tasks available in the UI.
The following tasks are supported for non-Consensus Projects::

assign: Assigns a user to one or more tasks.
submit: Moves a task to the next stage.
release: Releases a task from the current user.

class AnnotationTask:
    uuid: UUID
    data_hash: UUID
    data_title: str
    label_branch: str  # main by default

Display Tasks in a Stage

Use the following scripts as templates for annotation and review tasks.

Display Stage Tasks

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)

SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Annotate 1", type_=AnnotationStage)
# type_ is an optional parameter here, any other type narrowing technique can be used here
# for example it can be an assert as follows
assert isinstance(stage, AnnotationStage)

for task in stage.get_tasks():
    print(f"Task: {task}")

Assign a User to Tasks in a Stage

Use the following scripts as templates for annotation and review tasks.

from encord.user_client import EncordUserClient
from encord.workflow.stages.annotation import AnnotationStage, AnnotationTaskStatus
from encord.workflow.stages.consensus_annotation import ConsensusAnnotationStage
from encord.workflow.stages.consensus_review import ConsensusReviewStage
from encord.workflow.stages.review import ReviewStage

SSH_PATH = "<file-path-to-private-key>"

PROJECT_ID="<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    Path(SSH_PATH).read_text()
)

project = user_client.get_project(PROJECT_ID)

workflow = project.workflow

annotation_stage = workflow.get_stage(name="<name-of-workflow-stage>", type_=<type-of-workflow-stage>)

BUNDLE_SIZE = 100  # You can adjust this value as needed, but keep it <= 1000

with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for annotation_task in annotation_stage.get_tasks():
        print(annotation_task.data_title)
        
        # Assign task to someone
        annotation_task.assign(assignee='<email-address>', bundle=bundle)

Submit Tasks as Another User in a Stage

Annotation Tasks can only be submitted on behalf of users with the following roles: Annotator, Annotator + Reviewer, Team Manager, or Admin.
Review Tasks can only be submitted on behalf of users with the following roles: Reviewer, Annotator + Reviewer, Team Manager, or Admin.

from encord.user_client import EncordUserClient
from encord.workflow.stages.annotation import AnnotationStage, AnnotationTaskStatus
from encord.workflow.stages.consensus_annotation import ConsensusAnnotationStage
from encord.workflow.stages.consensus_review import ConsensusReviewStage
from encord.workflow.stages.review import ReviewStage

SSH_PATH = "<file-path-to-private-key>"

PROJECT_ID="<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    Path(SSH_PATH).read_text()
)

project = user_client.get_project(PROJECT_ID)

workflow = project.workflow

annotation_stage = workflow.get_stage(name="<name-of-annotation-stage>", type_=<type-of-workflow-stage>)

BUNDLE_SIZE = 100  # You can adjust this value as needed, but keep it <= 1000

with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for annotation_task in annotation_stage.get_tasks():
        print(annotation_task.data_title)
        
        # Submit as someone explicitly
        annotation_task.submit(assignee='<email-address>', bundle=bundle)

Retain Current User and Submit Task

Annotation Tasks can only be submitted by users with the following roles: Annotator, Annotator + Reviewer, Team Manager, or Admin.
Review Tasks can only be submitted by users with the following roles: Reviewer, Annotator + Reviewer, Team Manager, or Admin.

from encord.user_client import EncordUserClient
from encord.workflow.stages.annotation import AnnotationStage, AnnotationTaskStatus
from encord.workflow.stages.consensus_annotation import ConsensusAnnotationStage
from encord.workflow.stages.consensus_review import ConsensusReviewStage
from encord.workflow.stages.review import ReviewStage

SSH_PATH = "<file-path-to-private-key>"

PROJECT_ID="<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    Path(SSH_PATH).read_text()
)

project = user_client.get_project(PROJECT_ID)

workflow = project.workflow

annotation_stage = workflow.get_stage(name="<name-of-workflow-stage>", type_=<type-of-workflow-stage>)

BUNDLE_SIZE = 100  # You can adjust this value as needed, but keep it <= 1000

with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for annotation_task in annotation_stage.get_tasks():
        print(annotation_task.data_title)
        
        # Retain current assignee and submit
        annotation_task.submit(retain_assignee=True, bundle=bundle)

Get all Tasks

Get Tasks

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)

SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Consensus 1", type_=ConsensusAnnotationStage)
# type_ is an optional parameter here, any other type narrowing technique can be used here
# for example it can be an assert like follows
assert isinstance(stage, ConsensusAnnotationStage)

for task in stage.get_tasks():
    
    print(f"Task: {task}")

Filter tasks by data hash

You can filter tasks in any stage using data hashes.

Filter tasks by data hash

# Import dependencies
from encord import EncordUserClient, Project
from encord.workflow import AnnotationStage, ReviewStage, ConsensusAnnotationStage, ConsensusReviewStage, FinalStage

# Constants
SSH_PATH = "<ssh-private-key>"
PROJECT_HASH = "<project-unique-id>"

# Create user client
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

# Get stage
stage = project.workflow.get_stage(name="Review 1", type_=ReviewStage)
# Uncomment the following line for different stage
# stage = project.workflow.get_stage(name="Annotate 1", type_=AnnotationStage)

# Check instance type. Change the type for each stage
assert isinstance(stage, ReviewStage)

# List of data hashes.
data_hashes = ["<data-unique-id-01>", "<data-unique-id-02>", "<data-unique-id-03>"]

for task in stage.get_tasks(data_hash=data_hashes):
    print(f"Task: {task}")

Move all tasks in a stage to the next stage

You can submit tasks as the currently assigned user or as a different user. If you do not specify the user to submit the task, you are assigned as the user submitting the task.

# Import dependencies
from encord import EncordUserClient, Project
from encord.workflow import AnnotationStage

SSH_PATH = "<file-path-to-private-key>"
PROJECT_HASH = "<project-unique-id>"

# Authenticate
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

# Get the specific stage (in this case, "Annotate 1")
stage = project.workflow.get_stage(name="Annotate 1", type_=AnnotationStage)
assert isinstance(stage, AnnotationStage)

# Define bundle size
BUNDLE_SIZE = 100  # You can adjust this value as needed, but keep it <= 1000

# Create a bundle and move tasks
with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks():
        # The task is submitted as the user who is currently assigned to the task
        task.submit(retain_assignee=True, bundle=bundle)
        print(f"Task: {task}")

print("All tasks have been processed and moved to the next stage.")

Use model predictions as an annotator

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import (
    AnnotationStage,
    ReviewStage,
    ConsensusAnnotationStage,
    ConsensusReviewStage,
    FinalStage,
)

SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Automated Annotation", type_=AnnotationStage)
assert isinstance(stage, AnnotationStage)

BUNDLE_SIZE = 100  # Define bundle size

# Assign tasks in bundles
with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks():
        task.assign("admin-alex@encord.com", bundle=bundle)
        print(f"Task assigned: {task}")

# Initialize label rows using bundles
with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks():
        if match_some_criteria(task):
            label_rows = project.list_label_rows_v2(data_hashes=[task.data_hash])
            for label_row in label_rows:
                label_row.initialise_labels(bundle=bundle)

                # Custom logic that populates label rows with labels
                do_preannotate(label_row)

# Save label rows using bundles
with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks():
        if match_some_criteria(task):
            label_rows = project.list_label_rows_v2(data_hashes=[task.data_hash])
            for label_row in label_rows:
                label_row.save(bundle=bundle)

# Submit tasks in bundles
with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks():
        if match_some_criteria(task):
            task.submit(bundle=bundle)
            print(f"Task submitted: {task}")

Consensus Projects

Consensus annotation tasks can be listed, but cannot be assigned or moved into the Consensus review stage. In Consensus Projects, tasks are broken into subtasks. One subtask for each Annotator. Subtasks can be assigned or submitted. Consensus Projects support the following stages:

AnnotationStage
ReviewStage
ConsensusAnnotationStage
ConsensusReviewStage
FinalStage (Complete and Archive)

The following actions are supported for Consensus review and Review and Refine:

assign: Assigns a user to one or more tasks.
approve: Moves a task to the next stage.
release: Releases a task from the current user.
reject: Rejects a task.

Get all Subtasks

Get Subtasks

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)

SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Consensus 1", type_=ConsensusAnnotationStage)
# type_ is an optional parameter here, any other type narrowing technique can be used here
# for example it can be an assert like follows
assert isinstance(stage, ConsensusAnnotationStage)

for task in stage.get_tasks():
    
    print(f"Task: {task}")
    for subtask in task.subtasks:
        print(f"   subtask: {subtask}")

Select your labels from a Consensus Project

The following code includes produce_result, that is undefined. You need to create and define the custom logic that selects the labels from the label options you have available.

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)

SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

# Obtaining the stage
stage = project.workflow.get_stage(name="Consensus 1 Review", type_=ConsensusReviewStage)

BUNDLE_SIZE = 100  # Define bundle size

# Get all the tasks (or rather iterator over tasks), 
# Do NOT download them all at once.
for task in stage.get_tasks():
    # Each consensus branch has a unique label hash, so use them as filter
    label_hashes = [option.label_hash for option in task.options]
    label_rows_for_consensus = project.list_label_rows_v2(label_hashes=label_hashes)

    target_label_row = project.list_label_rows_v2(data_hashes=[task.data_hash])[0]
   
    with project.create_bundle(bundle_size=BUNDLE_SIZE) as label_initialize_bundle:
        # Bundling all our initialization operations in one operation
        for label_row in label_rows_for_consensus:
            label_row.initialise_labels(bundle=label_initialize_bundle)

        target_label_row.initialise_labels(bundle=label_initialize_bundle)

    # Download labels
    for label_row in label_rows_for_consensus:
        # Perform custom user logic and populate the target label row.
        # This means defining produce_result in your custom logic as produce_result
        # is not defined in the Encord SDK.
        if is_consensus := produce_result(label_rows_for_consensus, target_label_row):
            target_label_row.save()
            task.assign("<your-admin@example.com>")
            task.approve()
        else:
            task.reject()

Move Tasks

To Next Stage

Submitting a task moves it to the next stage in the Workflow.

Submit Task To Next Stage

from encord.user_client import EncordUserClient
from encord.workflow.stages.annotation import AnnotationStage, AnnotationTaskStatus
from encord.workflow.stages.consensus_annotation import ConsensusAnnotationStage
from encord.workflow.stages.consensus_review import ConsensusReviewStage
from encord.workflow.stages.review import ReviewStage

SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"

PROJECT_ID="<project-unique-id>"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    Path(SSH_PATH).read_text()
)

project = user_client.get_project(PROJECT_ID)

workflow = project.workflow

annotation_stage = workflow.get_stage(name="Annotate 1", type_=AnnotationStage)

BUNDLE_SIZE = 100  # You can adjust this value as needed, but keep it <= 1000

with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for annotation_task in annotation_stage.get_tasks():
        print(annotation_task.data_title)
        
        # Submit as someone explicitly
        annotation_task.submit(assignee='chris@acme.com', bundle=bundle)

To Complete

workflow_complete() moves Workflow tasks to the Complete stage.

In Consensus Projects, tasks in the COMPLETE and ARCHIVE blocks CANNOT be reopened.

# Import dependencies
from encord.user_client import EncordUserClient

#Authenticate using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>"
    )

# Open the project you want to work on by specifying the project hash
project = user_client.get_project(
    "<project-hash>"
)

# Create a bundle
with project.create_bundle() as bundle:
    # Move all tasks into the final stage of the Workflow
    for label_row in project.list_label_rows_v2():
        label_row.workflow_complete(bundle=bundle)

Reopen

Use the workflow_reopen() method to reopen tasks. Reopening tasks moves tasks back to the first stage in your Workflow.

# Import dependencies
from encord.user_client import EncordUserClient

#Authenticate using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>"
    )

# Open the project you want to work on by specifying the project hash
project = user_client.get_project(
    "<project-hash>"
)

# Create a bundle and automatically execute everything attached to the bundle
with project.create_bundle() as bundle:
    # Return all data units in the task back to the first Workflow stage
    for label_row in project.list_label_rows_v2():
        label_row.workflow_reopen(bundle=bundle)

Move Tasks Freely

Moving tasks skips all intermediate Workflow stages, placing them immediately into the selected stage.
All labels (object and classification) are automatically approved when tasks move to a COMPLETE stage.
Webhooks do not fire when tasks teleport through a workflow.

This script shows how to move a data unit directly between workflow stages, bypassing the standard workflow progression. The script shows how to access various Workflow Stage types; you should only use the ones relevant to your project.

Moving Tasks

from encord import EncordUserClient
from encord.workflow import AnnotationStage, ReviewStage,  AgentStage, FinalStage, ConsensusAnnotationStage

PROJECT_ID = '<project_ID>'
DATA_HASH = '<data_unit_hash>'
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path='<private_key_path>'
)

project = user_client.get_project(PROJECT_ID)

# Get your required stages
consensus_annotation_stage = project.workflow.get_stage(name='Consensus 1', type_=ConsensusAnnotationStage)
annotation_stage = project.workflow.get_stage(name='Annotate 1', type_=AnnotationStage)
review_stage = project.workflow.get_stage(name='Review 1', type_=ReviewStage)
agent_stage = project.workflow.get_stage(name='Agent 1', type_=AgentStage)
complete_stage = project.workflow.get_stage(name='Complete', type_=FinalStage)
archive_stage = project.workflow.get_stage(name='Archive', type_=FinalStage)

# Insert source and destination stages here
source_stage = <insert_source_stage>
destination_stage = <insert_destination_stage>

# Move a task from the source stage to the destination stage
with project.create_bundle() as bundle:
    for task in source_stage.get_tasks(data_hash=DATA_HASH):
        print(f"Moving task from '{source_stage.name}' to '{destination_stage.name}'")
        task.move(destination_stage_uuid=destination_stage.uuid, bundle=bundle)

Task Priority

You can read and assign task priorities using the SDK. Priorities in the SDK are represented by numbers ranging from 0 to 1, where 1 corresponds to 100 in the Encord platform, the highest priority value.

For more information, see our platform documentation for the Queue tab, and priorities.

You cannot set the priority for more than 100 tasks in a bundle.

# Import dependencies
from encord.user_client import EncordUserClient

#Authenticate using the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>"
    )

# Open the project you want to work on by specifying the project hash
project = user_client.get_project(
    "<project-hash>"
)

# Reading the priority of the first label row
label_row = project.list_label_rows_v2()[0]
label_row.initialise_labels()

print(f"Current priority: {label_row.priority}")

# Setting the priority of the first label row to 0.2
label_row.set_priority(0.2)
label_row = project.list_label_rows_v2()[0]
print(f"New priority: {label_row.priority}")

End-to-End Example moving tasks through Projects

This example uses a basic non-Consensus Project Workflow moving a number of tasks from ANNOTATE to COMPLETE. !End-to-end Example Workflow !End-to-end Example tasks

Project ID: 01bd7084-b04a-4cd1-87f3-73e8e78925c4
Data units: apples_01.jpg, apples_02.jpg, apples_03.jpg, apples_04.jpg, apples_05.jpg

STEP 1: View all tasks in the Project

A few tasks have been annotated, but they have not been submitted yet. The following code lists all tasks in the ANNOTATE 1 stage.

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)


SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "01bd7084-b04a-4cd1-87f3-73e8e78925c4"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Annotate 1", type_=AnnotationStage)
# type_ is an optional parameter here, any other type narrowing technique can be used here
# for example it can be an assert like follows
assert isinstance(stage, AnnotationStage)

for task in stage.get_tasks():
    
    print(f"Task: {task}")

From the returned results we can see that four of the data units have been assigned (apples_01 to apples_04) while one task has not (apples_05). We do not know the extent that each of the assigned data units has been annotated, but we want the tasks to move through the Workflow.

STEP 2: Submit all tasks for review

The following code submits ALL tasks to the REVIEW 1 stage. Before the tasks can be submitted they are first assigned to a user in the Project. The user could be any user capable of annotating in the Project (because this is the ANNOTATE stage). For this example, the Admin of the Project (the user with SDK access) is assigned.

Submit all tasks for review

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)

SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "01bd7084-b04a-4cd1-87f3-73e8e78925c4"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Annotate 1", type_=AnnotationStage)
# type_ is an optional parameter. Any type of narrowing technique can be used here.
# For example:
assert isinstance(stage, AnnotationStage)

BUNDLE_SIZE = 100

with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks():

        task.assign("chris@acme.com")

        task.submit(bundle=bundle)
        
        print(f"Task: {task}")

STEP 3: Verify that the tasks are in REVIEW 1

Each time we perform an action, we should verify the action is successful. After submitting the tasks, we can verify that the tasks are now in REVIEW 1.

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)


SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "01bd7084-b04a-4cd1-87f3-73e8e78925c4"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Review 1", type_=ReviewStage)
# type_ is an optional parameter here, any other type narrowing technique can be used here
# for example it can be an assert like follows
assert isinstance(stage, ReviewStage)

for task in stage.get_tasks():
    
    print(f"Task: {task}")

All of the tasks are now in stage REVIEW 1. None of the tasks are assigned to any users.

STEP 4: Reject a task

We know that apples-05.jpg does not have any labels, because it was not assigned to any users before we submitted the task. If we REJECT the task, according to the Workflow in the Project, the task returns to the ANNOTATE 1 stage.The following code filters the task in the REVIEW 1 stage based on the task’s data hash, and then rejects the task.

# Import dependencies
from encord import EncordUserClient, Project
from encord.workflow import AnnotationStage, ReviewStage, ConsensusAnnotationStage, ConsensusReviewStage, FinalStage
from uuid import UUID  # Import the UUID function

# Constants
SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "01bd7084-b04a-4cd1-87f3-73e8e78925c4"

# Create user client
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

# Get stage
stage = project.workflow.get_stage(name="Review 1", type_=ReviewStage)
# Uncomment the following line for different stage

# Check instance type
assert isinstance(stage, ReviewStage)

data_hashes = ["34571f50-90d1-4681-a58b-1fd08e9f6665"]

BUNDLE_SIZE = 100

with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks(data_hash=data_hashes):

        task.assign("chris@acme.com")

        task.reject(bundle=bundle)

        print(f"Task: {task}")

From what was returned, we can see that only data unit apples_05.jpg was acted upon.To verify that the task is now in ANNOTATE 1, run the following:

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)


SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "01bd7084-b04a-4cd1-87f3-73e8e78925c4"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Annotate 1", type_=AnnotationStage)
# type_ is an optional parameter here, any other type narrowing technique can be used here
# for example it can be an assert like follows
assert isinstance(stage, AnnotationStage)

for task in stage.get_tasks():
    
    print(f"Task: {task}")

STEP 5: Approve tasks

There are still four tasks in REVIEW 1. The following code approves the tasks. This moves the tasks to the COMPLETE stage. You could approve all the tasks at once the REVIEW 1 stage, but instead we will filter by data hash and then approve.

# Import dependencies
from encord import EncordUserClient, Project
from encord.workflow import AnnotationStage, ReviewStage, ConsensusAnnotationStage, ConsensusReviewStage, FinalStage
from uuid import UUID  # Import the UUID function

# Constants
SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "01bd7084-b04a-4cd1-87f3-73e8e78925c4"

# Create user client
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

# Get stage
stage = project.workflow.get_stage(name="Review 1", type_=ReviewStage)
# Uncomment the following line for different stage

# Check instance type
assert isinstance(stage, ReviewStage)

data_hashes = [
    "36b0afd3-6ff8-4201-bf65-35a37f6fe5b5",
    "4dc183ba-4233-4cb1-a940-cb6b2bc38f35",
    "22f8dc9a-deff-49a2-a2d2-3863cf20d4f4",
    "809344fd-8935-4dde-81eb-36efb4e6d558"
    ]



BUNDLE_SIZE = 100

with project.create_bundle(bundle_size=BUNDLE_SIZE) as bundle:
    for task in stage.get_tasks(data_hash=data_hashes):

        task.assign("chris@acme.com")

        task.approve(bundle=bundle)

        print(f"Task: {task}")

STEP 6: Verify tasks are COMPLETE

Use the following code to verify that the tasks apples01 to apples_04 are in the COMPLETE stage.

# Import dependencies
from encord import EncordUserClient, Project

from encord.workflow import(
  AnnotationStage, 
  ReviewStage,
  ConsensusAnnotationStage, 
  ConsensusReviewStage,
  FinalStage
)


SSH_PATH = "/Users/chris-encord/sdk-ssh-private-key.txt"
PROJECT_HASH = "09765dc5-08b0-4b32-b37a-e1b932b8b684"

user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Get project
project: Project = user_client.get_project(PROJECT_HASH)

stage = project.workflow.get_stage(name="Complete", type_=FinalStage)
# type_ is an optional parameter here, any other type narrowing technique can be used here
# for example it can be an assert like follows
assert isinstance(stage, FinalStage)

for task in stage.get_tasks():
    
    print(f"Task: {task}")

And from what the code returns, the tasks are now in the COMPLETE stage.

Get Started

General

Index

Ontologies

Projects

Labels

Datasets

DICOM

Active API & SDK

Workflows and Stages

Workflow Basics

View all stages in a Workflow

Non-Consensus Projects

Display Tasks in a Stage

Assign a User to Tasks in a Stage

Submit Tasks as Another User in a Stage

Retain Current User and Submit Task

Get all Tasks

Filter tasks by data hash

Move all tasks in a stage to the next stage

Use model predictions as an annotator

Consensus Projects

Get all Subtasks

Select your labels from a Consensus Project

Move Tasks

To Next Stage

To Complete

Reopen

Move Tasks Freely

Task Priority

End-to-End Example moving tasks through Projects

Get Started

General

Index

Ontologies

Projects

Labels

Datasets

DICOM

Active API & SDK

​Workflow Basics

​View all stages in a Workflow

​Non-Consensus Projects

​Display Tasks in a Stage

​Assign a User to Tasks in a Stage

​Submit Tasks as Another User in a Stage

​Retain Current User and Submit Task

​Get all Tasks

​Filter tasks by data hash

​Move all tasks in a stage to the next stage

​Use model predictions as an annotator

​Consensus Projects

​Get all Subtasks

​Select your labels from a Consensus Project

​Move Tasks

​To Next Stage

​To Complete

​Reopen

​Move Tasks Freely

​Task Priority

​End-to-End Example moving tasks through Projects

Workflow Basics

View all stages in a Workflow

Non-Consensus Projects

Display Tasks in a Stage

Assign a User to Tasks in a Stage

Submit Tasks as Another User in a Stage

Retain Current User and Submit Task

Get all Tasks

Filter tasks by data hash

Move all tasks in a stage to the next stage

Use model predictions as an annotator

Consensus Projects

Get all Subtasks

Select your labels from a Consensus Project

Move Tasks

To Next Stage

To Complete

Reopen

Move Tasks Freely

Task Priority

End-to-End Example moving tasks through Projects