Project Settings

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.

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

A complete walkthrough of all things Issues and Comments related can be found here.

Issue tags allow you to:

• Flexibly categorize and group your issues within Projects.
• Get insights on issues being created by collaborators.

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 individual collaborators to a Project:

1. Click the + Invite collaborators button. A dialog appears.

2. Select a user role for the collaborators you want to add by selecting an option from the list.

3. Type the email addresses of the users you want to add and select the user from the list.

4. Click the Add button to add the users with the specified role.

To add collaborators as a group:

To add collaborators as a group, your Organization needs to have user groups. Navigate to our documentation on creating user groups for more information.

Only group members are added, not group managers.

1. Select Groups. The Manage groups screen appears.

2. Click Manage.
3. Click the Select group drop-down and pick a group you want to add to the Project.
4. Click the Select Role drop-down to assign a role to the group of collaborators.
5. Click Add to add the group to the Project.

To delete a group from the Project, click the Delete button next to the group name.

To change collaborator roles:

Only Project admins can modify collaborator roles. Admin roles cannot be changed, not even by other admins.

1. Ensure Individuals is selected.
2. Click the user’s role you want to change.
3. 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.

Introduction to custom editor layouts for DICOM - Video Tutorial

Introduction to custom editor layouts (Client metadata) - Video Tutorial

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:

topLevelGridFilter

In Workflow Projects, tasks with matching values in the field specified by the topLevelGridFilter progress through the Workflow as a unit. When encord-LayoutGroup is set as the topLevelGridFilter, for example, tasks sharing the same encord-LayoutGroup value are opened, submitted, reviewed, and reopened together, enabling seamless coordination across the Workflow. This behavior does not apply in Manual QA Projects.

The operator value must be =. This means the value must be equal to.

"topLevelGridFilter": {
  "client_metadata": {
    "key": "encord-LayoutGroup",
    "operator": "="
  }
}

Another example is displaying images from the same patient together in the Label Editor using the topLevelGridFilter to group tasks based on a patient-id.

"topLevelGridFilter": {
  "client_metadata": {
    "key": "patient-id",
    "operator": "="
  }
}

grid

The grid key defines the basic layout of the Label Editor. The grid is a list of lists, where each value represents a window.

In the following example, the values 0, 1, 2, and 3 represent individual windows. The layout is defined as two separate lists [0, 1] and [2, 3], resulting in a 2x2 grid configuration:

  "grid": [[0, 1], [2, 3]]

This configuration translates to the following visual layout:

gridContent

The gridContent key specifies what content to display in each window defined in the grid. It includes the following elements:

• Grid Values: Assigns content to each window based on its grid value.

• Content Query: Defines the criteria for displaying content, which can be either dicom_tags_query or client_metadata_query.

• Conditions: Specifies the conditions for displaying the content, which can be either and_conditions or or_conditions.

• Operator value can only be =. This means the value must be equal to.

In the following example, window 0 displays content based on a dicom_tags_query with specific conditions.

• The dicom_tags_query specifies that the content is determined by DICOM tags.
• The and_conditions key specifies that all conditions listed must be met for the content to be displayed.
• There are two conditions:
  1. The DICOM tag 00185101 must equal CC.
  2. The DICOM tag 00200062 must equal R.

This setup ensures that the content for window 0 is only displayed if both conditions are satisfied.

  "gridContent": {
    "0": {
      "dicom_tags_query": {
        "and_conditions": [
          {
            "tag": "00185101",
            "operator": "=",
            "value": "CC"
          },
          {
            "tag": "00200062",
            "operator": "=",
            "value": "R"
          }
        ]
      }
    }
    }

In the following example, window 1 displays content based on a client_metadata_query with specific conditions.

• The client_metadata_query specifies that the content is determined by client metadata.
• The or_conditions key specifies that any of the conditions listed must be met for the content to be displayed.
• There are two conditions:
  1. The client metadata group-id must equal A.
  2. The client metadata group-id must equal B.

This setup ensures that the content for window 1 is only displayed if the group-id is either A or B.

  "gridContent": {
    "1": {
      "client_metadata_query": {
        "or_conditions": [
          {
            "key": "group-id",
            "operator": "=",
            "value": "A"
          },
          {
            "key": "group-id",
            "operator": "=",
            "value": "B"
          }
        ]
      }
    }
  }

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:

• clientMetadata here.
• DICOM Tags here.

---

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.

Deleting your Project does not delete the Datasets attached to the Project, but it does delete the Project’s labels and Ontology.