Shoonya User Roles - AI4Bharat/Shoonya GitHub Wiki

User Roles

Shoonya supports various user-types to help teams with hassle-free management of data-labeling projects.

Hierarchical numbering has to be introduced as follows:

ANNOTATOR
REVIEWER
WORKSPACE MANAGER
ORGANIZATION OWNER
ADMIN

The user role with the highest role number will be eligible to perform all tasks that can be done by all the user roles below him.

`Admin`

Highest in the hierarchy, an Admin can access all the features of the site.

An admin can access:

Everything that an organization owner, workspace manager, reviewer and annotator can access.

Currently, there are no admin-specific pages that have been implemented in the frontend. Example: Page to edit all user details of a user including his password, similar to the admin panel view of the users, page to list celery results log.

`Organization Owner`

An Organization Owner can access and manage any project or platform users within the organization.

An organization owner can access:

Everything that a workspace manager, reviewer and an annotator can access.
‘Projects’ Dashboard will have the list of all the projects belonging to the organization.
‘Annotation Tasks’ page in a project, which can be filtered based on the annotators as well as the annotation status.
‘Review Tasks’ page in a project, which can be filtered based on the reviewers as well as the review status.
'All Tasks' tab in a project, which can be filtered based on the task status.
‘Start Labelling Now’, ‘Pull New Batch’ and ‘De-allocate Tasks’ buttons in the ‘Review Tasks’ page if the organization owner has been added as a reviewer to the project.
‘Start Labelling Now’, ‘Pull New Batch’ and ‘De-allocate Tasks’ buttons in the ‘Annotation Tasks’ page in a project if the organization owner has been added as an annotator to the project.
‘Annotators’ tab of a project page with ‘View’ and ‘Remove’ buttons enabled.
‘Reviewers’ tab of a project page with ‘View’ and ‘Remove’ buttons enabled.
Being an organization owner, the manager can access the report of all the annotators and as well as the report of annotations done by himself in the project annotation report.
Being an organization owner, the manager can access the report of all the reviewers and as well as the report of reviews done by himself in the project review report.
All the settings under all the tabs in the ‘Project Settings’ page
‘Datasets’ page which lists all the datasets in the organization.
‘Dataset’ functions to generate machine translations and automatic population of translation pair datasets from sentence text dataset.
‘Workspaces’ page which shows the list of all workspaces in the organization.
An organization owner can create a workspace, archive a workspace and assign and unassign managers to a workspace.
‘Organization’ page, including all the features in it.
‘My Profile’ page
‘My Progress’ page, showing the progress done by the organization owner only if he has been added as an annotator to a project.

`Workspace Manager`

For each Workspace in Shoonya, this role is responsible for management of people, data and tasks. This role acts as a manager to multiple projects inside a workspace. Workspace managers can only manage workspaces that they create or have been added to.

A workspace manager can access:

Everything that a reviewer and an annotator can access.
Projects Dashboard will have the list of all the projects belonging to the workspace of the workspace manager. If the manager manages more than one workspace, all the projects belonging to all his workspaces will be displayed in the ‘projects’ dashboard.
‘Annotation Tasks’ page in a project, which can be filtered based on the annotators as well as the annotation status.
‘Review Tasks’ page in a project, which can be filtered based on the reviewers as well as the review status.
'All Tasks' tab in a project, which can be filtered based on the task status.
‘Start Labelling Now’, ‘Pull New Batch’ and ‘De-allocate Tasks’ buttons in the ‘Review Tasks’ page if the manager has been added as a reviewer to the project.
‘Start Labelling Now’, ‘Pull New Batch’ and ‘De-allocate Tasks’ buttons in the Annotation Tasks’ page if the manager has been added as an annotator to the project.
‘Annotators’ tab of a project page with ‘View’ and ‘Remove’ buttons enabled.
‘Reviewers’ tab of a project page with ‘View’ and ‘Remove’ buttons enabled.
Being a workspace manager, the manager should be able to access the report of all the annotators and as well as the report of annotations done by himself in the project annotation report.
Being a workspace manager, the manager should be able to access the report of all the reviewers and as well as the report of reviews done by himself in the project review report.
All the settings under all the tabs in the ‘Project Settings’ page
‘Datasets’ page which lists all the datasets to which the workspace manager has access to – either by being added explicitly as a manager to a dataset instance or by having the ‘public_to_managers’ boolean field of a dataset instance being set to true.
‘Workspaces’ page which shows the list of all workspaces to which a manager belongs to. A workspace manager has access to all features in the workspaces page except archiving a workspace and assigning and unassigning managers to workspace.
‘My Profile’ page
‘My Progress’ page showing the progress done by the manager only if he has been added as an annotator to a project.

`Reviewer`

Reviews the annotations assigned by the workspace manager.

A reviewer can access:

Everything that an annotator can access.
Projects Dashboard will have the list of projects to which the reviewer has been added both as an annotator as well as reviewer.
‘Review Tasks’ page in a project, which can be filtered based on the review status.
‘Start Labelling Now’, ‘Pull New Batch’ and ‘De-allocate Tasks’ buttons in Review Tasks’ page.
‘Annotation Tasks’ tab in a project if a reviewer has been added as an annotator to a project.
‘Start Labelling Now’, ‘Pull New Batch’ and ‘De-allocate Tasks’ buttons in the Annotation Tasks’ page if the reviewer has been added as an annotator to the project.
‘Annotators’ tab of a project page if the reviewer has been added as an annotator to the project, which has the list of annotators who belong to the project.
‘Reviewers’ tab of a project page, which has the list of reviewers who belong to the project.
Reports tab of a project page, which shows the review report done by this logged-in reviewer alone.
If the reviewer has also been added as an annotator to the same project, then the ‘Reports’ tab of a project page will also show the report of the annotations done by the logged-in reviewer alone.
‘My Profile’ page
‘My Progress’ page showing the progress done by the reviewer only if he has been added as an annotator to a project.

`Annotator`

Works on Annotation of tasks assigned by the workspace manager.

An annotator can access:

Projects Dashboard having the list of projects to which the annotator has been added to.
Annotation Tasks Dashboard of a project page, which can be filtered based on the annotation status.
‘Start Labelling Now’, ‘Pull New Batch’ and ‘De-allocate Tasks’ buttons in ‘Annotation Tasks’ page.
‘Annotators’ tab of a project page, which has the list of annotators who belong to the project.
Reports tab of a project page, which shows the report of the annotations done by this logged-in annotator alone.
‘My Profile’ page
‘My Progress’ page showing the progress done by the annotator for a selected time period in all the projects to which he has been assigned. The annotator can view this report for one or more workspaces to which he belongs to.

Roles and Permissions

Actions	Annotator	Reviewer	Workspace Manager	Organization Owner	Admin
Access Annotation Workflow	✅	✅	✅	✅	✅
View Project Data	✅	✅	✅	✅	✅
View Self Progress	✅	✅	✅	✅	✅
Access Review Workflow		✅	✅	✅	✅
Import Data			✅	✅	✅
Export Data			✅	✅	✅
Assign Tasks			✅	✅	✅
Creation of New Project			✅	✅	✅
View Project Reports			✅	✅	✅
Check all annotators/reviewers progress			✅	✅	✅
Creation of New Workspace				✅	✅
Change User Roles				✅	✅
Inviting People to Org				✅	✅
Activate/Deactivate Accounts					✅
Backend Admin Panel					✅