Workflow

Set up a project workflow

As a Project Admin, you can create a workflow to distribute accurate annotation instructions and steps to help your team save time.

To create a project workflow:

1. In Setup > Workflow, click Create Workflow.
2. To add a step, choose a class.
3. Choose an attribute (optional).
4. Choose the annotation tool from the drop-down menu. The Magic Polygon can't be used in the workflow.
5. Select New Step to add more steps.
6. To automate the workflow, check the Automatic class change box.
7. To apply the workflow, check the Apply the workflow box.

📘

Click and drag the reorder button to change the order of the steps.

📘

Workflow automation

When you check the Automatic class change box, your workflow will be automated, which means that when an Annotator goes to the editor, the class and the tool of the first step will automatically be selected. When the Annotator finishes completing the first step, the class and the tool of the second step will automatically be selected, and so on.

Keypoint workflow

The keypoint workflow guides you to annotate the right parts of the image in the Image Editor in the right sequence. The steps that are connected to each other will have their corresponding keypoints connected. This helps with projects where you need to use templates like annotating faces, hands, etc.

Example:

• Step 1: Top-right corner of the door
• Step 2: Top-left corner of the door
• Step 3: Bottom-left corner of the door
• Step 4: Bottom right corner of the door

All the steps in a workflow belong to one group. In the case of the example above, all 4 keypoints will be part of Group 1. The other set of keypoints will belong to another group.

Create keypoint workflow

To create a keypoint workflow:

1. In Workflow, click New Workflow and select Keypoint annotation flow.
2. To add the first step, choose a class.
3. Choose an attribute, if available. This step is optional.
4. Choose a connection or multiple connections.
5. Select New Step to add more steps.
6. Click Save.
7. To automate the workflow, check the Automatic class change box.
8. To apply the workflow, check the Apply the workflow box.

Click and drag the reorder button to change the order of the steps.

📘

Workflow automation

When you check the Automatic class change box, your workflow will be automated, which means that when an Annotator goes to the editor, the first step will automatically be selected. When the Annotator finishes completing the first step, the second step will automatically be selected, and so on.

Upload keypoint workflow

To upload a keypoint workflow:

1. In Workflow, click New Workflow and select Upload keypoint annotation flow.
2. Choose a JSON file from your computer that contains the steps.
3. To automate the workflow, check the Automatic class change box.
4. To apply the workflow, check the Apply the workflow box.

JSON of keypoint workflow

{
  "steps": [
    {
      "id": 11,
      "class_id": 1,
      "attribute": []
    },
    {
      "id": 13,
      "class_id": 1,
      "attribute": []
    },
    {
      "id": 15,
      "class_id": 1,
      "attribute": [
           {
               "attribute":{
                  "id": 115,
                  "group_id": 215
               }
           },
           {
               "attribute":{
                  "id": 116,
                  "group_id": 215
               }
           }
       ]
    },
    {
      "id": 17,
      "class_id": 2,
      "attribute": []
    },
    {
      "id": 19,
      "class_id": 3,
      "attribute": []
    }
  ],
  "connections": [
    [11,13],
    [11,15],
    [13,15],
    [15,17],
    [17,11]
  ]
}

Description:

• “steps”: array of objects - List of information for each step.
  • “id”: integer - Step ID.
  • “class_id”: integer - Class ID. It must match the existing class ID in the project.
  • “attribute”: array of objects - List of attributes for this step.
    • “id”: integer - Attribute ID. It must match the existing attribute ID in the project (optional).
    • “group_id”: integer - Attribute group ID. It must match the existing attribute group ID in the project (optional).
• “connections”: array of objects - List of the connected steps by step IDs.

Update keypoint workflow

You can update your keypoint workflow by uploading a new JSON file. To do that:

1. Go to Workflow.
2. Click Upload.
3. Choose a JSON file from your computer.

The new JSON file will override the previous one.

Delete keypoint workflow

To delete a keypoint workflow:

1. Go to Workflow.
2. Click the delete button of the workflow you want to delete.
3. In the popup message, click Delete.

Download keypoint workflow

To download a keypoint workflow:

1. Go to Workflow.
2. Click the download button of the workflow you want to download.