Go to Classes to view, add, edit, and delete classes and attributes.

Import classes

You can import classes and their attributes from your computer or your existing projects.

Import classes from computer

To import classes from your computer:

  1. In Classes, click the import button.
  2. Select From computer.
  3. Drag and drop your JSON file or choose the file from your computer.

Learn more about the JSON format of the classes you want to import.

Import classes from existing project

To import classes from an existing projects:

  1. In Classes, click the import button.
  2. Select From existing project.
  3. Choose a project from the drop-down list.
  4. Click Import.

Add classes and attributes

Step 1: Type a class name

Go to Classes and type a class name.

Step 2: Choose how you’re going to use the class (Vector Projects and Text Projects only)

You can use the class for objects or tags. You can select one option only.

  • When you select Object, you’ll be able to assign the class to annotations.
  • When you select Tag, you’ll be able to use the class to assign tags to items from the editor.

❗️

  • This step is available in Vector Projects only.
  • You can’t complete Step 2 if there’s at least one item in your project that has the Completed status.

Step 3: Create an attribute group and add attributes

  1. To create an attribute group, click New Attribute Group and type an attribute group name.
  2. Under Attributes, type attribute names.

A class can have multiple attribute groups, and an attribute group can have multiple attributes.

To add a new attribute group, click New Attribute Group and repeat the steps mentioned above.

👍

Check Multiple selection if the attributes can exist simultaneously. When you do that, you'll be able to assign multiple attributes to an object or item. For example, if the object you're annotating is a black and orange car and Multiple selection is selected, you’ll be able to choose both black and orange from the list of attributes.

❗️

Don't check Allow multiple selection if the attributes can't exist simultaneously. For example, a dog can't be small-sized and medium-sized at the same time.

Step 4: Create another class (optional and available only to Vector Projects)

If you want to create a new class with the same settings (Object/Tag) as the current class, check the Create another class box.

Step 5: Save

Your changes won’t be saved automatically so make sure to click Save.

📘

Who can create classes?

Only Team Owners, Team Admins, and Project Admins can create classes.

Remove classes and attributes

To remove a class:

  1. In Classes, find the class you want to remove.
  2. Click the corresponding delete button.
  3. In the popup, click Delete.

❗️

  • You can't delete a class if it's used in at least one Completed image.
  • When you delete a class, you won't be able to recover it. Any objects that are assigned this class will be unclassified and any tags associated with it will be deleted.

To remove an attribute group:

  1. In Classes, expand the class whose attribute group you want to remove.
  2. Click the edit button.
  3. Click the delete button that corresponds to the attribute group.
  4. Click Save.

To remove an attribute:

  1. In Classes, expand the class that has the attribute you want to remove.
  2. Click the edit button.
  3. Click the X button that corresponds to the attribute.
  4. Click Save.

JSON file of imported classes

{
      "name": "Dog",
      "color": "#4e7b3a",
      "type": "object",
      "attribute_groups": [
        {
          "name": "Position",
          "is_multiselect": 0,
          "attributes": [
            {
              "name": "Labrador"
            }
          ]
        }
      ]
    }

Description:

  • "name": string - Class Name
  • "color": string - Class’s hex color code (e.g. #000000)
  • "type": string - Class type. It could either be object or tag.
  • "attribute_groups": array of objects - List of all the attributes
    • "name": string - Attribute Name

JSON file of exported classes

{
      "id": 1006843,
      "project_id": 72432,
      "name": "Cat",
      "color": "#bc1616",
      "type": "object",
      "createdAt": "2022-01-04T22:44:49.000Z",
      "updatedAt": "2022-01-05T00:13:11.000Z",
      "attribute_groups": [
        {
          "id": 214061,
          "class_id": 1006843,
          "name": "Breed",
          "is_multiselect": 0,
          "createdAt": "2022-01-05T00:09:12.000Z",
          "updatedAt": "2022-01-05T00:09:28.000Z",
          "attributes": [
            {
              "id": 1142810,
              "group_id": 214061,
              "project_id": 72432,
              "name": "British Shorthair",
       "count": 0,
              "createdAt": "2022-01-05T00:09:31.000Z",
              "updatedAt": "2022-01-05T00:09:31.000Z"
            }
          ]
        }
      ]
    }

Description:

  • "id": integer - Class ID
  • "project_id": integer - Project ID
  • "name": string - Class Name
  • "color": string - Class’s hex color code (e.g. #000000)
  • "type": string - Class type. It could either be object or tag.
  • "createdAt": string - The time the class was created.
  • "updatedAt": string - The last time a user updated the class.
  • "attribute_groups": array of objects - List of all the attributes
    • "id": integer - Group ID
    • "class_id": integer - Class ID (must be the same as “id”)
    • “name”: string - Attribute Name
    • "is_multiselect" : integer - It’s either 0 or 1. It’s 1 if you can select multiple attributes, and it’s 0 if you can choose only one attribute.
    • "createdAt": string - The time the attribute group was created.
    • "updatedAt": string - The last time a user updated the attribute group.
    • "attributes": array of objects - List of attribute values.
      • "id": integer - Attribute value ID
      • "group_id": integer - Group ID (must be the same as “id”)
      • "project_id": integer - Project ID
      • "name": string - Attribute value
      • "count": integer - The number of attributes.
      • "createdAt": string - The time the attribute was created.
      • "updatedAt": string - The last time a user updated the attribute.

Did this page help you?