Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation. Add "Jobs page" section and update "Filter" and "Vocabulary" sections #4411

Merged
merged 3 commits into from
Mar 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions site/content/en/docs/manual/advanced/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,35 @@ To apply filters you need to click on the button on the top panel.

![](/images/image059.jpg)

## Create a filter

It will open a window for filter input. Here you will find two buttons: `Add rule` and `Add group`.

![](/images/image202.jpg)

### Rules

The "Add rule" button adds a rule for objects display. A rule may use the following properties:
The `Add rule` button adds a rule for objects display. A rule may use the following properties:

![](/images/image204.jpg)

**Supported properties:**

| Properties | Supported values | Description |
| ----------- | ------------------------------------------------------ | --------------------------------------------|
| `Label` | all the label names that are in the task | label name |
| `Type` | shape, track or tag | type of object |
| `Shape` | all shape types | type of shape |
| `Occluded` | true or false | occluded ([read more](/docs/manual/advanced/shape-mode-advanced/)) |
| `Width` | number of px or field | shape width |
| `Height` | number of px or field | shape height |
| `ServerID` | number or field | ID of the object on the server <br>(You can find out by forming a link to the object through the Action menu) |
| `ObjectID` | number or field | ID of the object in your client <br>(indicated on the objects sidebar) |
### Supported properties for annotation

| Properties | Supported values | Description |
| ------------ | ------------------------------------------------------ | ------------------------------------------- |
| `Label` | all the label names that are in the task | label name |
| `Type` | shape, track or tag | type of object |
| `Shape` | all shape types | type of shape |
| `Occluded` | true or false | occluded ([read more](/docs/manual/advanced/shape-mode-advanced/)) |
| `Width` | number of px or field | shape width |
| `Height` | number of px or field | shape height |
| `ServerID` | number or field | ID of the object on the server <br>(You can find out by forming a link to the object through the Action menu) |
| `ObjectID` | number or field | ID of the object in your client <br>(indicated on the objects sidebar) |
| `Attributes` | some other fields including attributes with a <br>similar type or a specific attribute value | any fields specified by a label |

**Supported operators for properties:**
[Supported properties for jobs list](/docs/manual/basics/jobs-page/#supported-properties-for-jobs-list)

### Supported operators for properties

`==` - Equally; `!=` - Not equal; `>` - More; `>=` - More or equal; `<` - Less; `<=` - Less or equal;

Expand All @@ -54,6 +58,10 @@ The "Add rule" button adds a rule for objects display. A rule may use the follow

`Between`; `Not between` – these operators allow you to choose a range between two values.

`Like` - this operator indicate that the property must contain a value.

`Starts with`; `Ends with` - filter by beginning or end.

Some properties support two types of values that you can choose:

![](/images/image205.jpg)
Expand All @@ -68,13 +76,13 @@ Click `Submit` to apply the filter or if you want multiple rules to be connected

### Groups

To add a group, click the "add group" button. Inside the group you can create rules or groups.
To add a group, click the `Add group` button. Inside the group you can create rules or groups.

![](/images/image207.jpg)

If there is more than one rule in the group, they can be connected by `And` or `Or` operators.
The rule group will work as well as a separate rule outside the group and will be joined by an
operator outside the group.
operator outside the group.
You can create groups within other groups, to do so you need to click the add group button within the group.

You can move rules and groups. To move the rule or group, drag it by the button.
Expand All @@ -84,6 +92,6 @@ To remove the rule or group, click on the `Delete` button.

If you activate the `Not` button, objects that don't match the group will be filtered out.
Click `Submit` to apply the filter.
The "Cancel" button undoes the filter. The `Clear filter` button removes the filter.
The `Cancel` button undoes the filter. The `Clear filter` button removes the filter.

Once applied filter automatically appears in `Recent used` list. Maximum length of the list is 10.
90 changes: 90 additions & 0 deletions site/content/en/docs/manual/basics/jobs-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: 'Jobs page'
linkTitle: 'Jobs page'
weight: 3
---

On the jobs page, users (for example, with the worker role)
can see the jobs that are assigned to them without having access to the task page,
as well as track progress, sort and apply filters to the job list.

![](/images/image243_detrac.jpg)

On the job page there is a list of jobs presented in the form of tiles, where each tile is one job.
Each element contains:
- job ID
- dimension 2D or 3D
- preview
- stage and state [see vocabulary section](/docs/manual/basics/vocabulary)
- when hovering over an element, you can see:
- size
- assignee
- menu to navigate to a task, project, or bug tracker.

In the upper right corner there is a search bar, using which you can find the job by designated user, stage, state, etc.
In the upper left corner there are sorting and filtering tools.

## Sort by

You can sort the jobs by the following parameters:
- `ID` - ID Jobs
- `Assignee` - the user to whom the job is assigned
- `Updated date` - time and date of last saved job
- `Stage` - stage set on the task page
- `State` - state set by a user assigned to the job
- `Task ID` - the ID of the task to which the job belongs
- `Project ID` - the ID of the project containing the task to which the job belongs.
- `Task name` - the name of the task to which the job belongs
- `Project name` - the name of the project containing the task to which the job belongs.

To apply sorting, drag the parameter to the top area above the horizontal bar.
The parameters below the horizontal line will not be applied.
By moving the parameters you can change the priority,
first of all sorting will occur according to the parameters that are above.

Pressing the `Sort button` switches `Ascending sort`/`Descending sort`.

## Quick filters

Quick Filters contain several frequently used filters:
- `Assigned to me` - show only those jobs that are assigned to you.
- `Not completed` - show only those jobs that have a status other than completed.

## Filter

> Applying filter disables the quick filter.

The filter works similarly to the filters for annotation,
you can create rules from [properties](#supported-properties-for-jobs-list),
[operators](/docs/manual/advanced/filter/#supported-operators-for-properties)
and values and group rules into [groups](/docs/manual/advanced/filter/#groups).
For more details, see the [filter section](/docs/manual/advanced/filter#create-a-filter).

For clear all filters press `Clear filters`.

### Supported properties for jobs list

| Properties | Supported values | Description |
| -------------- | -------------------------------------------- | ------------------------------------------- |
| `State` | all the state names | The state of the job <br>(can be changed in the menu inside the job) |
| `Stage` | all the stage names | The stage of the job <br>(is specified by a drop-down list on the task page) |
| `Dimension` | `2D` or `3D` | Depends on the data format <br>(read more in [creating an annotation task](/docs/manual/basics/creating_an_annotation_task)) |
| `Assignee` | username | Assignee is the user who is working on the job. <br>(is specified on task page) |
| `Last updated` | last modified date and time (or value range) | The date can be entered in the `dd.MM.yyyy HH:mm` format <br>or by selecting the date in the window that appears <br>when you click on the input field |
| `ID` | number or range of job ID | |
| `Task ID` | number or range of task ID | |
| `Project ID` | number or range of project ID | |
| `Task name` | task name | Set when creating a task, <br>can be changed on the ([task page](/docs/manual/basics/task-details/)) |
| `Project name` | project name | Specified when creating a project, <br>can be changed on the ([project section](/docs/manual/advanced/projects/)) |

### Date and time selection

When creating a `Last updated` rule, you can select the date and time by using the selection window.

![](/images/image244_detrac.jpg)

You can select the year and month using the arrows or by clicking on the year and month,
to select a day, click on it in the calendar,
To select the time, you can select the hours and minutes using the scrolling list.
Or you can select the current date and time by clicking the `Now` button.
To apply, click `Ok`.
14 changes: 13 additions & 1 deletion site/content/en/docs/manual/basics/vocabulary.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,16 @@ Can be used to reduce the annotation file and to facilitate editing polygons.
**Trackable** object will be tracked automatically if the previous frame was
a latest keyframe for the object. More details in the section [trackers](/docs/manual/advanced/ai-tools/#trackers).

![](/images/tracker_indication.jpg)
![](/images/tracker_indication_detrac.jpg)

---

**State** of the job. The state can be changed by an assigned user in [the menu inside the job](/docs/manual/basics/top-panel/).
There are several possible states: `new`, `in progress`, `rejected`, `completed`.

---

**Stage** of the job. The stage is specified with the drop-down list on the [task page](/docs/manual/basics/tasks-page/).
There are three stages: `annotation`, `validation` or `acceptance`. This value affects the task progress bar.

---
Binary file added site/content/en/images/image243_detrac.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/image244_detrac.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.