Skip to content

Latest commit

 

History

History
234 lines (158 loc) · 12.4 KB

user_guide.md

File metadata and controls

234 lines (158 loc) · 12.4 KB

User guide

Introduction

This guide shows the possibilities of the Mass Labeling tool and clarifies the usage of some features.

Main function

The main function of the Mass Labeling tool is to offer a service for labeling the data placed on the data owner's server by a group of assessors. It also has the web interface to control the progress and a CLI command to export the results.

Functions by roles

There are two roles in the Mass Labeling tool — an administrator and an assessor. The main objectives of an administrator is to create labeling tasks and manage them. The main objective of an assessor is to label images in the given tasks. Let's have a closer look at these roles.

Administrator role

An administrator can manage users and tasks, control the labeling progress and manipulate data. This section describes the Administrator interface and provides information on how to create a new assessment task, monitor the progress and obtain the assessment results. Please feel free to skip sections and proceed to reading those that interest you most.

Administrator interface

In the upper left side of the administrator interface you can find menu items for the current assessment task: Mass labeling aka Home, Statistics, Guide. In the upper right side of the administrator interface you can find general-purpose menu items like: a language switcher, account email, Settings and exit button.

Current task interface

Clicking on the Mass labeling menu item redirects you to the homepage which allows an administrator to take part in the assessment process and view images which were labeled as broken by assessors.

Clicking on the Statistics menu item allows you to choose the statistics report from the list: views count, anomalies among all users, anomalies for a single user. Descriptions of these reports could be found on the corresponding pages.

Clicking on the Instruction menu item opens a new browser tab with the instruction description for the current task.

Let's consider some interface elements in detail.

Broken images

This is an additional feature which some administrators can ignore. Mass Labeling assumes that an assessor labels an image as broken when an image seems to be not present in this dataset. For example, when an image is not shown or isn't relevant (you see a cat in a dataset for cars).

If an administrator confirms that an image is broken then this image will not be shown to assessors in the future. If an administrator decides that an image is ok then all assessors that try to label it as broken will get a message notifying
that the image is ok.

Label images

This interface is the same as the assessor's labeling interface.

General interface

The functionality of the language switcher and the exit button is obvious. If you need to use a language other than English or Russian, please read the multilanguage support guide.

Clicking on the Settings menu item opens the settings interface which needs some description.

The settings are divided into three categories, each has its own tab in the settings interface. They are Users, Assessment and System settings.

Users settings

This settings category allows an administrator to:

  • add users,
  • change their email, password, status and role,
  • generate and open a slider which shows labels set by the user.

When an administrator adds a user he/she should enter an email, password, status and role. The same information could be added by clicking on the Edit button in the list of users.

Sliders allow an administrator to look through the data labeled by a certain user. To use a slider, an administrator needs to generate it by clicking on the Generate slider button in the list of users. The system will ask which task the slider should be generated for. The slider's information generated for the chosen task will be saved in the database and after clicking on the Open slider button, an administrator can open the slider for a certain task.

Sliders are not updated automatically. It means that an administrator needs to generate a slider again if the user labeled more data.

Sliders provide the following info: a labeled image, rates (classes) which an assessor chosed for it, assessor's average rate, model rate, error. Here an assessor's average rate is calculated as an average for all rates given by all assessors, a model rates is a number which was uploaded into the database using the import procedure (see the CLI import guide) and it is implied that it corresponds to some ML model, and an error is a difference between an assessor's average rate and model rate. If an image model rate equals 0, both the error and model rate values would be displayed as '-'.

A slider contains only images which were labeled by a chosen user. Each image can be associated with not more than one model rate. So, the re-import of the rates will update those rates.

Assessment settings

This settings category allows an administrator to:

  • add new assessment tasks,
  • change assessment task parameters, i.e. user views limit, random/deterministic way of showing images, datasets included in the task, change the task description and assessor guide (see the Create the assessment task workflow),
  • activate a task, i.e. set some task as current.
System settings

This settings category allows an administrator to:

  • set system logging parameters, such as logger verbosity level,
  • data locations, such as the db url and the storage folder for images,
  • authentication parameters, such as cookie expiration time, cookie salt value,
  • cli import default paths, such as the default datasets archive path and the path to the JSON file with default model rates.

Create the assessment task workflow

An administrator can manage the user's access and visibility of datasets. It makes it possible to run and manage tasks one by one, yet there is no option to manage concurrent assessment tasks. The steps to start a new task are as follows:

  1. Provide data for assessment.
  2. Create an assessment task.
  3. Manage the user's access.

After setting up a new task, assessors can start the labeling process and an administrator can monitor their progress.

Provide data

At the moment, importing datasets is possible only by using CLI. For more info, please read the corresponding section in the CLI import guide. After the dataset was imported into the Mass Labeling tool, it is registered in the DB and can't be removed using the application. But an administrator can exclude it from the list of active datasets related to the task (see the manage datasets section).

Create task

Creating a task involves the following:

  1. Specifying the total number of views an assessor should do.
  2. Writing the task description (optional).
  3. Managing the datasets accessibility.
  4. Editing assessment guide (optional).
Number of views

If an administrator unselects the show randomly checkbox the upper limit of views for each user is equal to the number of images in all chosen datasets.

If an administrator selects the show randomly checkbox then the upper limit of views per user could be set to any positive number or be unlimited (specify 0 for this). Let's consider an example. An administrator wants to show 1,000 images to assessors. Also an administrator wants to verify their opinions by showing each image 3 times. In this case a good choice will be to set show randomly and set the views limit to 3,000 views per user.

Task description

The task description can help an administrator to distinguish the tasks. This parameter is shown in the task list only. This is not mandatory but could be a useful feature.

Manage datasets

An administrator can mark the datasets which are active for this task. All images belonging to datasets from the list of active datasets are shown to assessors. And vice versa, images from datasets not included into this list are not shown to assessors.

Edit guide

An administrator can provide instructions in the HTML format for each task. Assessors can click on the Guide link to read them during their work. This is not mandatory but could be a useful feature.

A language switcher doesn't impact the text of the guide. So, if you need to have the guide in different languages you can write all versions in one guide.

Manage users

It is possible to manage users using CLI. For more information on how to create users, please read the corresponding section in the CLI user guide.

Note. CLI is the only option for creating the first administrator, that's why this step is obligatory to start using the Mass Labeling application.

Another way to add users into Mass Labeling is to use the administrator interface in the running application. Choose the Users tab in the Settings menu to add users and manage their access. The users setting menu is described in this section.

Monitor the labeling progress

An administrator can click the Statistics menu item and select one of the three options: Views, Anomalies among users and Individual anomalies. Click Views to see how many labels each assessor assigned. Click on Anomalies among users or Individual anomalies to view how many outliers were done by each assessor.

After assessors have completed the labeling task, an administrator can obtain the results.

Obtain results

As of now, this operation could be done only using CLI. Read the corresponding section in the CLI export guide.

Assessor role

Assessors can label images provided to them and monitor their own progress.

Assessor interface

The assessor interface is a subset of the administrator interface. In the upper left side of the assessor interface you can find menu items for current assessment task: Mass labeling aka Home, Guide. In the upper right side of the assessor interface you can find general-purpose menu items like: a language switcher, account email and exit button.

Label images
General information

When an assessor presses the Get task button, Mass Labeling will redirect him/her to the labeling interface. It will show images and wait for assessors to respond to them. In the upper right part of the screen you can see two additional elements: the help button and progress info.

To understand how to label images, read about controls in the corresponding section. Also, an assessor can review the task instructions in the guide by clicking on the corresponding link in the upper left part of the interface.

Controls

The following list describes the keys which assessors can use during their work:

  • 1-9, 0: sets the label for the current image;
  • Enter: confirms the label and requests the next image;
  • Backspace: returns to the previous image, which allows an assessor to change the label. This button could be pressed multiple times, which leads to the cancellations of all labels for the last images.

FAQ

Q: How can I start the new labeling task with a different dataset? A: Now it is possible to select datasets which are active for the labeling process. Let's assume assessors have labeled all images from the dataset A. An administrator can import the new dataset B and set only this dataset as active in a new task. It means that images of the dataset A will not be shown to assessors. Please read the corresponding section manage datasets for more info.

Q: Is there a way to assess images for binary classification problem? A: Now it is possible to give a rate to each image from 1 to 10 and it is hardcoded. So, you can use numbers 1 and 2 to assess your dataset between two classes, but you can't perform an assessment task for 11 classes or 11 rate ranking problem. As of now, the number 10 is hardcoded but it seems easy to make it a Mass Labeling system parameter.