Update documentation. Add organization section (#4080)

* add organization section

* fix linter errors

* fix mistake

* update roles description and other sections

* fix linter error

* update task-details.md

* fix mistake

* update review section

* fix linter error

* apply suggestions

* fix linter error
main
Timur Osmanov 4 years ago committed by GitHub
parent e17d791968
commit 877daa4f2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,61 @@
---
title: 'Organization'
linkTitle: 'Organization'
weight: 2
description: 'Using organization in CVAT.'
---
## Personal workspace
Your `Personal workspace` will display the tasks and projects you've created.
## Create a new organization
To create an organization, open the user menu, go to `Organization` and click `Create`.
![](/images/image233.jpg)
Fill in the required information to create your organization.
You need to enter a `Short name` of the organization, which will be displayed in the menu.
You can specify other fields: `Full Name`, `Description` and the organization contacts.
Of them will be visible on the organization settings page.
![](/images/image234.jpg)
## Organization page
To go to the organization page, open the user menu, go to `Organization` and click `Settings`.
![](/images/image235.jpg)
### Invite members into organization
To add members, click `Invite members`. In the window that appears,
enter the email of the user you want to add and select the role (the role defines a set of rules):
- `Worker` - workers have only access to tasks, projects, and jobs, assigned to them.
- `Supervisor` - this role allows you to create and assign jobs, tasks and projects to members of the organization.
- `Maintainer` - a member with this role has all the capabilities of the role supervisor,
sees all the tasks and the projects created by other members of the organization,
has full access to the `Cloud Storages` feature, and can modify members and their roles.
- `Owner` - a role assigned to the creator of the organization with maximum capabilities.
In addition to roles, there are groups of users that are configured on the `Admin page`.
Read more about the roles in [IAM system roles section](/docs/administration/advanced/iam_system_roles).
![](/images/image236.jpg)
After you add members, they will appear on your organization settings page,
with each member listed and information about invitation details.
You can change a member's role or remove a member at any time.
![](/images/image237.jpg)
The member can leave the organization on his own by clicking `Leave organization` on the organization settings page.
### Remove organization
You can remove an organization that you created.
Deleting an organization will delete all related resources (annotations, jobs, tasks, projects, cloud storages, ..).
In order to remove an organization, click `Remove organization`,
you will be asked to confirm the deletion by entering the short name of the organization.

@ -10,45 +10,42 @@ A special mode to check the annotation allows you to point to an object or area
## Review ## Review
To go into review mode, you need to select `Request a review` in the menu and assign the user to run a check. To conduct a review, you need to change the stage to `validation` for the desired job on the task page and assign
a user who will conduct the check. Now the job will open in a fashion review. You can also switch to the `Review` mode
using the [`UI switcher`](/docs/manual/basics/top-panel/#ui-switcher) on the top panel.
![](/images/image194.jpg) ![](/images/image194.jpg)
After that, the job status will be changed to `validation`
and the reviewer will be able to open the task in review mode.
Review mode is a UI mode, there is a special `Issue` tool which you can use to identify objects Review mode is a UI mode, there is a special `Issue` tool which you can use to identify objects
or areas in the frame and describe the problem. or areas in the frame and describe the issue.
- To do this, first click `Open an issue` icon on the controls sidebar: - To do this, first click `Open an issue` icon on the controls sidebar:
![](/images/image195.jpg) ![](/images/image195.jpg)
- Then click on a place in the frame to highlight the place or highlight the area by holding the left mouse button - Then click on a place in the frame to highlight the place or highlight the area by holding the left mouse button
and describe the problem. To select an object, right-click on it and select `Open an issue` or select one and describe the issue. To select an object, right-click on it and select `Open an issue` or select one
of several quick issues. The object or area will be shaded in red. of several quick issues. The object or area will be shaded in red.
![](/images/image231.jpg) ![](/images/image231.jpg)
- The created issue will appear in the workspace and in the `Issues` tab on the objects sidebar. - The created issue will appear in the workspace and in the `Issues` tab on the objects sidebar.
- Once all the problems are marked, save the annotation, open the menu and select `submit the review`. - Once all the issues are marked, save the annotation, open the menu and select job state `rejected` or `completed`.
After that you'll see a form containing the verification statistics,
here you can give an assessment of the job and choose further actions:
- Accept - changes the status of the job to `completed`.
- Review next passes the job to another user for re-review.
- Reject - changes the status of the job to `annotation`.
![](/images/image197.jpg) ![](/images/image197.jpg)
After the review, other users will be able to see the problems, comment on each issue After the review, other users will be able to see the issues, comment on each issue
and change the status of the problem to `Resolved`. and change the status of the issue to `Resolved`.
After the issues are fixed select `Finish the job` from the menu to finish the task.
Or you can switch stage to `acceptance` on the task page.
## Resolve issues ## Resolve issues
After review, you may see the issues in the `issues` tab in the object sidebar. After review, you may see the issues in the `Issues` tab in the object sidebar.
- You can use the arrows on the `Issues` tab to navigate the frames that contain problems. - You can use the arrows on the `Issues` tab to navigate the frames that contain issues.
![](/images/image196_detrac.jpg) ![](/images/image196_detrac.jpg)

@ -19,12 +19,15 @@ and the details of the task (specified when the task was created) and the jobs s
By clicking `Copy` you will copy the labels to the clipboard. By clicking `Copy` you will copy the labels to the clipboard.
5. Assigned to — is used to assign a task to a person. Start typing an assignees name and/or 5. Assigned to — is used to assign a task to a person. Start typing an assignees name and/or
choose the right person out of the dropdown list. choose the right person out of the dropdown list.
In the list of users, you will only see the users of the [organization](/docs/manual/advanced/organization/)
where the task is created.
- `Jobs` — is a list of all jobs for a particular task. Here you can find the next data: - `Jobs` — is a list of all jobs for a particular task. Here you can find the next data:
- Jobs name with a hyperlink to it. - Jobs name with a hyperlink to it.
- Frames — the frame interval. - Frames — the frame interval.
- A status of the job. The status is specified by the user in the menu inside the job. - A stage of the job. The stage is specified by a drop-down list.
There are three types of status: annotation, validation or completed. There are three stages: `annotation`, `validation` or `acceptance`. This value affects the task progress bar.
The status of the job is changes the progress bar of the task. - A state of the job. The state can be changed by an assigned user in the menu inside the job.
There are several possible states: `new`, `in progress`, `rejected`, `completed`.
- Started on — start date of this job. - Started on — start date of this job.
- Duration — is the amount of time the job is being worked. - Duration — is the amount of time the job is being worked.
- Assignee is the user who is working on the job. - Assignee is the user who is working on the job.

@ -17,23 +17,19 @@ It is the main menu of the annotation tool. It can be used to download, upload a
Button assignment: Button assignment:
- `Dump Annotations` — downloads annotations from a task.
- `Upload Annotations` — uploads annotations into a task. - `Upload Annotations` — uploads annotations into a task.
- `Export as a dataset` — download a data set from a task in one of the [supported formats](/docs/manual/advanced/formats/).
You can also enter a `Custom name` and enable the `Save images` checkbox if you want the dataset to contain images.
- `Remove Annotations` — calls the confirmation window if you click `Delete`, the annotation of the current job - `Remove Annotations` — calls the confirmation window if you click `Delete`, the annotation of the current job
will be removed, if you click `Select range` you can remove annotation on range frames, if you activate checkbox will be removed, if you click `Select range` you can remove annotation on range frames, if you activate checkbox
`Delete only keyframe for tracks` then only keyframes will be deleted from the tracks, on the selected range. `Delete only keyframe for tracks` then only keyframes will be deleted from the tracks, on the selected range.
![](/images/image229.jpg) ![](/images/image229.jpg)
- `Export as a dataset` — download a data set from a task. Several formats are available:
- [Datumaro](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats/datumaro)
- [Pascal VOC 2012](http://host.robots.ox.ac.uk/pascal/VOC/)
- [MS COCO](http://cocodataset.org/#format-data)
- [YOLO](https://pjreddie.com/darknet/yolo/)
- `Open the task` — opens a page with details about the task. - `Open the task` — opens a page with details about the task.
- `Request a review` - calls up the form to submit the job for a review, read more in the [review](/docs/manual/advanced/review/) section. - `Change job state` - changes the state of the job (`new`, `in progress`, `rejected`, `completed`).
- `Finish the job` - changes the status of the job to `completed` and returns to the task page without review. - `Finish the job`/`Renew the job` - changes the job stage and state
- `Submit the review` - (available during the review) calls up the form to submit a review, read more in the [review](/docs/manual/advanced/review/) section. to `acceptance` and `completed` / `annotation` and `new` correspondingly.
## Save Work ## Save Work

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Loading…
Cancel
Save