Upload Local Data
Uploading Local Data to Files
Any files you upload to Encord must be stored in folders. Click here to learn how to create a folder to store your files.
- Navigate to Files under the Index heading in the Encord platform.
- Click the +Upload files button
- Select a folder to upload your files to. You can click +New folder to create a new folder.
- Select the type of data you want to add.
- A - Upload : Drag and drop local images, text, or video files. Click Upload to finish.
- B - Batch images as : Create an image group or image sequence from local images. See our section on creating image groups and image sequences for more information. Click Upload and batch images to finish.
- C - Audio Drag and drop local audio files. Click Upload to finish.
- D - DICOM : Create a DICOM series from local DICOM files. Click Upload to finish.
To import DICOM files, Encord requires the files to have the following DICOM tags:
Rows Columns StudyInstanceUID SeriesInstanceUID SOPInstanceUID PatientID The following DICOM tags are required to render DICOM images in 3D:
ImagePositionPatient ImageOrientationPatient SliceThickness PixelSpacing
- E - Import from private cloud : Add any data stored in your cloud storage. At least one data integration is required to upload cloud data. Learn how to upload private cloud data here. Click Import to finish.
Custom metadata
Custom metadata can only be added through the Encord SDK.
Custom metadata, also known as client metadata, is supplementary information you can add to all data imported into Encord. It is provided in the form of a Python dictionary, as shown in examples. Client metadata serves several key functions:
- Filtering and sorting in Index and Active.
- Creating custom Label Editor layouts based on metadata.
You can optionally add some custom metadata per data item in the clientMetadata field (examples show how this is done) of your JSON file.
We enforce a 10MB limit on the custom metadata for each data item. Internally, we store custom metadata as a PostgreSQL jsonb type. Read the relevant PostgreSQL documentation about the jsonb type and its behaviors. For example, jsonb type does not preserve key order or duplicate keys.
Metadata schema
Metadata schemas, including custom embeddings, can only be imported through the Encord SDK.
Based on your Data Discoverability Strategy, you need to create a metadata schema. The schema provides a method of organization for your custom metadata. Encord supports:
- Scalers: Methods for filtering.
- Enums: Methods with options for filtering.
- Embeddings: Method for embedding plot visualization, similarity search, and natural language search.
Custom metadata
Custom metadata refers to any additional information you attach to files, allowing for better data curation and management based on your specific needs. It can include any details relevant to your workflow, helping you organize, filter, and retrieve data more efficiently. For example, for a video of a construction site, custom metadata could include fields like "site_location": "Algiers", "project_phase": "foundation", or "weather_conditions": "sunny". This enables more precise tracking and management of your data.
Before importing any files with custom metadata to Encord, we recommend that you import a metadata schema. Encord uses metadata schemas to validate custom metadata uploaded to Encord and to instruct Index and Active how to display your metadata.
video.description, while team B could use audio.description. Another example could be TeamName.MetadataKey. This approach maintains clarity and avoids key collisions across departments.Metadata schema table
Use add_scalar to add a scalar key to your metadata schema.
| Scalar Key | Description | Display Benefits |
|---|---|---|
| boolean | Binary data type with values “true” or “false”. | Filtering by binary values |
| datetime | ISO 8601 formatted date and time. | Filtering by time and date |
| number | Numeric data type supporting float values. | Filtering by numeric values |
| uuid | Customer specified unique identifier for a data unit. | Filtering by customer specified unique identifier |
| varchar | Textual data type. Formally string. string can be used as an alias for varchar, but we STRONGLY RECOMMEND that you use varchar. | Filtering by string. |
| text | Text data with unlimited length (example: transcripts for audio). Formally long_string. long_string can be used as an alias for text, but we STRONGLY RECOMMEND that you use text. | Storing and filtering large amounts of text. |
Use add_enum and add_enum_options to add an enum and enum options to your metadata schema.
| Key | Description | Display Benefits |
|---|---|---|
| enum | Enumerated type with predefined set of values. | Facilitates categorical filtering and data validation |
Use add_embedding to add an embedding to your metadata schema.
| Key | Description | Display Benefits |
|---|---|---|
| embedding | 1 to 4096 for Index. 1 to 2000 for Active. | Filtering by embeddings, similarity search, 2D scatter plot visualization (Coming Soon) |
Incorrectly specifying a data type in the schema can cause errors when filtering your data in Index or Active. If you encounter errors while filtering, verify your schema is correct. If your schema has errors, correct the errors, re-import the schema, and then re-sync your Active Project.
Import your metadata schema to Encord
Verify your schema
After importing your schema to Encord we recommend that you verify that the import is successful. Run the following code to verify your metadata schema imported and that the schema is correct.
Was this page helpful?