Issues and comments

Use issues and comments to provide direct labeling feedback or raise questions.

The issues and comments feature allows you and your team members to communicate ideas, point out labeling errors, and raise questions on specific assets directly in the labeling interface. Use this guide to learn how to use issues to collaborate with your team.

How it works

As an example, a common feedback loop between reviewers and labelers is:

  1. A labeler submits a label on an asset.

  2. The reviewer reviews the label and notices an issue. The reviewer creates an issue on the label.

  3. The labeler can find any issues on their labels in the Issues tab. Clicking on the issue will take them directly to the label with the issue.

  4. The labeler can either correct the issue and resolve the issue or comment on the issue to get more clarity from the reviewer.

Issues and comments operate at the project level, not the organizational level. Permissions for creating and modifying issues vary depending on the user's role. These same permissions apply to workforce user roles but only for labeled assets created by users in that workforce organization.

RolePermissions
Labeler- Can create issues on assets they have labeled in the project.
- Can update and delete their own issues on assets they have labeled.
- Can resolve and reopen their own issues.
- Can create, update, and delete issues on assets they have labeled.
Reviewer or Admin- Can create issues on any labeled asset.
- Can delete their own issues on any labeled asset.
- Can resolve and reopen issues on any labeled asset.
- Can create, update, and delete comments on any labeled asset.

Create an issue

An issue will only become visible to other team members once the asset exits the "To label" step (i.e., the asset is submitted or skipped). Issues created on assets in the "To label" step will not appear in the Issues tab.

To create an issue, follow these steps:

  1. Open the editor interface. You can do this by selecting any of the workflow steps ("To label", "To review", etc)

  2. Click on the issues icon in the top left corner to activate the tool.

  3. Click on the asset to indicate where you want to place the issue.

  4. In the New issue modal, enter the content for the issue (e.g., a problem description, a question about an annotation, etc.) in the text box.

  5. (Optional) Add a category for the issue. You can reuse an existing category or create a new one.

    If you choose to add a new issue category, you can add a category name and a description.

  6. Select Create issue to finish creating the issue.

View all issues for a project

  1. Select a project and go to the Issues tab.

  2. Filter the issues by state by selecting All, Open, or Resolved. Reminder: Issues will not appear in the Issues tab if the asset is still in the "To label" step. You must submit or skip the asset for the issue(s) to appear in the Issues tab.

Manage issue categories

You can manage issue categories from the Issues tab. Select Issue categories to create new categories or manage existing categories.

Additionally, you can filter by issue categories from the Issues tab. Select the dropdown menu at the top to view all categories.

Create a comment on an issue

  1. Go to the Issues tab and select an issue OR click on an issue in the editor.

  2. Enter your response to the issue in the Reply text box.

  3. Select Submit to create the comment.

Edit, resolve, or delete an issue

To resolve an issue, select Resolve at the bottom of the issue modal.

From the options menu, you can select Edit to change the content of the issue/comment, Resolve to close the issue, or Delete to remove it entirely. Access to these actions will vary based on permissions.

If you created the issue, you can drag and drop it to move its location on the asset.