From d236ace442b05ec1642b5f2dd7b8cb9c9a335987 Mon Sep 17 00:00:00 2001 From: nataliaElv Date: Wed, 17 Jul 2024 16:28:58 +0200 Subject: [PATCH 1/7] Update dataset section --- argilla/docs/how_to_guides/dataset.md | 95 ++++++++++++++++++++------- 1 file changed, 72 insertions(+), 23 deletions(-) diff --git a/argilla/docs/how_to_guides/dataset.md b/argilla/docs/how_to_guides/dataset.md index 5064d8f131..d5feea5992 100644 --- a/argilla/docs/how_to_guides/dataset.md +++ b/argilla/docs/how_to_guides/dataset.md @@ -446,36 +446,85 @@ dataset_exist = dataset is not None ## Update a dataset -You can update a dataset by calling the `update` method on the `Dataset` class and passing the new settings as an argument. - -!!! note - Keep in mind that once your dataset is published, only the guidelines can be updated. +Once a dataset is published, there are limited things you can update. Here is a summary of the attributes you can change: + +=== "Fields" + | Attributes | From SDK | From UI | + | ---- | ----- | -------------- | + |Name|❌|❌| + |Title|✅|✅| + |Required|❌|❌| + |Use markdown|✅|✅| + +=== "Questions" + | Attributes | From SDK | From UI | + | ---- | ----- | -------------- | + |Name|❌|❌| + |Title|❌|✅| + |Description|❌|✅| + |Required|❌|❌| + |Labels|❌|❌| + |Values|❌|❌| + |Label order|❌|✅| + |Suggestions first|❌|✅| + |Visible labels|❌|✅| + |Field|❌|❌| + |Allow overlapping|❌|❌| + |Use markdown|❌|✅| + +=== "Metadata" + | Attributes | From SDK | From UI | + | ---- | ----- | -------------- | + |Name|❌|❌| + |Title|✅|✅| + |Options|✅|❌| + |Minimum value|✅|❌| + |Maximum value|✅|❌| + |Visible for annotators|✅|✅| + |Allow extra metadata|✅|✅| + + +=== "Vectors" + | Attributes | From SDK | From UI | + | ---- | ----- | -------------- | + |Name|❌|❌| + |Title|✅|✅| + |Dimensions|❌|✅| + +=== "Guidelines" + | From SDK | From UI | + | ----- | -------------- | + |✅|✅| + +=== "Distribution" + | Attributes | From SDK | From UI | + | ---- | ----- | -------------- | + |Minimum submitted|✅*|✅*| + + > \* Can be changed as long as the dataset doesn't have any responses. + +To modify these attributes, you can simply modify the values of the attributes you wish to change and call the `update` method on the `Dataset` object. ```python -import argilla as rg +dataset = client.datasets("my_dataset") -client = rg.Argilla(api_url="", api_key="") +dataset.settings.fields["text"].use_markdown = True +dataset.settings.metadata["my_metadata"].visible_for_annotators = False -dataset_to_update = client.datasets(name="my_dataset") +dataset.update() +``` -settings_to_update = rg.Settings( - guidelines="These are some updated guidelines.", - fields=[ - rg.TextField( - name="text", - ), - ], - questions=[ - rg.LabelQuestion( - name="label", - labels=["label_4", "label_5", "label_6"] - ), - ], -) +You can also add and delete metadata properties and vector fields using the `add` and `delete` methods: + +```python +dataset = client.datasets("my_dataset") -dataset_to_update.settings = settings_to_update +# add +dataset.vectors.add(rg.VectorField(name="my_vector", dimensions=123)) +dataset.update() -dataset_updated = dataset_to_update.update() +#delete +dataset.metadata["my_metadata"].delete() ``` ## Delete a dataset From 74c119413b3f0a79cfd78d594050018501ca7688 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 17 Jul 2024 14:31:50 +0000 Subject: [PATCH 2/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- argilla/docs/how_to_guides/dataset.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/argilla/docs/how_to_guides/dataset.md b/argilla/docs/how_to_guides/dataset.md index d5feea5992..50029a51ee 100644 --- a/argilla/docs/how_to_guides/dataset.md +++ b/argilla/docs/how_to_guides/dataset.md @@ -495,7 +495,7 @@ Once a dataset is published, there are limited things you can update. Here is a | From SDK | From UI | | ----- | -------------- | |✅|✅| - + === "Distribution" | Attributes | From SDK | From UI | | ---- | ----- | -------------- | @@ -503,7 +503,7 @@ Once a dataset is published, there are limited things you can update. Here is a > \* Can be changed as long as the dataset doesn't have any responses. -To modify these attributes, you can simply modify the values of the attributes you wish to change and call the `update` method on the `Dataset` object. +To modify these attributes, you can simply modify the values of the attributes you wish to change and call the `update` method on the `Dataset` object. ```python dataset = client.datasets("my_dataset") From b5b6e6ddb2893c7ec6c41369c859c71615fa9efc Mon Sep 17 00:00:00 2001 From: nataliaElv Date: Wed, 17 Jul 2024 16:37:55 +0200 Subject: [PATCH 3/7] Typo --- argilla/docs/how_to_guides/dataset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/argilla/docs/how_to_guides/dataset.md b/argilla/docs/how_to_guides/dataset.md index d5feea5992..752e1f11d3 100644 --- a/argilla/docs/how_to_guides/dataset.md +++ b/argilla/docs/how_to_guides/dataset.md @@ -503,7 +503,7 @@ Once a dataset is published, there are limited things you can update. Here is a > \* Can be changed as long as the dataset doesn't have any responses. -To modify these attributes, you can simply modify the values of the attributes you wish to change and call the `update` method on the `Dataset` object. +To modify these attributes, you can simply set the new value of the attributes you wish to change and call the `update` method on the `Dataset` object. ```python dataset = client.datasets("my_dataset") From b776fd85b42fed46cce61386faf4736c0b2a9344 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 17 Jul 2024 14:43:54 +0000 Subject: [PATCH 4/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- argilla/docs/how_to_guides/dataset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/argilla/docs/how_to_guides/dataset.md b/argilla/docs/how_to_guides/dataset.md index 8efc271fbe..1d1930e195 100644 --- a/argilla/docs/how_to_guides/dataset.md +++ b/argilla/docs/how_to_guides/dataset.md @@ -503,7 +503,7 @@ Once a dataset is published, there are limited things you can update. Here is a > \* Can be changed as long as the dataset doesn't have any responses. -To modify these attributes, you can simply set the new value of the attributes you wish to change and call the `update` method on the `Dataset` object. +To modify these attributes, you can simply set the new value of the attributes you wish to change and call the `update` method on the `Dataset` object. ```python dataset = client.datasets("my_dataset") From ceae358a372437fa17807d0ac2fb65a10ba09761 Mon Sep 17 00:00:00 2001 From: nataliaElv Date: Wed, 17 Jul 2024 16:51:28 +0200 Subject: [PATCH 5/7] Home page admonition changes --- argilla/docs/index.md | 9 +++------ docs/_source/getting_started/argilla.md | 5 ++--- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/argilla/docs/index.md b/argilla/docs/index.md index c7e674c67a..097f4cd062 100644 --- a/argilla/docs/index.md +++ b/argilla/docs/index.md @@ -3,15 +3,12 @@ description: Argilla is a **collaboration platform for AI engineers and domain e hide: navigation --- -# Welcome to Argilla +# Welcome to Argilla 2.x Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**. -!!! SUCCESS "Welcome to Argilla 2.x!" - To skip the introductions and go directly to installing and creating your first dataset, see [Quickstart](getting_started/quickstart.md). - -!!! DANGER "Looking for Argilla 1.x?" - Looking for documentation for Argilla 1.x? Visit the latest release [here](https://docs.argilla.io/en/latest/). +!!! INFO "Looking for Argilla 1.x?" + Looking for documentation for Argilla 1.x? Visit [the latest release](https://docs.argilla.io/en/latest/). !!! NOTE "Migrate to Argilla 2.x" Want to learn how to migrate from Argilla 1.x to 2.x? Take a look at our dedicated [Migration Guide](how_to_guides/migrate_from_legacy_datasets.md). diff --git a/docs/_source/getting_started/argilla.md b/docs/_source/getting_started/argilla.md index 09fa14cb42..921ac65d49 100644 --- a/docs/_source/getting_started/argilla.md +++ b/docs/_source/getting_started/argilla.md @@ -3,9 +3,8 @@ [Argilla](https://argilla.io) is an open-source data curation platform for LLMs. Using Argilla, everyone can build robust language models through faster data curation using both human and machine feedback. We provide support for each step in the MLOps cycle, from data labeling to model monitoring. ```{admonition} Argilla 2.x -:class: danger -We are announcing that Argilla 1.29 is the final minor release for Argilla 1.x. Although we will continue to release bug fixes for this version, we will neither be adding nor removing any functionalities. Instead, we will focus our efforts on Argilla 2.x. Argilla 1.29 will reach its end-of-life on June 20, 2025. -Looking for documentation for Argilla 2.x? Visit the docs [here](https://argilla-io.github.io/argilla/)! +:class: info +We are announcing that Argilla 1.29 is the final minor release for Argilla 1.x. Although we will continue to release bug fixes for this version, we will neither be adding nor removing any functionalities. Visit the [2.x docs](https://argilla-io.github.io/argilla/)! ```