Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zhiltsov-max committed Nov 25, 2024
1 parent 110bc8d commit 9998749
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 43 deletions.
9 changes: 4 additions & 5 deletions site/content/en/docs/enterprise/immediate-feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ The annotator can either agree or disagree with the feedback.
If they disagree, they have the option to re-annotate the job and request feedback again.
However, feedback is only available a limited number of times, as specified in the task's quality settings.

To ensure transparency with the annotator, the immediate feedback shows the collected score and
To ensure transparency with the annotator, the immediate feedback shows the collected score and
the minimum required score.
Immediate feedback settings, such as `Target metric`, `Target metric threshold`,
Immediate feedback settings, such as `Target metric`, `Target metric threshold`,
`Max validations per job` and others, can be configured on the quality settings page:
<!--- TODO: Update quality page documentation and refer from this section -->

<img src="/images/immediate-feedback-quality-settings.png" style="max-width: 600px;">

Expand All @@ -40,11 +39,11 @@ In this case annotators do not see any feedback dialogs.
> The number of attempts resets when the job assignee is updated.
Requirements:
1. The task is configured with a Ground Truth job that has been annotated,
1. The task is configured with a Ground Truth job that has been annotated,
moved to the acceptance stage, and is in the completed state.
2. The current job is in the annotation stage.
3. The current job is a regular annotation job. Immediate feedback is not available for Ground Truth jobs
4. The `Max validations per job` setting has been configured on the quality settings page.
4. The `Max validations per job` setting has been configured on the quality settings page.



Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
---
title: 'Automated QA, Review & Honeypot'
title: 'Automated QA, Review & Honeypots'
linkTitle: 'Automated QA'
weight: 1
description: 'Guidelines for assessing annotation quality in CVAT automatically'
---

In CVAT, it's possible to evaluate the quality of annotation through
the creation of a **Ground truth** job, referred to as a Honeypot.
To estimate the task quality, CVAT compares all other jobs in the task against the
established **Ground truth** job, and calculates annotation quality
based on this comparison.
In CVAT, it's possible to evaluate the quality of annotation through the creation
of a validation subset of images. To estimate the task quality, CVAT compares
all other jobs in the task against the established **Ground truth** job,
and calculates annotation quality based on this comparison.

> **Note** that quality estimation only supports
> 2d tasks. It supports all the annotation types except 2d cuboids.
Expand All @@ -20,17 +19,23 @@ based on this comparison.
> **Note** that quality estimation is currently available for tasks and jobs.
> Quality estimation in projects is not implemented yet.
CVAT has the following features for automated quality control of annotations:
- Validation set configuration for a task
- Job validation on job finish ("{{< ilink "/docs/enterprise/immediate-feedback" "Immediate feedback" >}}")
- Review mode for problems found
- Quality analytics

See:

- [Basics](#basics)
- [Ground Truth jobs](#ground-truth-jobs)
- [Configuration](#configuration)
- [How to enable quality control in a new task](#enable-in-new-task)
- [How to enable quality control in an existing task](#enable-in-existing-task)
- [Configuration](#configuring-quality-estimation)
- [How to enable quality control in a new task](#how-to-enable-quality-control-for-a-new-task)
- [How to enable quality control in an existing task](#how-to-enable-quality-control-for-an-already-existing-task)
- [Validation modes](#validation-modes)
- [Ground Truth](#validation-mode-gt)
- [Honeypots](#validation-mode-gt-pool)
- [Summary](#validation-mode-summary)
- [Ground Truth](#ground-truth)
- [Honeypots](#honeypots)
- [Summary](#mode-summary)
- [Quality management](#quality-management)
- [Frames](#validation-set-management)
- [Annotations](#annotation-management)
Expand Down Expand Up @@ -116,21 +121,26 @@ To delete the Ground Truth job, do the following.
2. Click on three dots to open the menu.
3. From the menu, select **Delete**.

## Configuring quality estimation <a id="configuration"></a>
## Configuring quality estimation

Quality estimation is configured on the Task level. There are 2 ways to enable for a task.

### How to enable quality control for a new task <a id="enable-in-new-task" ></a>
### How to enable quality control for a new task

1. Go to the {{< ilink "/docs/manual/basics/create_an_annotation_task" "task creation" >}} page
2. Select the source media, configure other parameters
3. Scroll down to the **Quality Control** section below
4. Select one of the [validation modes]() available
4. Select one of the [validation modes](#validation-modes) available

![Create task with validation mode](/images/honeypot09.jpg)

5. Create the task and open the task page
6. Upload or create Ground Truth annotations in the Ground Truth job in the task
7. Switch the GT job into the `acceptance`-`completed` state

### How to enable quality control for an already existing task <a id="enable-in-existing-task" ></a>
![Set job status](/images/honeypot10.jpg)

### How to enable quality control for an already existing task

> For already existing tasks only the Ground Truth validation mode is available. If you want
> to use Honeypots for your task, you will need to recreate the task.
Expand All @@ -142,7 +152,7 @@ Quality estimation is configured on the Task level. There are 2 ways to enable f

3. In the **Add new job** window, fill in the following fields:

![Add new job](/images/honeypot02.jpg)
![Configure job parameters](/images/honeypot02.jpg)

- **Job type**: Use the default parameter **Ground truth**.
- **Frame selection method**: Use the default parameter **Random**.
Expand All @@ -166,14 +176,16 @@ The **Ground truth** job will appear in the jobs list.
6. Change the **Stage** of the job to **Acceptance**.
7. Change the **Status** of the job to **Completed**.

![Set job status](/images/honeypot10.jpg)

## Validation modes

Currently, there are 2 validation modes available for tasks: **Ground Truth** and **Honeypots**.
These names are often used interchangeably, but in CVAT they have some differences.
Both modes rely on the use of Ground Truth annotations in a task,
stored in a [Ground Truth job](#ground-truth-jobs), where they can be managed.

### Ground Truth <a id="validation-mode-gt"></a>
### Ground Truth

In this mode some of the task frames are selected into the validation set, represented as a
separate Ground Truth job. The regular annotation jobs in the task are not affected in any way.
Expand Down Expand Up @@ -209,7 +221,7 @@ Parameters:
This method uses segment size of the task to select the same number of validation frames
in each job, if possible.

### Honeypots <a id="validation-mode-gt-pool"></a>
### Honeypots

In this mode some random frames of the task are selected into the validation set.
Then, validation frames are randomly mixed into regular annotation jobs. It can also be
Expand All @@ -232,7 +244,7 @@ annotation job from the validation set
- total frame count (%) - the percent of the task frames to be included into the validation set.
This value must result in at least `frame count per job` * `segment size` frames.

### Mode summary <a id="validation-mode-summary"></a>
### Mode summary

Here is a brief summary of the validation modes:

Expand Down Expand Up @@ -368,28 +380,38 @@ Annotation quality settings have the following parameters:

## Quality Analytics

> **Note**: quality analytics is a premium feature.
> **Note**: quality analytics is a premium feature. Please check how to get access to this
> functionality in the {{< ilink "/docs/enterprise" "Paid features" >}} section of the site.
Once the quality estimation is enabled in a task and the Ground Truth job is configured,
quality analytics will become available for the task and its jobs.
quality analytics becomes available for the task and its jobs.

> A **Ground truth** job is considered configured
> A **Ground truth** job is considered **configured**
> if it is at the **acceptance** stage and in the **completed** state.
By default, CVAT computes quality metrics automatically at regular intervals.

> **Note** that the process of quality calculation may take up to several hours, depending on
> the amount of data and labeled objects, and is **not updated immediately** after task updates.
It you want request quality metrics update, you can do this by pressing the "Refresh" button
It you want request quality metrics update, you can do this by pressing the **Refresh** button
on the task **Quality Management** > **Analytics** page.

![Quality Analytics page](/images/honeypot05.jpg)
![Quality Analytics page - refresh button](/images/honeypot11.jpg)

Once a quality metrics are computed, they are available for detailed review on this page.
Conflicts can be reviewed in the [Review mode of jobs](#gt-conflicts-in-the-cvat-interface).
A job must have at least 1 validation frame (shown in the **Frame intersection** column) to
be included in quality computation.

![Jobs list](/images/honeypot12.jpg)

### Quality data

The Analytics page has the following fields:

![Quality Analytics page](/images/honeypot05.jpg)

<!--lint disable maximum-line-length-->

| Field | Description |
Expand Down
75 changes: 62 additions & 13 deletions site/content/en/docs/manual/basics/quality-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,29 @@ weight: 21
description: 'Overview of quality control features'
---

<!-- TODO: some intro about importance of quality control -->
CVAT has the following features for automated quality control of annotations:
- [Validation set configuration for a task](#how-to-enable-quality-control-for-a-new-task)
- Job validation on job finish ("{{< ilink "/docs/enterprise/immediate-feedback" "Immediate feedback" >}}")
- [Review mode for problems found](#how-to-review-problems-found)
- [Quality analytics](#how-to-check-task-quality-metrics)

CVAT has the following features to manage quality of annotations:
- Validation configuration for a task
- Job validation on job finish (aka "Immediate feedback")
- Review mode for annotations
- Quality reporting and analytics
In this section we only highlight the key steps in quality estimation.
Read the detailed guide on quality estimation in CVAT in the {{< ilink "/docs/manual/advanced/analytics-and-monitoring/auto-qa" "Advanced section" >}}.

## How to enable quality control for a new task

1. Go to task creation
1. Select the source media, configure other parameters
1. Scroll down to the "Quality Control" section
1. Select one of the validation modes available
1. Select the source media, configure other task parameters
1. Scroll down to the **Quality Control** section
1. Select one of the {{< ilink "/docs/manual/advanced/analytics-and-monitoring/auto-qa#validation-modes" "validation modes" >}} available

![Create task with validation mode](/images/honeypot09.jpg)

1. Create the task
1. Upload or create Ground Truth annotations in the GT job in the task
1. Switch the GT job into the `acceptance`-`completed` state
1. Upload or create Ground Truth annotations in the Ground Truth job in the task
1. Switch the Ground Truth job into the `acceptance`-`completed` state

![Set job status](/images/honeypot10.jpg)

## How to enable quality control for an already existing task

Expand All @@ -30,6 +36,49 @@ CVAT has the following features to manage quality of annotations:
1. Open the task page
1. Click on the "+" button next to the job list
1. Upload or create Ground Truth annotations in the GT job in the task
1. Switch the GT job into the `acceptance`-`completed` state

![Create job](/images/honeypot01.jpg)

1. Select Job Type **Ground truth** and configure the job parameters

![Configure job parameters](/images/honeypot02.jpg)

1. Upload or create Ground Truth annotations in the Ground Truth job in the task
1. Switch the Ground Truth job into the `acceptance`-`completed` state

![Set job status](/images/honeypot10.jpg)

## How to enable immediate job feedback

1. Open the task **Actions** menu > **Quality control** > **Settings**
1. Set **Max validations per job** to above zero. 3 is a good staring number.

![Configure job validations](/images/immediate-feedback-settings-validations.jpg)

1. Save the updated settings
1. Assign an annotator to an annotation job
1. Annotate the job
1. Mark the job finished using the corresponding button in the menu
1. Once the job is completed, you'll see the job validation dialog

![Job validation successful](/images/immediate-feedback-accept.png)

Each assignee gets no more than the specified number of validation attempts.

## How to check task quality metrics

1. Open the task **Actions** menu > **Quality control**
1. (optional) Request quality metrics computation, wait for completion
1. Review summaries or detailed reports

![Quality Analytics page](/images/honeypot05.jpg)

## How to review problems found

1. Open the task **Actions** menu > **Quality control**
1. Find an annotation job to be reviewed, it must have at least 1 validation frame
1. Click the job link
1. Switch to the **Review** mode
1. Enable display of Ground Truth annotations and conflicts

![GT conflict](/images/honeypot06.gif)
Binary file added site/content/en/images/honeypot09.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/honeypot10.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/honeypot11.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/honeypot12.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9998749

Please sign in to comment.