Creating a workflow for your project automates a good portion of the annotation process. This tool can be found in the Setup section of the FineTune tab in the left panel. It is useful for cases such as pose estimation tasks.

With SuperAnnotate, you can create a workflow for your project in two ways: General flow, and Keypoint annotation flow. Read on to find out more about them.

General flow

general flow

This workflow method allows you to create an automated set of steps with which to apply instances using pre-selected tools. You can create object classes and, by adding them to the workflow, assign them different annotation tools.

This can be useful when annotating images that contain various shapes that require classification.

Create a general flow

Step 1: Create the required classes

  1. In Setup, go to Classes.
  2. Create any number of classes (object) and name them accordingly.

These classes will be assigned tools during the workflow process, so be sure to name them something to help you when applying the workflow.

Step 2: Set up the workflow

set up general flow

  1. In Setup, go to Workflow and click New Workflow.
  2. Select General flow.
  3. Click + New Step to begin adding steps. This'll create a new empty step.
  4. From the dropdown, select a class.
  5. If you’ve given the class any attributes, select an attribute (optional).
  6. Assign an annotation tool to the step.
  7. Repeat steps 3-6 as many times as necessary. You can select the same class and/or attribute more than once.

📘

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

🚧

Magic Polygon, Magic Select, and Magic Box can’t be assigned to a step here.

Step 3: Use the workflow

You can start using your newly created workflow in the Image Editor now. Learn more.

Delete workflow

To delete a General flow workflow:

  1. In Setup, go to Workflow.
  2. Next to a step, click the Delete button.
  3. Repeat this with all steps. Once the last step has been removed, the workflow will be deleted.

Keypoint annotation workflow

This workflow method will allow you to make direct connections between each point you assign. Keypoint workflow is used for cases such as Skeleton annotation and Pose estimation tasks.
keypoint workflow

Create keypoint workflow

Step 1: Create the required classes

  1. In Setup, go to Classes.
  2. Create any number of classes (object) and name them accordingly.

These classes will be assigned tools during the workflow process, so be sure to name them something to help you when applying the workflow.

Step 2: Set up the workflow

set up keypoint workflow

To manually set up a keypoint annotation flow:

  1. In Workflow, click New Workflow and select Keypoint annotation flow. You'll see the first step is already added for you.
  2. Assign a class.
  3. Choose an attribute, if available (optional).
  4. Click + New Step to make a new step.
  5. Choose connections for your steps to link them. You need at least two steps to do this.
  6. Repeat the process as many times as necessary.
  7. Click Save.

You’ll notice that you have two switches above your steps: Apply the workflow, and Automatic class change.

Switching Apply the workflow on will enable the use of this workflow in the editor.

Switching Automatic class change on will make sure that the classes will change automatically during the workflow annotation process.

📘

You can click and drag the reorder button ⋮⋮ to change the order of the steps.

Step 3: Use the workflow

You can start using your newly created workflow in the Image Editor now. Learn more.

Download keypoint workflow

To download a keypoint workflow:

  1. Go to Workflow.
  2. Click the three dots in the top right.
  3. Click Download.

Upload keypoint workflow

To upload an existing keypoint annotation flow:

  1. In Workflow, click New Workflow and select Upload keypoint annotation flow.
  2. Choose a JSON file from your computer that contains the steps. Learn more.
  3. You may have to assign classes to the steps manually.

When uploading a workflow, the new JSON file will override the previous one.

JSON of keypoint workflow

{
    "steps": [
      {
        "id": 1,
        "class_id": 1639565,
        "attribute": []
      },
      {
        "id": 2,
        "class_id": 1639564,
        "attribute": []
      },
      {
        "id": 3,
        "class_id": 1639563,
        "attribute": []
      }
    ],
    "connections": [
      [1,2],
      [2,3]
    ]
  }

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.

Delete keypoint workflow

To delete a keypoint workflow:

  1. Go to Workflow.
  2. Click the three dots in the top right.
  3. Click Delete.
  4. In the pop-up, click Delete.