This guide assumes your images are stored in AWS. To learn how to create integrations with other cloud providers click here. To learn how to upload files locally click here.
Set Up AWS
Before you can do anything with the Encord platform and cloud storage, you need to configure your cloud storage to work with Encord. Once the integration between Encord and your cloud storage is complete, you can then use your data in Encord.
In order to integrate with AWS S3, you need to:
You have the following options to integrate AWS and Encord:
Create AWS Integration in Encord
In the Integrations section of the Encord platform, click +New integration to create a new integration.
Select AWS S3 at the top of the chooser.
Create JSON file for Registration
Create a JSON file based on the templates provided below. imageMetadata
is optional unless you are using a client-only access integration.
The title
field is optional. If omitted, the audio file path and name are used as the default title. For example, if the file is located at https://encord-solutions-bucket.s3.eu-west-2.amazonaws.com/path/to/my/bucket/song2.mp3
, the title defaults to /path/to/my/bucket/song2.mp3
.
Key or Flag | Required? | Default value |
---|---|---|
”objectUrl” | Yes | |
”title” | No | The file’s path + title |
”imageMetadata” | No | |
”clientMetadata” | No | |
”createVideo” | No | false |
imageMetadata
must be specified when a Strict client-only access integration is used. In all other cases, imageMetadata
is optional, but including it significantly reduces import times.Create a Folder to Store Your Audio Files
All files in Encord must be stored within folders. Therefore, you need to create a folder before registering any data with Encord. To create a folder:
Give the folder a meaningful name and description.
Click Create to create the folder. The folder is listed in Files.
Upload Your Images to Encord
Create a Dataset
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.
Click Attach data to attach the selected files to the Dataset.
Create an Ontology
Create a Project
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.
Click the Attach ontology button.
Select the Ontology you created previously from the list using the Select button.
Click OK to attach the Ontology to the Project.
Click the Attach datasets button.
Select the Dataset you created previously from the list using the Attach button.
Select the template you want to use and click Load template.
Click Create project to finish creating the Project.
This guide assumes your images are stored in AWS. To learn how to create integrations with other cloud providers click here. To learn how to upload files locally click here.
Set Up AWS
Before you can do anything with the Encord platform and cloud storage, you need to configure your cloud storage to work with Encord. Once the integration between Encord and your cloud storage is complete, you can then use your data in Encord.
In order to integrate with AWS S3, you need to:
You have the following options to integrate AWS and Encord:
Create AWS Integration in Encord
In the Integrations section of the Encord platform, click +New integration to create a new integration.
Select AWS S3 at the top of the chooser.
Create JSON file for Registration
Create a JSON file based on the templates provided below. imageMetadata
is optional unless you are using a client-only access integration.
The title
field is optional. If omitted, the audio file path and name are used as the default title. For example, if the file is located at https://encord-solutions-bucket.s3.eu-west-2.amazonaws.com/path/to/my/bucket/song2.mp3
, the title defaults to /path/to/my/bucket/song2.mp3
.
Key or Flag | Required? | Default value |
---|---|---|
”objectUrl” | Yes | |
”title” | No | The file’s path + title |
”imageMetadata” | No | |
”clientMetadata” | No | |
”createVideo” | No | false |
imageMetadata
must be specified when a Strict client-only access integration is used. In all other cases, imageMetadata
is optional, but including it significantly reduces import times.Create a Folder to Store Your Audio Files
All files in Encord must be stored within folders. Therefore, you need to create a folder before registering any data with Encord. To create a folder:
Give the folder a meaningful name and description.
Click Create to create the folder. The folder is listed in Files.
Upload Your Images to Encord
Create a Dataset
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.
Click Attach data to attach the selected files to the Dataset.
Create an Ontology
Create a Project
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.
Click the Attach ontology button.
Select the Ontology you created previously from the list using the Select button.
Click OK to attach the Ontology to the Project.
Click the Attach datasets button.
Select the Dataset you created previously from the list using the Attach button.
Select the template you want to use and click Load template.
Click Create project to finish creating the Project.