Skip to content

Commit

Permalink
Human protocol integration documentation (cvat-ai#7547)
Browse files Browse the repository at this point in the history
<!-- Raise an issue to propose your change
(https://github.com/opencv/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution
guide](https://opencv.github.io/cvat/docs/contributing/). -->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<!-- Why is this change required? What problem does it solve? If it
fixes an open
issue, please link to the issue here. Describe your changes in detail,
add
screenshots. -->

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [ ] I submit my changes into the `develop` branch
- [ ] I have created a changelog fragment <!-- see top comment in
CHANGELOG.md -->
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning))

### License

- [ ] I submit _my code changes_ under the same [MIT License](
https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.

---------

Co-authored-by: Maxim Zhiltsov <[email protected]>
  • Loading branch information
2 people authored and bargav25 committed Apr 10, 2024
1 parent b4c125d commit 81af102
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,8 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"python.testing.pytestPath": "${workspaceFolder}/.env/bin/pytest",
"python.testing.cwd": "${workspaceFolder}/tests"
"python.testing.cwd": "${workspaceFolder}/tests",
"cSpell.words": [
"crowdsourcing"
]
}
87 changes: 87 additions & 0 deletions site/content/en/docs/integration/human-protocol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: 'CVAT and Human Protocol'
linkTitle: 'Human Protocol'
weight: 2
---

The integration of CVAT with HUMAN Protocol offers a groundbreaking approach to data annotation
for AI and machine learning projects.

This collaboration combines CVAT's advanced annotation tools with HUMAN Protocol's
innovative task distribution and compensation system, creating a seamless,
efficient workflow for crowdsourcing annotations.

For more details on how to leverage the features of both platforms
for your projects, check out these articles:

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

- [CVAT.ai & HUMAN Protocol: A New Dawn in Visual Data Annotation](https://www.cvat.ai/post/cvat-ai-human-protocol-a-new-dawn-in-visual-data-annotation)
- [Mastering Image Annotation Crowdsourcing for Computer Vision with CVAT.ai and HUMAN Protocol](https://www.cvat.ai/post/mastering-image-annotation-crowdsourcing-for-computer-vision-with-cvat-ai-and-human-protocol)
- [Crowdsourcing Annotation with CVAT and Human Protocol: Real Data Experiment Showed Amazing Results](https://www.cvat.ai/post/crowdsource-annotations-with-cvat-and-human-protocol)
<!--lint enable maximum-line-length-->

<br>
See:

- [Basic terms](#basic-terms)
- [Requester: How to get data annotated?](#requester-how-to-get-data-annotated)
- [Annotator: How to earn money?](#annotator-how-to-earn-money)
- [Video tutorial](#video-tutorial)

## Basic terms

In the realm of computer vision and AI, understanding the roles and components within data
annotation projects is crucial.

Here's a quick overview of basic terms related to CVAT and Human Protocol
integration, providing a clear picture of the workflow and participants involved.

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

| Term | Explanation |
| --------- | -------------------------------------------------------------------------- |
| Requester | An individual or organization that needs data annotated for AI models. |
| Annotator | A person who labels data, such as images or videos, for machine learning. |
| Dataset | A collection of data, often images or videos, used for training AI models. |

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

## Requester: How to get data annotated?

> Note: Either you are Requester or Annotator,
> to access this feature, you'll need to [send a request to HUMAN Protocol](mailto:[email protected]).
To register and launch a job on the HUMAN Protocol site, follow these steps:

1. [Create a Requester account](https://docs.humanprotocol.org/human-tech-docs/job-launcher/user-guide/signup)
on the Human Protocol site.
2. Log in to your account and [launch a Job](https://docs.humanprotocol.org/human-tech-docs/job-launcher/user-guide/launch-jobs/fortune).

The job will appear on the Annotators' dashboard and will be
annotated according to the specified requirements and quality standards.

## Annotator: How to earn money?

> Note: Either you are Requester or Annotator,
> to access this feature, you'll need to [send a request to HUMAN Protocol](mailto:[email protected]).
To start earning money on the Human Protocol site, follow these simple steps:

1. [Register on the Human Protocol site](https://app.humanprotocol.org/)
2. Complete KYC process.
3. Connect crypto wallet to your account.
4. Select job from **Data Labeling Jobs** menu.
5. Annotate.
6. After annotation is complete, change job status to **Complete**.

After the job is reviewed and accepted by the Requester,
the money will be deposited into your account.

## Video tutorial

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

<iframe width="560" height="315" src="https://www.youtube.com/embed/XHQ25vhx0xE?si=6q2KVLfK2Tg62Xyj" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

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

0 comments on commit 81af102

Please sign in to comment.