# Monadata.ai

## AI Trainer Dashboard

### 1. Create Projects
- Trainers can create new projects for specific data annotation tasks, setting guidelines, and defining objectives.

**UI Flow**

1. The trainer logs into their dashboard.
2. Access the "Create Project" section.
3. Input the project name, description, guidelines, and objectives.
5. Submit the form to create the project.

**API**
- POST `https://cvat.vietdht.me/api/projects`
https://cvat.vietdht.me/api/docs/#tag/projects/operation/projects_create

### 2. List Projects
- View of all projects created by the trainer, including status, number of jobs, and completion percentage.

**UI Flow**
1. Go to the "List Projects" section to view all existing projects.
2. Check project details including status, number of jobs, and progress.

**API**
- GET `https://cvat.vietdht.me/api/projects`
https://cvat.vietdht.me/api/docs/#tag/projects/operation/projects_list

### 3. Create Jobs

- Within each project, trainers can create specific annotation jobs, detailing the tasks required, attaching relevant datasets, deadline and specifying the tools to be used (e.g., bounding boxes, segmentation) - bounding boxes is default in first phrase.

**UI Flow**
1. From the list of projects, select one to add jobs to.
2. Go to "Create Jobs" within the project.
3. Enter job details, such as task description, dataset attachment, and annotation tools.
4. Submit to create the job.

**API**
- POST `https://cvat.vietdht.me/api/tasks`
https://cvat.vietdht.me/api/docs/#tag/tasks/operation/tasks_create
- POST `https://cvat.vietdht.me/api/jobs`
https://cvat.vietdht.me/api/docs/#tag/jobs/operation/jobs_create

### 4. List Jobs
- Display a detailed list of all jobs within a project, including their current status, annotator assignments, and progress.

**UI Flow**
1. Choose the project from the list to view its jobs.
2. Access the "List Jobs" section within the selected project.
3. Review the list of jobs including details like status and assigned annotators.

**API**
- GET `https://cvat.vietdht.me/api/jobs`
https://cvat.vietdht.me/api/docs/#tag/jobs/operation/jobs_list

### 5. View Job Details
- Detailed overview of a job including assigned annotators, completion status, and a link to the job workspace for review or adjustments.

- Trainers also can mark job as finished if the annotate job meet the requirement

**UI Flow**
1. From the list of jobs, select one to view more details.
2. Check the details of the job, including progress and annotator engagement.
3. If the job meets the requirement -> trainer can finish the job
4. If the job need adjustment -> trainer can mark it as not qualify

**API**
- GET `https://cvat.vietdht.me/api/jobs/{id}`
https://cvat.vietdht.me/api/docs/#tag/jobs/operation/jobs_retrieve

## Annotator/Reviewer Dashboard

### 1. List Jobs
- View a list of available jobs, categorized by 'Annotatation' and 'Validation'. Jobs can be filtered by status or type.

**UI Flow**
1. Log into the dashboard.
2. List all available jobs
3. Use filters to find specific jobs by status or type (Annotate or Review).

**API**
- GET `https://cvat-ext.vietdht.me/api/jobs`

### 2. View Job
- Detailed view of a job, including instructions, tools to be used, and progress.

**UI Flow**
1. From the list, click on a job to view more details.
2. View job specifics like instructions, tools required, and dataset previews.

**API**
- GET `https://cvat.vietdht.me/api/jobs/{id}`
https://cvat.vietdht.me/api/docs/#tag/jobs/operation/jobs_retrieve

### 3. Pick Job
- Option to select and pick a job, which then updates its status to reflect the new assignment.

**UI Flow**
1. Select a job to work on from the available list.
2. Confirm the selection to update the job's status to "In Progress."

**API**
- PATCH `https://cvat-ext.vietdht.me/api/jobs/{id}/pick`

### 4. Annotate Job
- Annotators perform the actual annotation work using specified tools and guidelines, with options to save progress and submit completed work.

**UI Flow**
1. Use the specified annotation tools to perform the task.
2. Manually/automatically save work.
3. Finish the annotation and submit for review.

**API**
- PATCH `https://cvat.vietdht.me/api/jobs/{id}/annotations`
https://cvat.vietdht.me/api/docs/#tag/jobs/operation/jobs_partial_update_annotations
- PATCH `https://cvat-ext.vietdht.me/api/jobs/{id}/complete`

### 5. Validate Job
- Reviewers check the quality of annotations against the project criteria, providing feedback or approval, and if necessary, returning the job for further refinement.

**UI Flow**
1. Check the quality of annotations against the project criteria.
2. Offer constructive feedback or approve the job.
3. If necessary, re-assign the job to the annotator for further work.

**API**
- POST `https://cvat.vietdht.me/api/issues`
https://cvat.vietdht.me/api/docs/#tag/issues/operation/issues_create