Argilla

[Changelog 1.14.1](https://github.com/argilla-io/argilla/compare/v1.14.0...v1.14.1)

Fixed

- Fixed PostgreSQL database not being updated after `begin_nested` because of missing `commit` ([3567](https://github.com/argilla-io/argilla/pull/3567)).

**Full Changelog**: https://github.com/argilla-io/argilla/compare/v1.14.0...v1.14.1

🔆 Highlights
Argilla 1.14.0 comes packed with improvements to manage **Feedback Datasets** from the Python client. Here are the most important changes in this version:


Pushing and pulling a dataset
Pushing a dataset to Argilla will now create a `RemoteFeedbackDataset` in Argilla. To make changes to your dataset in Argilla you will need to make those updates to the remote dataset. You can do so by either using the dataset returned when using the `push_to_argilla()` method (as shown in the image above) or by loading the dataset like so:
python
import argilla as rg
connect to Argilla
rg.init(api_url="...", api_key="...")
get the existing dataset in Argilla
remote_dataset = rg.FeedbackDataset.from_argilla(name="my-dataset", workspace="my-workspace")
add a list of FeedbackRecords to the dataset in Argilla
remote_dataset.add_records(...)
`
Alternatively, you can make a local copy of the dataset using the `pull()` method.
python
local_dataset = remote_dataset.pull()
`
Note that any changes that you make to this local dataset will not affect the remote dataset in Argilla.

Adding and deleting records
How to add records to an existing dataset in Argilla was demonstrated in the first code snippet in the "Pushing and pulling a dataset" section. This is how you can delete a list of records using that same dataset:
python
records_to_delete = remote_dataset.records[0:5]
remote_dataset.delete_records(records_to_delete)
`
Or delete a single record:
python
record = remote_dataset.records[-1]
record.delete()
``

Add / update suggestions in existing records
To add and update suggestions in existing records, you can simply use the `update()` method. For example:

python
for record in remote_dataset.records:
record.update(suggestions=...)
`
Note that adding a suggestion to a question that already has one will overwrite the previous suggestion. To learn more about the format that the suggestions must follow, check [our docs](https://docs.argilla.io/en/latest/guides/llms/practical_guides/create_dataset.html#add-suggestions).

Delete a dataset
You can now easily delete datasets from the Python client. To do that, get the existing dataset like demonstrated in the first section and just use:
python
remote_dataset.delete()
`

Create users with workspace assignments
Now you can create a user and directly assign existing workspaces to grant them access.
python
user = rg.User.create(username="...", first_name="...", password="...", workspaces=["ws1", "ws2"])
`

[Changelog 1.14.0](https://github.com/argilla-io/argilla/compare/v1.13.3...v1.14.0)

Added

- Added `PATCH /api/v1/fields/{field_id}` endpoint to update the field title and markdown settings ([3421](https://github.com/argilla-io/argilla/pull/3421)).
- Added `PATCH /api/v1/datasets/{dataset_id}` endpoint to update dataset name and guidelines ([3402](https://github.com/argilla-io/argilla/pull/3402)).
- Added `PATCH /api/v1/questions/{question_id}` endpoint to update question title, description and some settings (depending on the type of question) ([3477](https://github.com/argilla-io/argilla/pull/3477)).
- Added `DELETE /api/v1/records/{record_id}` endpoint to remove a record given its ID ([3337](https://github.com/argilla-io/argilla/pull/3337)).
- Added `pull` method in `RemoteFeedbackDataset` (a `FeedbackDataset` pushed to Argilla) to pull all the records from it and return it as a local copy as a `FeedbackDataset` ([3465](https://github.com/argilla-io/argilla/pull/3465)).
- Added `delete` method in `RemoteFeedbackDataset` (a `FeedbackDataset` pushed to Argilla) ([3512](https://github.com/argilla-io/argilla/pull/3512)).
- Added `delete_records` method in `RemoteFeedbackDataset`, and `delete` method in `RemoteFeedbackRecord` to delete records from Argilla ([3526](https://github.com/argilla-io/argilla/pull/3526)).

Changed

- Improved efficiency of weak labeling when dataset contains vectors ([3444](https://github.com/argilla-io/argilla/pull/3444)).
- Added `ArgillaDatasetMixin` to detach the Argilla-related functionality from the `FeedbackDataset` ([3427](https://github.com/argilla-io/argilla/pull/3427))
- Moved `FeedbackDataset`-related `pydantic.BaseModel` schemas to `argilla.client.feedback.schemas` instead, to be better structured and more scalable and maintainable ([3427](https://github.com/argilla-io/argilla/pull/3427))
- Update CLI to use database async connection ([3450](https://github.com/argilla-io/argilla/pull/3450)).
- Limit rating questions values to the positive range [1, 10] ([3451](https://github.com/argilla-io/argilla/issues/3451)).
- Updated `POST /api/users` endpoint to be able to provide a list of workspace names to which the user should be linked to ([3462](https://github.com/argilla-io/argilla/pull/3462)).
- Updated Python client `User.create` method to be able to provide a list of workspace names to which the user should be linked to ([3462](https://github.com/argilla-io/argilla/pull/3462)).
- Updated `GET /api/v1/me/datasets/{dataset_id}/records` endpoint to allow getting records matching one of the response statuses provided via query param ([3359](https://github.com/argilla-io/argilla/pull/3359)).
- Updated `POST /api/v1/me/datasets/{dataset_id}/records` endpoint to allow searching records matching one of the response statuses provided via query param ([3359](https://github.com/argilla-io/argilla/pull/3359)).
- Updated `SearchEngine.search` method to allow searching records matching one of the response statuses provided ([3359](https://github.com/argilla-io/argilla/pull/3359)).
- After calling `FeedbackDataset.push_to_argilla`, the methods `FeedbackDataset.add_records` and `FeedbackRecord.set_suggestions` will automatically call Argilla with no need of calling `push_to_argilla` explicitly ([3465](https://github.com/argilla-io/argilla/pull/3465)).
- Now calling `FeedbackDataset.push_to_huggingface` dumps the `responses` as a `List[Dict[str, Any]]` instead of `Sequence` to make it more readable via 🤗`datasets` ([3539](https://github.com/argilla-io/argilla/pull/3539)).

Fixed

- Fixed issue with `bool` values and `default` from Jinja2 while generating the HuggingFace `DatasetCard` from `argilla_template.md` ([3499](https://github.com/argilla-io/argilla/pull/3499)).
- Fixed `DatasetConfig.from_yaml` which was failing when calling `FeedbackDataset.from_huggingface` as the UUIDs cannot be deserialized automatically by `PyYAML`, so UUIDs are neither dumped nor loaded anymore ([3502](https://github.com/argilla-io/argilla/pull/3502)).
- Fixed an issue that didn't allow the Argilla server to work behind a proxy ([3543](https://github.com/argilla-io/argilla/pull/3543)).
- `TextClassificationSettings` and `TokenClassificationSettings` labels are properly parsed to strings both in the Python client and in the backend endpoint ([3495](https://github.com/argilla-io/argilla/issues/3495)).
- Fixed `PUT /api/v1/datasets/{dataset_id}/publish` to check whether at least one field and question has `required=True` ([3511](https://github.com/argilla-io/argilla/pull/3511)).
- Fixed `FeedbackDataset.from_huggingface` as `suggestions` were being lost when there were no `responses` ([3539](https://github.com/argilla-io/argilla/pull/3539)).
- Fixed `QuestionSchema` and `FieldSchema` not validating `name` attribute ([3550](https://github.com/argilla-io/argilla/pull/3550)).

Deprecated

- After calling `FeedbackDataset.push_to_argilla`, calling `push_to_argilla` again won't do anything since the dataset is already pushed to Argilla ([3465](https://github.com/argilla-io/argilla/pull/3465)).
- After calling `FeedbackDataset.push_to_argilla`, calling `fetch_records` won't do anything since the records are lazily fetched from Argilla ([3465](https://github.com/argilla-io/argilla/pull/3465)).
- After calling `FeedbackDataset.push_to_argilla`, the Argilla ID is no longer stored in the attribute/property `argilla_id` but in `id` instead ([3465](https://github.com/argilla-io/argilla/pull/3465)).

As always, thanks to our amazing contributors
* plaguss made their first contribution in https://github.com/argilla-io/argilla/pull/3454

**Full Changelog**: https://github.com/argilla-io/argilla/compare/v1.13.3...v1.14.0

[1.13.3](https://github.com/argilla-io/argilla/compare/v1.13.2...v1.13.3)

Fixed

- Fixed `ModuleNotFoundError` caused because the `argilla.utils.telemetry` module used in the `ArgillaTrainer` was importing an optional dependency not installed by default ([3471](https://github.com/argilla-io/argilla/pull/3471)).
- Fixed `ImportError` caused because the `argilla.client.feedback.config` module was importing `pyyaml` optional dependency not installed by default ([3471](https://github.com/argilla-io/argilla/pull/3471)).


**Full Changelog**: https://github.com/argilla-io/argilla/compare/v1.13.2...v1.13.3

[1.13.2](https://github.com/argilla-io/argilla/compare/v1.13.1...v1.13.2)

Fixed

- The `suggestion_type_enum` ENUM data type created in PostgreSQL didn't have any value ([3445](https://github.com/argilla-io/argilla/pull/3445)).

[1.13.1](https://github.com/argilla-io/argilla/compare/v1.13.0...v1.13.1)

Fixed

- Fix database migration for PostgreSQL (See [3438](https://github.com/argilla-io/argilla/pull/3438))


**Full Changelog**: https://github.com/argilla-io/argilla/compare/v1.13.0...v1.13.1

🔆 Highlights

✨ Suggestions
<img width="1503" alt="Dataset with suggestions" src="https://github.com/argilla-io/argilla/assets/126158523/31e82e30-737d-47f5-867a-0299756e8ca8">
You can now add suggestions to your Feedback datasets. This feature enhances the feedback collection process by providing machine-generated feedback to labelers that appears as pre-filled responses. In this way, they act as an aid for labelers' efficiency, who will only need to correct the responses that they don't agree with.

All question types in the Feedback task support suggestions, but you can only add one suggestion per question.

Learn more about this feature in our [docs](https://docs.argilla.io/en/latest/guides/llms/practical_guides/create_dataset.html#add-suggestions).


🗄️ List workspaces
We've added functionalities to list all the workspaces that a user has access to. From the Python client you will be able to list all workspaces of the current user using `rg.Workspace.list()` and in the UI you will be able to see the list of workspaces in the user settings page.

<img width="1507" alt="User settings page with workspace list" src="https://github.com/argilla-io/argilla/assets/126158523/3b2598a8-40e8-4516-88b9-d92cd30fb7e4">

Read more in the [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/workspace_management.html#list-all-the-existing-workspaces).

🏋️‍♂️ Extended training support
We are extending the support we give to help preparing data from Feedback datasets to use during training. As part of this release we include strategies to unify responses to `RankingQuestion`s and also provide a task mapping for text classification `TrainingTaskMapping.for_text_classification`.

Read more about how to use these methods to train models with Feedback collected in Argilla [here](https://docs.argilla.io/en/latest/guides/llms/practical_guides/fine_tune_others.html#training).

[Changelog 1.13.0](https://github.com/argilla-io/argilla/compare/v1.12.1...v1.13.0)

Added

- Added `GET /api/v1/users/{user_id}/workspaces` endpoint to list the workspaces to which a user belongs ([3308](https://github.com/argilla-io/argilla/pull/3308) and [#3343](https://github.com/argilla-io/argilla/pull/3343)).
- Added `HuggingFaceDatasetMixin` for internal usage, to detach the `FeedbackDataset` integrations from the class itself, and use Mixins instead ([3326](https://github.com/argilla-io/argilla/pull/3326)).
- Added `GET /api/v1/records/{record_id}/suggestions` API endpoint to get the list of suggestions for the responses associated to a record ([3304](https://github.com/argilla-io/argilla/pull/3304)).
- Added `POST /api/v1/records/{record_id}/suggestions` API endpoint to create a suggestion for a response associated to a record ([3304](https://github.com/argilla-io/argilla/pull/3304)).
- Added support for `RankingQuestionStrategy`, `RankingQuestionUnification` and the `.for_text_classification` method for the `TrainingTaskMapping` ([3364](https://github.com/argilla-io/argilla/pull/3364))
- Added `PUT /api/v1/records/{record_id}/suggestions` API endpoint to create or update a suggestion for a response associated to a record ([3304](https://github.com/argilla-io/argilla/pull/3304) & [3391](https://github.com/argilla-io/argilla/pull/3391)).
- Added `suggestions` attribute to `FeedbackRecord`, and allow adding and retrieving suggestions from the Python client ([3370](https://github.com/argilla-io/argilla/pull/3370))
- Added `allowed_for_roles` Python decorator to check whether the current user has the required role to access the decorated function/method for `User` and `Workspace` ([3383](https://github.com/argilla-io/argilla/pull/3383))
- Added API and Python Client support for workspace deletion (Closes [3260](https://github.com/argilla-io/argilla/issues/3260))
- Added `GET /api/v1/me/workspaces` endpoint to list the workspaces of the current active user ([3390](https://github.com/argilla-io/argilla/pull/3390))

Changed

- Updated output payload for `GET /api/v1/datasets/{dataset_id}/records`, `GET /api/v1/me/datasets/{dataset_id}/records`, `POST /api/v1/me/datasets/{dataset_id}/records/search` endpoints to include the suggestions of the records based on the value of the `include` query parameter ([3304](https://github.com/argilla-io/argilla/pull/3304)).
- Updated `POST /api/v1/datasets/{dataset_id}/records` input payload to add suggestions ([3304](https://github.com/argilla-io/argilla/pull/3304)).
- The `POST /api/datasets/:dataset-id/:task/bulk` endpoints don't create the dataset if does not exists (Closes [3244](https://github.com/argilla-io/argilla/issues/3244))
- Added Telemetry support for `ArgillaTrainer` (closes [3325](https://github.com/argilla-io/argilla/issues/3325))
- `User.workspaces` is no longer an attribute but a property, and is calling `list_user_workspaces` to list all the workspace names for a given user ID ([3334](https://github.com/argilla-io/argilla/pull/3334))
- Renamed `FeedbackDatasetConfig` to `DatasetConfig` and export/import from YAML as default instead of JSON (just used internally on `push_to_huggingface` and `from_huggingface` methods of `FeedbackDataset`) ([3326](https://github.com/argilla-io/argilla/pull/3326)).
- The protected metadata fields support other than textual info - existing datasets must be reindex. See [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#elasticsearch) for more detail (Closes [3332](https://github.com/argilla-io/argilla/issues/3332)).
- Updated `Dockerfile` parent image from `python:3.9.16-slim` to `python:3.10.12-slim` ([3425](https://github.com/argilla-io/argilla/pull/3425)).
- Updated `quickstart.Dockerfile` parent image from `elasticsearch:8.5.3` to `argilla/argilla-server:${ARGILLA_VERSION}` ([3425](https://github.com/argilla-io/argilla/pull/3425)).

Removed

- Removed support to non-prefixed environment variables. All valid env vars start with `ARGILLA_` (See [3392](https://github.com/argilla-io/argilla/pull/3392)).

Fixed

- Fixed `GET /api/v1/me/datasets/{dataset_id}/records` endpoint returning always the responses for the records even if `responses` was not provided via the `include` query parameter ([3304](https://github.com/argilla-io/argilla/pull/3304)).
- Values for protected metadata fields are not truncated (Closes [3331](https://github.com/argilla-io/argilla/issues/3331)).
- Big number ids are properly rendered in UI (Closes [3265](https://github.com/argilla-io/argilla/issues/3265))
- Fixed `ArgillaDatasetCard` to include the values/labels for all the existing questions ([3366](https://github.com/argilla-io/argilla/pull/3265))

Deprecated

- Integer support for record id in text classification, token classification and text2text datasets.

As always, thanks to our amazing contributors
* manijhariya made their first contribution in https://github.com/argilla-io/argilla/pull/3295

**Full Changelog**: https://github.com/argilla-io/argilla/compare/v1.12.1...1.13.0