Follow the end to end walkthrough below to learn how to set up a custom Label Editor configuration based on client metadata. This End-to-end example assumes you configure the Label Editor so that two files are displayed at a given time.

This end-to-end example assumes that:

  • You have Custom Editor Layouts enabled. Contact support for access.
  • Your files are stored in cloud storage.

​
STEP 1: Create Metadata Schema

Use the Encord SDK to import a metadata schema into Encord. The fields encord-layout-group and encord-editor-grid-position are the key client metadata used later for configuring the Label Editor layout. If you need to add additional client metadata to your schema, include them in the script below.

Read more about metadata schemas here.

Metadata schema import example

# Import dependencies
from encord import EncordUserClient
from encord.metadata_schema import MetadataSchema

SSH_PATH = "/Users/chris-encord/ssh-private-key.txt"

# Authenticate with Encord using the path to your private key
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH
)

# Create the schema
metadata_schema = user_client.metadata_schema()

# Add display parameters for data appearing in custom editor layouts
metadata_schema.add_scalar("encord-layout-group", data_type="varchar")
metadata_schema.add_scalar("encord-editor-grid-position", data_type="varchar")

metadata_schema.save()

​
STEP 2: Create JSON file for data import

Before importing your cloud data to Encord you must first create a JSON file specifying the files you want to import.

When the audioMetadata, imageMetadata, or videoMetadata flags are present in the JSON file, we directly use the supplied metadata without performing any additional validation, and do not store the file on our servers. It is crucial that the metadata you provide is accurate. For most applications these flags can be omitted.

All of the following examples import 4 objects with the following client metadata:

  • encord-editor-grid-position: Can take the values A or B. A and B are the two possible positions inside the Label Editor.
  • encord-layout-group: Files with the same encord-layout-group values are displayed concurrently in the Label Editor

​
STEP 3: Import files into Encord

​
Create a folder to store your files

All files in Encord must be stored within folders. Therefore, you need to create a folder before uploading any data to Encord. To create a folder:

  1. Navigate to Files under the Index heading in the Encord platform.
  2. Click the + New folder button to create a new folder. A dialog to create a new folder appears.

  1. Give the folder a meaningful name and description.

  2. Click Create to create the folder. The folder is listed in Files.

​
Import your files

You can import your audio data, using the JSON file you created, using the UI or the SDK.

​
STEP 4: Set up your Project

​
Create a Dataset

  1. Click the New dataset button in the Datasets section in Annotate.
  1. Give your Dataset a meaningful title and description. A clear title and description keeps your data organized.
Toggle Looking to create a mirrored dataset? to create a Mirrored Dataset.
  1. Click Create dataset to create the Dataset.

​
Attach files

You can add data to Datasets from the Files or the Datasets screens.
We recommend uploading smaller batches of data: limit uploads to 100 videos and up to 1000 images at a time. You have the option to create multiple Datasets, all of which can be linked to a single Project. Familiarize yourself with our limits and best practices for data import before uploading data to Encord.
  1. Navigate to the Datasets section under the Annotate heading.
  2. Click the Dataset you want to attach data to.
  3. Click +Attach existing files.
If the files you want have not been uploaded into Encord yet, click +Upload files to upload new files.

  1. Select the folders containing the files you want to attach to the Dataset. To select individual files, double-click a folder to see its contents, and select the files you want to add to the Dataset.

  2. Click Attach data to attach the selected files to the Dataset.

​
Create an Ontology

We recommend learning about Ontology structure in Encord before creating Ontologies.
  1. Click the New ontology button in the Ontologies section to create a new Ontology.

  1. Give your Ontology a meaningful title and description. A clear title and description keeps your Ontologies organized.

  2. Click Next to continue.

  1. Define your Ontology structure. See our documentation on Ontology structure for more information on the various types of objects, classifications, and attributes.

To add objects:

Ensure that you add Audio Region objects for audio files and Text Region objects for text files.
  1. Click Add object to create a new object.
  2. Give the object a name. For example “Apple”.
  3. Select a shape for the object. For example polygon.
  4. Optionally, enable the Required toggle to mark the object as Required.
  5. Optionally, add attributes to the object.
  6. Repeat these steps for as many objects as necessary.

To add attributes to an object:

You can add attributes to objects that define the object’s characteristics. For example the object “Apple” can have an attribute “Color”.

  1. Click the arrow icon next to an object to add attributes to the object.

  2. Give the attribute a name. For example “Color”.

  3. Click the attribute type to change the attribute type. The default attribute type is a text field.

  4. Click Add option to add an option, if you have chosen a radio button or checklist attribute.

  5. Enter a name for the attribute option. For example, the attribute “Color” can have the options “Red”, “Green”, and “Yellow”.

  6. Click the Back to parent button to return the Ontology creation view.

To add a classification:

  1. Click Add classification to create a new classification.
  2. Give the classification a name. For example, “Time of day”.
  3. Optionally, configure the classification. The default classification type is a text field.
  4. Optionally, enable the Required toggle to mark the object as Required.
  5. Repeat these steps for as many classifications as necessary.

Configure classifications:

You can configure classifications to change the classification type, and to add classification options to radio buttons and check lists.

  1. Click the arrow icon next to an object to configure the classification.
  1. Click the classification type to change the classification type. The default classification type is a text field.
  2. Click Add option to add an option if you have selected a radio button or check list classification.
  3. Enter a name for the classification option. For example, the classification “Time of day” can have the options “Night” and “Day”.
  4. Click the Back to parent button to return the Ontology creation view.

​
Create a Project

  1. In the Encord platform, select Projects under Annotate.
  2. Click the + New annotation project button to create a new Project.
  1. Give the Project a meaningful title and description.

If you are part of an Organization, an optional Project tags drop-down is visible. Project tags are useful for categorizing and finding your Projects. Select as many tags as are relevant for your Project.

  1. Click the Attach ontology button.

  2. Select the Ontology you created previously from the list using the Select button.

  1. Click OK to attach the Ontology to the Project.

  2. Click the Attach datasets button.

  3. Select the Dataset you created previously from the list using the Attach button.

  1. Click OK to attach the Dataset(s) to the Project.
  1. Click the Load from template button to use a Workflow template.

  1. Select the template you want to use and click Load template.

  2. Click Create project to finish creating the Project.

​
STEP 5: Create Custom Editor Layout

After creating your Project, import a custom layout for the Label Editor. Start by creating a JSON file that determines the layout.

​
Create a JSON for the Layout

​
Import the custom layout

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

Was this page helpful?