Issues

Documentation Index

Fetch the complete documentation index at: https://docs.encord.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Issues End-to-End Guide

​

STEP 1: [Workspace Admin] Create Issue Tags

1. Click Settings in the My workspace section. The Users page appears.
2. Navigate to the Issue Tags tab. The Issue Tags page appears.
3. Click + New issue tag to create a new issue tag for your Workspace.

4. Give your Issue Tag a meaningful name and press ENTER to create the Issue Tag.
5. Repeat Steps 3 and 4 to create as many Issue Tags as necessary.

​

Delete Issue Tags

1. Click the delete icon next to the issue tag you want to remove.
2. Confirm the deletion when prompted.

1. Select the checkboxes next to the issue tags you want to delete.
2. Click the Delete selected button that appears.
3. Confirm the bulk deletion when prompted.

​

STEP 2: [Admin] Add Issue Tags

1. Navigate to your annotation Project.
2. Navigate to the Settings tab.
3. Click the dropdown in the Issue tags section.
4. Select, or type the name of, the issue tag you want to add to the Project.

​

STEP 3: [Annotator / Reviewer] Create Issues

​

Tile Selection for Data Groups

• View issues specific to each tile
• Create issues that apply to a particular tile
• See validation warnings for missing required annotations across all tiles

[Reviewer] Create Label Rejection Issues

1. Open a review task from the Queue tab of your annotation Project.
2. Reject a label. The Issues pane opens.
3. Select any Issue Tags you want to apply to the issue.
4. Add a comment explaining why the label is being rejected.
5. Click Reject to create the label rejection Issue.

6. Click Reject task to reject the task.

[Annotator / Reviewer] Create Other Issues

1. Open a task from the Queue tab of your annotation Project.
2. Open the Issues pane by clicking the Issues icon.
3. For data groups with multiple tiles, select the specific tile the issue applies to using the tile selector dropdown.
4. Click the New issue icon (or keyboard shortcut Ctrl+N).
5. Click the Apply to dropdown to select the type of issue you want to create.
6. Select any Issue Tags you want to apply to the issue.
7. Add a comment to the issue.
8. If you selected ‘Pin on canvas’ in Step 5, click the desired location on the canvas.
9. Click Create issue.

​

Multi-Tile Validation

• Per-tile validation: Required classifications and attributes are checked on each tile separately
• Visual indicators: The Issues panel shows which tiles have missing required annotations
• Tile-specific issues: Missing annotation issues are created for the specific tile where they’re absent

​

STEP 4: [Annotator / Reviewer] Resolve Issues

​

Filter Issues

1. Open the Issues pane by clicking the Issues icon.
2. Click the Filter button to access filtering options.
3. Use the available filters:
   • Resolution status: Filter by resolved, unresolved, or all issues
   • Issue types: Filter by specific issue types (data unit, frame, annotation, etc.)
   • Issue tags: Filter by specific issue tags (if any are configured for your project)
   • Object class: Filter by specific object or classification classes from your ontology
   • Comment keyword: Search for specific text within issue comments
4. Select your desired filter criteria. The issues list updates automatically to show only matching issues.
5. To clear all filters, click Clear filters or use the Clear filters button that appears when no issues match your current filter.

​

Resolve Issues

1. Open a task from the Queue tab of your annotation Project. Rejected tasks The Label Editor with the Issues pane already opened appears.
2. Address the problem raised by the Issue.
3. Add a reply to the Issue acknowledging the issue has been addressed.
4. Resolve the Issue by clicking the tick icon on the thread.

​

STEP 5: [Project Admin / Team Manager] Issue Analytics

1. Navigate to the Analytics tab of your Project.
2. Navigate to the Issues section. Analytics pertaining to Issues appear.

• 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.

• Total issues created = 19
• Total issues resolved = 20
• Total issues reopened = 2

• 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.

​

Creating Issues With Agents

from encord import EncordUserClient
from encord.workflow import AgentStage

# User input
SSH_PATH = "<private_key_path>"  # Replace with the file path to your SSH private key
PROJECT_ID = "<project_id>"      # Replace with the unique Project ID
AGENT_STAGE_NAME = "<agent_stage_name>"  # Replace with the name of your Agent stage

# --- Connect to Encord ---
user_client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH,
    # For US platform users use "https://api.us.encord.com"
    domain="https://api.encord.com",
)

# Get Project and Workflow
project = user_client.get_project(PROJECT_ID)
workflow = project.workflow

# Get the Agent stage and iterate over its tasks
agent_stage = workflow.get_stage(name=AGENT_STAGE_NAME, type_=AgentStage)
for task in agent_stage.get_tasks():

    # List all existing issues on the task
    existing_issues = list(task.issues.list())
    print(f"Task {task.uuid} has {len(existing_issues)} existing issue(s)")

    # Add a file-level issue (applies to the entire data unit)
    task.issues.add_file_issue(
        description="File is corrupted or unreadable",
    )

    # Add a frame-level issue (applies to a specific frame)
    task.issues.add_frame_issue(
        frame=0,
        description="Motion blur makes annotation impossible on this frame",
    )

    # Add a coordinate-level issue (applies to a specific location within a frame)
    task.issues.add_coordinate_issue(
        frame=0,
        x=0.5,
        y=0.5,
        description="Ambiguous object boundary at this location",
    )

    print(f"Issues added to task {task.uuid}")