Annotation Database Import for Annotators: Difference between revisions

From MediaWiki
Jump to navigation Jump to search
(Created page with "TODO: Label Tree Files.")
 
No edit summary
Line 1: Line 1:
TODO: [[Label Tree Files]].
= Background =
 
The database contains a standardized set of fields and tags related to observations of species in real time from video feeds, or from video and photo annotations. The labels and descriptions used in the field or during annotation have to be "mapped" to entities in the database in order to create a coherent dataset across multiple surveys.
 
The labeling strategy is documented in the annotation protocol, which tells future consumers of this data something about the objectives of the annotator and provides some context to the results.
 
The Database Import for Annotators app consists of several sequential pages which are completed in order. When the current page's requirements are satisfied, the <code>Next</code> button becomes enabled. The <code>Next</code>, <code>Previous</code> and intermediate buttons can be used to navigate through the app.
 
== Start ==
 
The start page provides a brief description of the app and what is required from the user.
 
== Sign In ==
 
Here, the user will provide their login credentials and their Biigle username and API token.
 
Biigle API tokens are created on the [https://biigle.de/settings/tokens Access Tokens] page of the Biigle user profile.
 
Once the user logs in, a list of previously-completed import jobs is displayed at the bottom of the page. They can be viewed, edited and deleted.
 
To create a new project, click the <code>New Import Job</code> button.
 
== Select Project ==
 
On this page, if the user has provided correct Biigle credentials, the Select Biigle Project drop-down will be populated with all Biigle projects available to the Biigle user. (Otherwise, a pop-up with appear with the message, "Unauthenticated." This can be dismissed.)
 
The Load a Label Tree button allows the user to load a JSON file representing an artificial label tree derived from a database or spreadsheet file. More information about this can be found on the [[Label Trees]] page. This is not used for Biigle annotations.
 
== Label Mapping ==
 
This is the page where most of the work is done.
 
The first section, '''Tag Documentation''', provides a listing of the tags available for label mapping. Mouse over any of the tags to see a brief description of its purpose.
 
The '''Project Label Trees''' drop-down provides a listing of label trees in the selected Biigle project. If a non-Biigle label tree file has been loaded, there will be one tree in the list. Select a label tree from the list and click the <code>+</code> button to add it to the app. In most cases it will be desirable to add all of the available label trees.
 
The '''All Label Trees''' list contains all available label trees in Biigle. In instances where labels have been used in a project, but the tree has been removed, it will be necessary to map that tree even though it is no longer in the project label trees list. You may add it from this list if it still exists.
 
If it is not clear which label tree a specific label comes from, copy the label's ID into the '''Find a Label's Tree''' text box and click the search button. This will return the name of the tree that owns the label, if it exists. You can then add that tree using the '''All Label Trees''' drop-down.
 
The next section of the page contains the label trees and labels. Each label tree is listed in order, beginning with its title. If the tree has more than 50 labels, a page navigation strip is displayed below the title. Below the page navigation, the '''Show Hidden''' checkbox can be used to display individual labels that have been hidden (more on that below); the '''Show Label Hierarchy''' checkbox toggles whether the full hierarchical path of a label is shown, or just its name; the delete button removes the tree from the label mapping app and the save button saves your current progress (this happens automatically every thirty seconds).
 
Note that if you leave the page or delete a label tree from the app, the app will remember the whatever progress has been made on that label: if the tree is added again, the previous configurations should appear.
 
The labels are displayed in a table with columns displayed depending on which tags are selected in the '''Tag(s)''' drop-down. The static columns are:
* Hide -- If the button is clicked, the row is hidden.
* Label ID -- The Biigle label ID.
* Source Label -- The Biigle label text. If '''Show label hierarchy''' is checked, the full path will be shown.
* Tag(s) -- A multiple drop-down to which the user will add tags to perform label mapping.
* General -- An experimental feature which will be documented or removed in the future.
 
To

Revision as of 20:28, 30 November 2023

Background

The database contains a standardized set of fields and tags related to observations of species in real time from video feeds, or from video and photo annotations. The labels and descriptions used in the field or during annotation have to be "mapped" to entities in the database in order to create a coherent dataset across multiple surveys.

The labeling strategy is documented in the annotation protocol, which tells future consumers of this data something about the objectives of the annotator and provides some context to the results.

The Database Import for Annotators app consists of several sequential pages which are completed in order. When the current page's requirements are satisfied, the Next button becomes enabled. The Next, Previous and intermediate buttons can be used to navigate through the app.

Start

The start page provides a brief description of the app and what is required from the user.

Sign In

Here, the user will provide their login credentials and their Biigle username and API token.

Biigle API tokens are created on the Access Tokens page of the Biigle user profile.

Once the user logs in, a list of previously-completed import jobs is displayed at the bottom of the page. They can be viewed, edited and deleted.

To create a new project, click the New Import Job button.

Select Project

On this page, if the user has provided correct Biigle credentials, the Select Biigle Project drop-down will be populated with all Biigle projects available to the Biigle user. (Otherwise, a pop-up with appear with the message, "Unauthenticated." This can be dismissed.)

The Load a Label Tree button allows the user to load a JSON file representing an artificial label tree derived from a database or spreadsheet file. More information about this can be found on the Label Trees page. This is not used for Biigle annotations.

Label Mapping

This is the page where most of the work is done.

The first section, Tag Documentation, provides a listing of the tags available for label mapping. Mouse over any of the tags to see a brief description of its purpose.

The Project Label Trees drop-down provides a listing of label trees in the selected Biigle project. If a non-Biigle label tree file has been loaded, there will be one tree in the list. Select a label tree from the list and click the + button to add it to the app. In most cases it will be desirable to add all of the available label trees.

The All Label Trees list contains all available label trees in Biigle. In instances where labels have been used in a project, but the tree has been removed, it will be necessary to map that tree even though it is no longer in the project label trees list. You may add it from this list if it still exists.

If it is not clear which label tree a specific label comes from, copy the label's ID into the Find a Label's Tree text box and click the search button. This will return the name of the tree that owns the label, if it exists. You can then add that tree using the All Label Trees drop-down.

The next section of the page contains the label trees and labels. Each label tree is listed in order, beginning with its title. If the tree has more than 50 labels, a page navigation strip is displayed below the title. Below the page navigation, the Show Hidden checkbox can be used to display individual labels that have been hidden (more on that below); the Show Label Hierarchy checkbox toggles whether the full hierarchical path of a label is shown, or just its name; the delete button removes the tree from the label mapping app and the save button saves your current progress (this happens automatically every thirty seconds).

Note that if you leave the page or delete a label tree from the app, the app will remember the whatever progress has been made on that label: if the tree is added again, the previous configurations should appear.

The labels are displayed in a table with columns displayed depending on which tags are selected in the Tag(s) drop-down. The static columns are:

  • Hide -- If the button is clicked, the row is hidden.
  • Label ID -- The Biigle label ID.
  • Source Label -- The Biigle label text. If Show label hierarchy is checked, the full path will be shown.
  • Tag(s) -- A multiple drop-down to which the user will add tags to perform label mapping.
  • General -- An experimental feature which will be documented or removed in the future.

To