Issues
This guide explains how to use the Issues feature in Encord. Each step in the process is intended for a specific user role, which is indicated in the heading of that step.
This guide assumes you have already added data into Encord and set up your annotation Projects.
STEP 1: [Org Admin] Create Issue Tags
This step must be performed by Organization admins.
More information can be found in the Issue Tags documentation.
Issue tags serve as a labeling system that helps to categorize, group, and filter issues within Projects.
-
Click My Organization. The Organization page appears.
-
Navigate to the Issue Tags tab. The Issue Tags page appears.
-
Click + New issue tag to create a new issue tag for your Organization.
-
Give your Issue Tag a meaningful name and press ENTER to create the Issue Tag.
-
Repeat Steps 3 and 4 to create as many Issue Tags as necessary.
STEP 2: [Admin] Add Issue Tags
This step must be performed by a Project admin.
-
Navigate to your annotation Project.
-
Navigate to the Settings tab.
-
Click the dropdown in the Issue tags section.
-
Select, or type the name of, the issue tag you want to add to the Project.
STEP 3: [Annotator / Reviewer] Create Issues
This step can be performed by any user role that can create annotations: Admin, Team Manager, Annotator, or Annotator + Reviewer.
More information can be found in the Issues documentation.
STEP 4: [Annotator / Reviewer] Resolve Issues
This step can be performed by any user role that can create annotations or reviews: Admin, Team Manager, Annotator, Reviewer, or Annotator + Reviewer.
More information can be found in the Issues documentation.
-
Open a task from the Queue tab of your annotation Project. Rejected tasks The Label Editor with the Issues pane already opened appears.
-
Address the problem raised by the Issue.
-
Add a reply to the Issue acknowledging the issue has been addressed.
-
Resolve the Issue by clicking the tick icon on the thread.
STEP 5: [Admin] Issue Analytics
This step must be performed by a Project admin or Team Manager.
The number of issue actions taken by each Project collaborator can be viewed in the Collaborators tab.
-
Navigate to the Analytics tab of your Project.
-
Navigate to the Issues section. Analytics pertaining to Issues appear.
Chart | Description |
---|---|
Issue actions | Shows the number of issues created, resolved, and opened. |
Issue tag occurrence | Shows the count of all issue tags used within the chosen timeframe. |
Issue tag occurrence by class | Shows the actions taken for all objects and classifications in the Ontology. |
The Issue actions chart shows the following:
- Total issues created: The total number of issues created.
- Total issues resolved: The number of issues marked as resolved.
- Total issues reopened: The number of issues that were reopened.
Example - How to Understand Issue Analytics:
If your Issue actions chart shows:
- Total issues created = 19
- Total issues resolved = 20
- Total issues reopened = 2
This means that:
- 19 issues were created.
- All 19 issues were resolved.
- 2 resolved issues were reopened. (This includes manually reopening an issue and re-rejections of labels)
- 1 of the reopened issues was resolved.
- There is one remaining open issue.