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.

Sign up for GitHub

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

Jump to bottom

Docs correct version #3470

Closed
wants to merge 2 commits into from
Closed

Docs correct version #3470

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05e42c8
docs: correct argilla version
nataliaElv Jul 27, 2023
a3b76e1
docs: solve conflicts with #3457
nataliaElv Jul 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions docs/_source/tutorials/notebooks/labelling-tokenclassification-basics.ipynb
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

This tutorial only applies to Text2TextDataset, TokenClassificationDataset, and TextClassificationDataset datasets. To assign annotations in FeedbackDataset datasets follow this guide.

Copy link
Member

Choose a reason for hiding this comment

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

If you are using Argilla 1.11.0 or lower, you will need to call the API to get the list of users instead. As you can see in the following cell, sending requests to the API implies that the returned response will be a Python dictionary instead.

Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,22 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
".. note::\n",
"This tutorial applies only to Text2Text, Token Classification and Text Classification datasets. To assign annotations in Feedback datasets follow [this guide](../../guides/llms/practical_guides/assign_annotations.md)."
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Introduction\n",
"\n",
"Annotations are often done by teams that share the workload. When this is the case, we want to avoid annotation overlap for efficiency or to control when and how this overlap happens. To do this in Argilla `(v1.6.0)` we have two options: \n",
"Annotations are often done by teams that share the workload. When this is the case, we want to avoid annotation overlap for efficiency or to control when and how this overlap happens. To do this in Argilla `(>v1.6.0)` we have two options: \n",
"\n",
"1. we can keep a single dataset and assign a set of records to each user.\n",
"\n",
Expand Down Expand Up @@ -81,7 +91,7 @@
"metadata": {},
"outputs": [],
"source": [
"%pip install argilla==1.6.0 datasets==2.10.1 httpx==0.23.3 -qqq"
"%pip install argilla datasets httpx -qqq"
]
},
{
Expand Down Expand Up @@ -202,6 +212,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -210,15 +221,7 @@
"**Note**\n",
"\n",
"If you are using a version earlier than 1.11.0 you will need to call the API directly to get the list of users as is done in the following cell. Note that, in that case, users will be returned as dictionaries and so `users.username` will be `users['username']` instead.\n",
"</div>"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"```python\n",
"import httpx\n",
"\n",
"rg_client= rg.active_client().client\n",
Expand All @@ -229,7 +232,9 @@
"users = http.get(\"/api/users\").json()\n",
"\n",
"# optional: filter users to get only those with annotator role\n",
"users = [u for u in users if u['role']=='annotator']"
"users = [u for u in users if u['role']=='annotator']\n",
"```\n",
"</div>"
]
},
{
Expand Down Expand Up @@ -393,7 +398,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.10"
"version": "3.8.15"
},
"vscode": {
"interpreter": {
Expand Down
Loading