The Project Settings are accessed using the Settings tab of your Project. The Settings tab is only visible to Project Admins and Team Managers.

​
Copy Project

To copy a Project:
  1. Click the Copy project button in the Options section of the Project’s Settings.
  2. Select the components of the Project you want to copy into the new Project. The Ontology must be copied and is therefore always selected. All components of the current Project are selected by default.
You can copy any combination of the following assets:
  • Datasets – All Datasets are copied.
  • Labels – Copies labels in specified data units. By default, all labels are included. To copy only specific labels, select Selected Labels from the dropdown. Click +Advanced settings to filter labels by status.
  • Models – Copies all models in the Project, including their training logs.
  • Collaborators – Copies all Project users along with their roles. Project admins are always included.
  1. Click the Make a copy button to copy the Project with the specified components.

​
Upload Annotation Instructions

  1. Navigate to the Settings tab of your Project.
  2. Click the Upload PDF button to upload instructions for your annotators in PDF format. Once uploaded, annotation instructions are be accessible within the Label Editor, and the Workflow tab of your Project.
To ensure the best possible results, provide as much detail as possible about what you would like annotated and how precise bounding boxes should be drawn. For example, instead of saying ‘person’, consider defining what should constitute a person for your annotators - only a full person? A torso? Or should any part of a person in a frame be labeled as a ‘person’? The more specific your annotator instructions, the higher the chances that your annotators perform well.
Once uploaded, annotation instructions are accessible within the Label Editor, and the Workflow tab of your Project.

​
Project Tags

Project tags are created and managed on the Organization level. Once created for the Organization they can be added to individual Projects.
Project tags allow you to:
  • Flexibly categorize and group your Projects.
  • Filter your list of Projects by tag.
To add or remove Project tags:
  1. Navigate to the Settings tab in a Project and click the Project tags drop-down. All available tags in your Organization are shown.
  2. Click on a tag to add it to a Project.
Remove a tag from your Project by clicking the same tag again, or clicking the x button next to its name.

​
Issue Tags

Issue tags can be created and managed on the Organization level by Org admins, or on the Project level by Project admins.
A complete walkthrough of all things Issues and Comments related can be found here.
Issue tags allow you to: To add or remove Issue tags from Projects:
  1. Navigate to the Settings tab for a Project and click the Issue tags drop-down. All available tags in your Organization are shown.
  2. Click on a tag to add it to the Project.
  3. (Optionally) Create a new tag by typing the name of the tag and hitting ENTER.
Remove an issue tag from your Project by clicking the same tag again, or clicking the x button next to its name.

​
Ontology Settings

You can view or switch the Ontology attached to your Project.
Changing the Ontology can render existing labels invalid and lead to data inconsistency.
  • Click the Switch ontology button to switch the Ontology linked to your Project. The resulting pop-up allows you to choose an existing Ontology from a list, or create a new Ontology for this Project.
  • Click the View ontology button to view the details of the Ontology that is attached to the current Project.

​
Preload Next Task

Turning on the Enable task media preloading feature preloads the next task in the background while the user is working in the Label Editor. This reduces wait times for the next task after submitting a task. This setting is disabled by default. When enabled, the preloaded task is automatically assigned to the user, preventing others from initiating it.
  • This feature is only supported for single images.
  • Only the image is preloaded. Labels are not preloaded.

​
Change Datasets Attached to a Project

The Datasets section of the Options pane shows all the Datasets attached to a Project.
To add Datasets:
  1. Click Manage.
  2. Navigate to All datasets.
  3. Click Attach next to the Dataset(s) you want to add to the Project.
To remove Datasets:
  1. Click Manage.
  2. Ensure the Attached section is displayed.
  3. Click Detach next to the name of the Dataset you want to remove from the Project.

​
Manage Project Collaborators

To manage Project collaborators, select the Team pane in your project Settings. Collaborators can be added individually or as groups of users. To add collaborators to a Project:
  1. Search for the collaborator or the group you want to add. Multiple collaborators and groups can be added at once.
Only group members are added when a group is assigned to a Project. Group managers are not included.
  1. Select a user role.
    • Annotator: Can access and label tasks in all or selected Annotate stages in the Project.
    • Reviewer: Can access and review tasks in all or selected Review stages in the Project.
    • Annotator & Reviewer: Performs both annotation and review tasks.
    • Team Manager: Can access and label tasks in all stages in the Project. Can move, assigns, prioritize tasks to users. Can manage Project collaborators.
    • Admin: Grants full administrative control over the Project.
  2. Click Add to project.
To remove a user or group from the Project click the Delete icon in the Unassign column.
Import collaborators using a CSV:
  1. Click Actions.
  2. Select Import collaborators.
  3. Add the CSV file containing users and their roles.
  4. Click Submit.
CSV files must be formatted in the following manner: 
Email,Role,Group
david@acme.com,Admin,
adam@acme.com,Annotator,
joe@acme.com,Annotator,
To change collaborator roles:
Only Project admins can modify collaborator roles. Admin roles cannot be changed, not even by other admins.
  1. Click the user role in the Role column
  2. Select a new role from the dropdown.
You can assign the following roles to collaborators:
  • Annotator: Labels tasks in the Project.
  • Reviewer: Reviews and validates labeled tasks.
  • Annotator & Reviewer: Performs both annotation and review tasks.
  • Team Manager: Assigns tasks to users and manages Project collaborators.
  • Admin: Grants full administrative control over the Project. This action is irreversible.

​
Custom Editor Layout

You can customize the default Label Editor layout by uploading a JSON file that defines your preferred arrangement. These JSON files can be added in the Project settings and are applied to all tasks in a Project. Custom editor layouts depend on a file’s client_metadata or their DICOM tags. This means that custom editor layouts only work for files that contain client_metadata or DICOM tags. Watch the video tutorials below to learn how it fits together.
To upload an editor layout:
  1. Navigate to the Project settings.
  2. Click on Editor Layouts.
  3. Click Upload JSON.
  4. Select the JSON file containing the layout you want the Label Editor to have.
JSON file requirements: The JSON file must follow the JSON schema defined here. The following fields are required:
Complete example
1

Add client metadata to files

Editor layouts are based on DICOM tags for DICOM files or on client_metadata for all other use cases. We provide templates for common mammography layouts based on DICOM tags here.This example uses client_metadata. The following SDK script can be used to add client metadata to specific data units in a Dataset.
from encord import EncordUserClient
from encord.client import DatasetAccessSettings

# Instantiate Encord client by substituting the path to your private key
user_client = EncordUserClient.create_with_ssh_private_key(
                ssh_private_key_path="<private_key_path>",
            )


# Specify a Dataset to read or write metadata to
dataset = user_client.get_dataset("<dataset_hash>")

# Fetch the Dataset's metadata
dataset.set_access_settings(DatasetAccessSettings(fetch_client_metadata=True))

# Add your file names and client metadata here
layouts = {
  'Image1.jpg': {"encord-EditorGridPosition": "A", 'encord-LayoutGroup': '1'},
  'Image2.jpg': {"encord-EditorGridPosition": "B", 'encord-LayoutGroup': '1'},
  'Image3.jpg': {"encord-EditorGridPosition": "A", 'encord-LayoutGroup': "2"},
  'Image4.jpg': {"encord-EditorGridPosition": "B", 'encord-LayoutGroup': '2'},
  'Image5.jpg': {"encord-EditorGridPosition": "A", 'encord-LayoutGroup': '1'},
  'Image6.jpg': {"encord-EditorGridPosition": "B", 'encord-LayoutGroup': '1'},
  'Image7.jpg': {"encord-EditorGridPosition": "A", 'encord-LayoutGroup': "2"},
  'Image8.jpg': {"encord-EditorGridPosition": "B", 'encord-LayoutGroup': '2'},
  'Image9.jpg': {"encord-EditorGridPosition": "A", 'encord-LayoutGroup': "1"},
  'Image10.jpg': {"encord-EditorGridPosition": "B", 'encord-LayoutGroup': '1'},
  'Image11.jpg': {"encord-EditorGridPosition": "A", 'encord-LayoutGroup': "2"},
  'Image12.jpg': {"encord-EditorGridPosition": "B", 'encord-LayoutGroup': '2'},
}

for dr in dataset.data_rows:
  dr.client_metadata = layouts[dr['data_title']]
  print (dr.title)
  print (dr.client_metadata)
  dr.save()
2

Create a JSON file

Create a JSON for specifying the editor layout that suits your needs.In the JSON file below:
  • The grid arrangement is configured to display two files side by side in the Label Editor.
  • The gridContent section specifies that tasks in either position (0 or 1) can have client metadata values for encord-EditorGridPosition set to either A or B.
  • The topLevelGridFilter is defined as encord-LayoutGroup, meaning tasks with matching encord-LayoutGroup metadata values are displayed together in the Label Editor, ensuring they appear side by side when they share the same encord-LayoutGroup values. 
    {
  "grid": [
    [0],
    [1]
  ],
  "gridContent": {
    "0": {
      "client_metadata_query": {
        "or_conditions": [
          {
            "key": "encord-EditorGridPosition",
            "operator": "=",
            "value": "A"
          },
          {
            "key": "encord-EditorGridPosition",
            "operator": "=",
            "value": "B"
          }
        ]
      }
    },
    "1": {
      "client_metadata_query": {
        "or_conditions": [
          {
            "key": "encord-EditorGridPosition",
            "operator": "=",
            "value": "A"
          },
          {
            "key": "encord-EditorGridPosition",
            "operator": "=",
            "value": "B"
          }
        ]
      }
    }
  },
  "topLevelGridFilter": {
    "client_metadata": {
      "key": "encord-LayoutGroup",
      "operator": "="
    }
  },
  "$schema": "https://raw.githubusercontent.com/encord-team/Annotate/main/editor-layouts/editor_layout_schema.json"
}
3

Create a JSON file

Upload the JSON file to your Project in Encord.
  1. Navigate to the Project settings.
  2. Click on Editor Layouts.
  3. Click Upload JSON.
  4. Select the JSON file containing the layout you want the Label Editor to have.
4

Create a JSON file

Open any task in the task queue of your Project.The JSON file in this example results in the following Label Editor layout.
We provide end-to-end walkthroughes for how to set up custom editor layouts using:

​
Delete Project

You can delete your Project by going to the Danger zone tab of the Project settings. To delete a Project, click the red Delete project button. Delete Project
Deleting your Project does not delete the Datasets attached to the Project, but it does delete the Project’s labels and Ontology.