Skip to main content

FAQ

Can I use Encord active without an Encord account?​

Absolutely! Encord Active is an open-source project aimed to support all computer vision based active learning projects. You can initialize a project using the init command with a local image directory. Additionally, integration with COCO projects is also possible in Encord Active.

For more information and details on your possibilities, check out the Import section.

Does data stay within my local environment?​

Yes! - period.

Everything you do with this library stays within your local machine. No statistics, data, or other information will be collected or sent elsewhere.

The only communication that occurs with the outside world is with Encord's main platform if you have a project linked to Encord.

What do I do if I have issues with the installation?​

If you encounter any issues during the installation process, we recommend checking that you have followed the steps outlined in the installation guide carefully.

If the problem persists or if you have any further questions, please don't hesitate to get in touch with us. You can reach out to us via Discord or by email, and we'll be happy to assist you with any installation-related issues you may have.

What is a quality metric?​

A quality metric is a function that can be applied to your data, labels, and model predictions to assess their quality and rank them accordingly. Encord Active uses these metrics to analyze and decompose your data, labels, and predictions.

Here is a blog post on how we like to think about quality metrics.

Quality metrics are not only limited to those that ship with Encord Active. In fact, the power lies in defining your own quality metrics for indexing your data just right. Here is the documentation for writing your own metrics.

How do I import my model predictions?​

To import your model predictions into Encord Active, you need to follow these steps:

  1. Build a list of encord_active.lib.db.predictions.Prediction objects that represent your model predictions.
  2. Store the list of predictions in a pickle file.
  3. Run the command encord-active import predictions /path/to/your/file.pkl, where /path/to/your/file.pkl is the path to the pickle file containing your predictions.

By executing this command, Encord Active will import and incorporate your model predictions into the project. You can refer to the workflow description for importing model predictions for more detailed instructions.

How do I write my own quality metrics?​

Here is the documentation for writing your own metrics.

Initializing Encord Active is taking a long time, what should I do?​

For larger projects, initialization can take a while. While we're working on improving the efficiency, there are a couple of tricks that you can do.

  1. As soon as the metric computations have started (indicated by Encord Active printing a line containing Running metric) you can open a new terminal and run encord-active start. This will allow you to continuously see what have been computed so far. Refresh the browser once in a while when new metrics are done computing in your first terminal.

  2. You can also kill the import process as soon as metrics have started to compute. This will leave you with a project containing fewer quality metrics. As a consequence, you will not be able to see as many insights as if the process is allowed to finish. However, you can always use the encord-active metric runcommand to run metrics that are missing.

How do I add my own embeddings?​

Please see this notebook to learn how to add your own custom embeddings.

Can I use Encord Active without a UI?​

You can.

The code base is structured such that all data operations live in encord_active.lib and encord_active.lib which serves as the "backend" for the UI. As such, everything you can do with the UI can also be done by code.

Other good resources can be found in our example notebooks.

How does Encord Active integrate without the Encord annotation platform?​

There are multiple ways in which you can integrate your data with Encord Active. We have described how to import data here. To also integrate model predictions, you can read more here. Exporting data back into the rest of your pipeline can be done via the toolbox in the application's explorer pages.

How can I do dataset management with Encord Active?​

Dataset management can be done in two ways.

  1. You can tag your data to keep track of subsets (or versions) of your dataset.
  2. If you are planning to do more involved changes to your dataset and you want the ability to go back, your best option is to use the Clone button in the Action tab of the toolbox in the application's explorer pages. This will create a clone of your entire project and you will always be able to come back to the old project.

How do I version my data and labels through Encord Active?​

The best way to version your project is to tag your data with the tagging feature as you go.

Alternatively, you can use git. To do that, we suggest adding a .gitignore file with the following content:

data/**/*.jpg
data/**/*.jpeg
data/**/*.png
data/**/*.tiff
data/**/*.mp4

Afterwards, run git add .; git commit -am "Initial commit".

What is the tagging feature?​

Throughout the Data Quality, Label Quality, and Model Quality pages, you can tag your data. There are two different levels at which you can tag data; the data level which applies to the raw images/video frames and the label level which applies to the classifications and objects associated to each image.

You can, e.g., use the tags to filter and export your data for further processing like relabeling, training models, or inspecting model performance based on a specific subset of your data.

Here is some more documentation on using the tagging feature.

How do I use Encord Active to find label errors?​

Here is a blog post on how to find and fix label errors using Encord Active.

How do I use Encord Active for active learning?​

Encord Active supports the active learning process by allowing you to

  1. Explore your data to select what to label next
  2. Employ acquisition functions to automatically select what to label next
  3. Find label errors that potentially harm your model performance
  4. Sending data to Encord's Annotation module for labeling
  5. Automatically decompose your model performance to help you determine where to put your focus for the next model iteration
  6. Tag subsets of data to set aside test sets for specific edge cases for which you want to maintain your model performance between each production model

For detailed information on active learning and the role of Encord Active, you can refer to our documentation on Active Learning within Encord Active.

How do I upload my data and labels to the Encord platform?​

Uploading your data to the Encord platform is as simple as clicking the 🏗 Export to Encord button in the Action tab of the toolbox in the application's explorer pages. This will create an ontology, a dataset, and a project on Encord Annotate and provide you with links to the three.

tip

This action requires an ssh-key associated with Encord Active:

  1. Add a public key in the Encord platform.

  2. Associate the private key with Encord Active.

    encord-active config set ssh-key-pash /path/to/private/key

What should I do if I encounter an error?​

If you come across an error, don't worry! We're here to assist you. Reach out to us on Discord or shoot us an email, and we'll promptly address your concern.

Additionally, we greatly appreciate it if you could report the issue on GitHub. Your feedback and bug reports help us improve Encord Active for everyone.