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

[Docs] task distribution #5246

Merged

Conversation

nataliaElv
Copy link
Member

Description

Closes #5229

Type of change

  • Documentation update

How Has This Been Tested

Checklist

  • I added relevant documentation
  • I followed the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • I confirm My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

Copy link

Docs for this PR have been deployed hidden from versioning: https://argilla-io.github.io/argilla/docs_task-distribution

Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left some comments, probably partially responding to in progress things.

argilla/docs/how_to_guides/distribution.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/distribution.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/distribution.md Outdated Show resolved Hide resolved
@davidberenstein1957
Copy link
Member

@nataliaElv, no problem. Can you create the PR to draft then? :)

@nataliaElv nataliaElv changed the title Docs: task distribution [WIP] Docs: task distribution Jul 17, 2024
@nataliaElv
Copy link
Member Author

@nataliaElv, no problem. Can you create the PR to draft then? :)

Will the deployment work if I move it to draft?

@davidberenstein1957
Copy link
Member

@nataliaElv for the docs? I think it will.

@nataliaElv nataliaElv changed the base branch from develop to feat/argilla/add-support-to-distribution July 17, 2024 10:56
Copy link

The URL of the deployed environment for this PR is https://argilla-quickstart-pr-5246-ki24f765kq-no.a.run.app

@nataliaElv nataliaElv requested review from dvsrepo and sdiazlor July 17, 2024 11:08
@nataliaElv nataliaElv changed the title [WIP] Docs: task distribution [Docs] task distribution Jul 17, 2024
Copy link
Contributor

@sdiazlor sdiazlor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just left some comments. The most importat is to clarify a bit better the differences in the status record/response. How should they be interpreted by owner/admin/annotator?

argilla/docs/how_to_guides/dataset.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/query.md Show resolved Hide resolved
argilla/mkdocs.yml Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/distribution.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/distribution.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/distribution.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/distribution.md Outdated Show resolved Hide resolved
argilla/docs/how_to_guides/distribution.md Show resolved Hide resolved
@frascuchon frascuchon added this to the v2.0.0 milestone Jul 19, 2024
@nataliaElv nataliaElv merged commit b0b1846 into feat/argilla/add-support-to-distribution Jul 19, 2024
8 checks passed
@nataliaElv nataliaElv deleted the docs/task-distribution branch July 19, 2024 08:54
frascuchon added a commit that referenced this pull request Jul 19, 2024
# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

This PR adds support to configure the task distribution strategy when
creating or updating datasets.

We can create datasets with specific task distribution setup
```python

task_distribution = TaskDistribution(min_submitted=4)

settings = Settings(
    fields=[TextField(name="text", title="text")],
    questions=[LabelQuestion(name="label", title="text", labels=["positive", "negative"])],
    distribution=task_distribution,
)
dataset = Dataset(dataset_name, settings=settings).create()
```

or update an existing dataset (without any user response)
```python
dataset = client.datasets(...)

dataset.settings.distribution.min_submitted = 100
# or 
dataset.distribution.min_submitted = 100
# or 
dataset.distribution = TaskDistribution(min_submitted=100)
dataset.update()
```


Closes #5033
Closes #5034


Refs: #5246


**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- New feature (non-breaking change which adds functionality)
- Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: José Francisco Calvo <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Damián Pumar <[email protected]>
Co-authored-by: José Francisco Calvo <[email protected]>
Co-authored-by: Leire <[email protected]>
Co-authored-by: David Berenstein <[email protected]>
Co-authored-by: Natalia Elvira <[email protected]>
Co-authored-by: Sara Han <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Task distribution how-to guide
4 participants