Frequently Asked Questions
How Do I Upload DICOM data?
Please perform the following steps to register data that is stored on your S3 buckets with our platform:
- Create a JSON file like this.
- Follow the SDK tutorial to register all the files with our platform.
How Can I Set Up Upload Annotations?
You can find instructions for uploading the labels here in our documentation. We support JSON and COCO formats, but can help with writing a parser if you use a specific format.
How Can I Set Up Integrated Model Predictions?
We have multiple ways to integrate your model:
- Import your model prediction via the API
- You can upload the models and weights into our platform
- Custom integration - our platform can ping your models directly e.g. via webhooks, subject to Encord custom development effort.
Of these, 1 is the easiest way to start. You can upload the predictions of all of your models via our API.
Both 2 and 3 will require some engineering resources on your side.
How Do I Export Metadata Using Encord's SDK?
The review metadata will be exported in the JSON format so you will see the statuses e.g. what was reviewed and what wasn't.
You find the
annotation_task_status in the
label_row that indicates the status - see statuses in our documentation here for more information.
How Does Team Management Work?
At an organizational level, you should have all the permissions that you need.
You are able to create new projects, ontologies (labelling structures), and upload datasets.
If you don’t have permissions on a specific project that someone else has created, you will need to be added to the project as an Admin (Project -> Settings -> Team) by the person who created the project.
If you want to have admin access to a specific ontology (labelling structure) or dataset that someone else created, you need to be added as an Admin as well.
The reason for having these granular access controls is to avoid accidental changes/deletions of data and labelling structures.
Download of labels via the SDK is slow. How do I speed it up?
If you try setting
get_signed_url=False that should avoid the latency with signing the URL.
This can be done by using the following operation:
Here are the instructions for the
How can I pre-select frames to label for a video via the SDK?
Add an extra feature in the ontology called, for example,
Yes (or whatever else you want to call it) and share the ontology tree with Encord Support.
This will allow us to match the import script with the feature uuid (
How do I avoid hitting the timeout when using the get_project() method on the API?
Increase the timeout of your Encord client, given the size of the project this is a long-running query.
Why can't I see all classifications/annotations in review the review workflow?
Check the sampling rate.
It's possible that you are seeing a different number of classifications/annotations than expected because you have the sampling rate set too high/low.
How can I get the label status via SDK?
To get the
annotation_task_status you need to call the
See our documentation for further details.
The possible response values will be
Further information on
annotation_task_status is available here.
How can I find ontology info in labels when exporting?
You can find ontology info in labels using
encord_project.label_rows combined with
This yields a list of label rows that each has a list of labels.
Look for the
classification_answers entries, which can also be found in the label row.
If I have duplicate datasets, how can I find out which one is which?
- Go to datasets in GUI
- Re-name both datasets
- Open the cases in the editor and see which one is which (e.g. which one is annotated and which is not)
- Delete the one which is no longer wanted
How can I re-order an ontology?
This is possible using the SDK. The following example can be used to re-order the first two elements in an existing ontology:
- Authenticate the user client via the SDK using by defining the
get_user_clientfunction and invoking the
EncordUserClientmethod if you haven't already:
def get_user_client() -> EncordUserClient:
ssh_key = os.environ.get("SSH_KEY")
- Pass the
get_ontologymethod, perform the relevant changes, and call
ontology.save()to commit the changes:
user_client = get_user_client()
ontology = user_client.get_ontology(ONTOLOGY_RESOURCE_ID)
first_object = ontology.structure.objects
second_object = ontology.structure.objects
ontology.structure.objects = second_object
ontology.structure.objects = first_object
N.B. If necessary, we can also do it manually for you in our database if you get stuck.
We will be looking to add a more user-friendly version of this functionality into our UI in the future.
How can I re-encode videos?
- You can re-encode on our platform when uploading the data
- For some encoding we need write permission on their bucket
Can I set up download via internet URLs?
We do not currently offer this because we prioritise the security of your data.
What are the currently-supported video formats?
We support a range of format and codecs:
Others formats and codecs might be supported, but we cannot guarantee this.
We are willing to support your efforts with custom scripts where appropriate so please do reach out if you get stuck!
How do I set up the Azure integration?
To set up the Azure integration:
Your User needs to be Admin of the Azure Tenant
You need to add the application via the command line:
New-AzADServicePrincipal -ApplicationId [APPLICATION_ID]
Please see our Azure documentation here for more information.
How can I import labels via CVAT importer?
Please see our CVAT documentation here.
What are Object Hashes in the SDK?
Each object hash is unique in the platform.
With DICOM images, I can show only one view. How do I correct this?
If this is happening, it is because some dimensions are different in the slices i.e. there is a corrupted slice.
All slices need to have the same dimensions in CT/MRI scans.
I am getting an error when I try to log in to the application. How can I fix this?
- Please ensure you're using the Chrome browser, and that it's up-to-date.
- Try clearing your browser cache & refreshing the page and trying again.
- If you're still stuck, please contact firstname.lastname@example.org
I am getting an error when I try to display video/DICOM. How can I fix this?
This could be browser issue. To resolve, please:
- Use Chrome as a browser if you're not already
- Turn hardware acceleration off
- If you're still stuck, please contact email@example.com
How can I change label status via the SDK?
You can change the labels status via the SDK or GUI using this guide.
The URL (link) I have been sent does not link to the appropriate task. How can I fix this?
This is a known issue with how links to the editor view on tasks currently work in our application.
We are looking to address this behaviour with an update soon.
At the moment, the URL leads to the editor view of the task, and if you haven't got edit permission on it, you will be redirected to the next available open task.
To solve this, just delete the last part of the URL
/0/1 and reload the page. You will then be able to view the task in "view only" mode.
Are there any restrictions on the use of special characters in AWS S3 object names when importing as Encord private data?
Yes, in general it is advisable to avoid the use of special characters in object names.
See the AWS docs here for more information.
What does the "Version mismatch" pop-up in the label editor mean?
Don't worry, no data has been lost! This is a warning from our system that either two different people are editing a task at the same time, or that one individual has the task open in two different browser windows. The warning prevents annotators from overwriting others' or their own work.
In a scenario where someone else is editing the file, the warning pop-up will read as follows: "Version mismatch: Someone else is working on this. Are sure you would like to save your edit? This could overwrite changes that have been made."
In such cases, we recommend to click 'cancel' so as to prevent another annotator's work being overwritten. Then, ask your team who else might be editing the task at the same time.
In a scenario where the same user has the same task open in multiple browser tabs, the message will read as follows: "Version mismatch: The labels were updated outside of this session. Are sure you would like to save your edit? This could overwrite changes that have been made."
In such cases, we recommend to click 'cancel' to prevent any unexpected data overwrites and the annotator in question should perform an inventory on their browser tabs to discover where else the task is being edited.