docs: align docs with FeedbackDataset refactor using tab-set
#3531
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add `argilla/oasst_response_quality` and `argilla/oasst_response_comparison` as additional `FeedbackDataset` datasets to be downloaded as part of `quickstart.Dockerfile`
`tab-set` is used to support both Argilla v1.14.0 or higher, as well as lower versions of Argilla for `FeedbackDataset` related operations
alvarobartt
added
the
type: documentation
gabrielmbmb
approved these changes
Aug 9, 2023
nataliaElv
reviewed
Aug 9, 2023
There was a problem hiding this comment.
I think that in some cases the tabs make things a bit more complicated than they are. We should be more explicit about when it's necessary to do remote_dataset = dataset.push_to_argilla(...) and when dataset.push_to_argilla(...) is good enough. If we change it everywhere with the option that saves the dataset as a variable it looks as if this is the only option. I have made some comments and suggestions concerning this issue in my review.
docs/_source/guides/llms/practical_guides/set_up_annotation_team.md
Outdated
Show resolved
Hide resolved
alvarobartt
commented
Aug 10, 2023
Co-authored-by: Gabriel Martín Blázquez <gmartinbdev@gmail.com>
Co-authored-by: Gabriel Martín Blázquez <gmartinbdev@gmail.com>
Besides @nataliaElv suggestions, some other things have also been fixed related to wrong snippets, formatting issues, and wrong URLs Co-authored-by: Natalia Elvira <natalia@argilla.io>
artikandri
pushed a commit
to CLARIN-PL/argilla
that referenced
this pull request
Oct 30, 2023
…illa-io#3531) This PR adds the `tab-set` for the outdated code-blocks with the upcoming release of Argilla v1.14.0 so as to showcase both the previous and the new code-blocks for users that are still using Argilla v1.14.0 or lower. Additionally, the style has been fixed in some documents while reviewing the outdated code-blocks, some file paths references have been fixed to point to the HTML files via relative paths, and some minor details. Finally, a `warning` has also been included to let the users know that Argilla v1.14.0 won't work for the moment with the `ArgillaCallbackHandler` in `LangChain`. **Type of change** - [X] Documentation update --------- Co-authored-by: Gabriel Martín Blázquez <gmartinbdev@gmail.com> Co-authored-by: Natalia Elvira <natalia@argilla.io>
artikandri
added a commit
to CLARIN-PL/argilla
that referenced
this pull request
Oct 30, 2023
* chore: bump version to `1.14.0` * chore: add `argilla-office-hours` Calendly link back * fix: `push_to_argilla` to return `RemoteFeedbackDataset` without re-assigning class (argilla-io#3508) # Description This PR adds a `warnings.warn` message to let the users know that the returned object from `FeedbackDataset.push_to_argilla` needs to be handled, otherwise the dataset instance will remain local, as `push_to_argilla` with no arguments won't do anything. So on, before we had to `push_to_argilla` a new `FeedbackDataset` with name and/or workspaces, and then we could `push_to_argilla` with no arguments to push the updates, but we no longer need to do that, as now we can re-use the returned `FeedbackDataset` from `push_to_argilla` to have a `FeedbackDataset` fully integrated with Argilla. ```diff import argilla as rg dataset = rg.FeedbackDataset(...) - dataset.push_to_argilla(name="my-dataset", workspace="my-workspace") + remote_dataset = dataset.push_to_argilla(name="my-dataset", workspace="my-workspace") dataset.add_records(...) - dataset.push_to_argilla() ``` **Type of change** - [X] Bug fix (non-breaking change which fixes an issue) - [X] Breaking change (fix or feature that would cause existing functionality to not work as expected) **How Has This Been Tested** - [X] Catch returned object in `push_to_argilla` and handle `DeprecationWarning` **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [X] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: Gabriel Martín Blázquez <gmartinbdev@gmail.com> * feat: add `delete` method to `FeedbackDataset` in Argilla (argilla-io#3512) # Description This PR adds a `delete` method for `RemoteFeedbackDataset` which is a `FeedbackDataset` that has been pushed to Argilla. So on, the `delete` method deletes a dataset in Argilla, but it's just available for `owner` users and for `admin` users with that dataset within their workspace, otherwise the method won't work and will raise a `PermissionError`. So on, now both `owner` and `admin` users can delete a `FeedbackDataset` from Argilla as: ```python import argilla as rg rg.init(...) dataset = FeedbackDataset.from_argilla(...) dataset.delete() ``` Or alternatively ```python import argilla as rg rg.init(...) dataset = FeedbackDataset(...) remote_dataset = dataset.push_to_argilla(...) remote_dataset.delete() ``` Closes argilla-io#3413 **Type of change** - [X] New feature (non-breaking change which adds functionality) **How Has This Been Tested** - [X] Add integration tests for `RemoteFeedbackDataset.delete` including every role **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [X] My changes generate no new warnings - [X] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [X] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) * fix: `publish_dataset` to check `required=True` on at least one field/question (argilla-io#3511) # Description This PR fixes a bug with the `PUT /api/v1/datasets/{dataset_id}/publish` endpoint, as there was a missing check on the `required` flag for each field/question which was allowing to publish `FeedbackTask` datasets with no required fields and/or questions. **Type of change** - [X] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** - [X] Update existing unit/integration tests - [X] Add unit/integration tests with `required=True` and `required=False` **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [X] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: Gabriel Martin <gabriel@argilla.io> * docs: fix link to ASGI middleware tutorial (argilla-io#3518) # Description Fix broken link to ASGI middleware tutorial. **Type of change** - [x] Documentation update **How Has This Been Tested** N/A **Checklist** - [ ] I added relevant documentation - [x] follows the style guidelines of this project - [x] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) * fix: `thread_ts` is not always present (argilla-io#3538) # Description The `slack-post-credentials` action is failing from time to time because not all the messages have the `thread_ts` key. This PR fixes this issue using the `ts` key instead of the `thread_ts`. **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) The deployment job got executed fine for this PR: https://github.com/argilla-io/argilla/actions/runs/5818199084/job/15774977297?pr=3538 **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) * fix: restore `suggestions` and `responses` as rows in `HuggingFaceDatasetMixin` (argilla-io#3539) # Description This PR addresses the feature mentioned by @tomaarsen at argilla-io#3467, to basically export the `responses` for the existing questions in the `FeedbackDataset` when calling `push_to_huggingface` in a row-based format instead of using the `Sequence` from 🤗`datasets`. This makes the dataset from the HuggingFace Hub more readable, and also easier to use with other frameworks and/or libraries. ```diff - {"user_id": ["A", "B"], "value": [1, 2], "status": ["C", "D"]} + [{"user_id": "A", "value": 1, "status": "C"}, {"user_id": "B", "value": 2, "status": "D"}] ``` Additionally, this PR also ensure that the backwards compatibility is preserved with the previous versions, and assumes the new format as the default one when calling `format_as("datasets")`. Finally, this PR also solves an issue reported by @nataliaElv recently that was affecting the `suggestions` when calling `FeedbackDataset.from_argilla`, as those were just kept when there were `responses`, otherwise, a `continue` statement was being called so the `suggestions` were completely ignored. **Type of change** - [X] Bug fix (non-breaking change which fixes an issue) - [X] New feature (non-breaking change which adds functionality) **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) - [X] Ran the following script and tested different combinations as the connection to HuggingFace is mocked, but we should create a fake/testing user at some point to avoid overloading `argilla-io` ```python import argilla as rg dataset = rg.FeedbackDataset( fields=[ rg.TextField( name="prompt", required=True, ), ], questions=[ rg.TextQuestion( name="response-edit", title="Add or edit the response if necessary", required=True, ), ], ) dataset.add_records( rg.FeedbackRecord( fields={ "prompt": "This is the prompt!", }, suggestions=[ { "question_name": "response-edit", "value": "This is the suggestion!" } ], ) ) dataset.push_to_huggingface("<REPO_ID>") dataset = rg.FeedbackDataset.from_huggingface("<REPO_ID>") assert dataset.records[0].suggestions is not None ``` **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [X] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [X] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: Gabriel Martin <gabriel@argilla.io> * docs: Update dataset page (argilla-io#3535) <!-- Thanks for your contribution! As part of our Community Growers initiative 🌱, we're donating Justdiggit bunds in your name to reforest sub-Saharan Africa. To claim your Community Growers certificate, please contact David Berenstein in our Slack community or fill in this form https://tally.so/r/n9XrxK once your PR has been merged. --> # Description New page to showcase different workflows to update and make changes to an existing Argilla dataset. Closes argilla-io#3534 **Type of change** (Remember to title the PR according to the type of change) - [x] Documentation update **How Has This Been Tested** (Please describe the tests that you ran to verify your changes.) - [x] `sphinx-autobuild` (read [Developer Documentation](https://docs.argilla.io/en/latest/community/developer_docs.html#building-the-documentation) for more details) **Checklist** - [ ] I added relevant documentation - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) --------- Co-authored-by: Alvaro Bartolome <alvaro@argilla.io> * docs: align docs with `FeedbackDataset` refactor using `tab-set` (argilla-io#3531) This PR adds the `tab-set` for the outdated code-blocks with the upcoming release of Argilla v1.14.0 so as to showcase both the previous and the new code-blocks for users that are still using Argilla v1.14.0 or lower. Additionally, the style has been fixed in some documents while reviewing the outdated code-blocks, some file paths references have been fixed to point to the HTML files via relative paths, and some minor details. Finally, a `warning` has also been included to let the users know that Argilla v1.14.0 won't work for the moment with the `ArgillaCallbackHandler` in `LangChain`. **Type of change** - [X] Documentation update --------- Co-authored-by: Gabriel Martín Blázquez <gmartinbdev@gmail.com> Co-authored-by: Natalia Elvira <natalia@argilla.io> * fix: Argilla not working behind proxy (argilla-io#3543) # Description This PR updates the URL in which the Argilla App is mounted to be `"/"`, as it's not required to change the URL of the server because the proxy will know what rewrite has to be done. In addition, the entrypoint scripts of both images have been updated to add the `--root-path $ARGILLA_BASE_URL` option to the `uvicorn` command if `ARGILLA_BASE_URL` env variable has been set. More info: [FastAPI - Behind a proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#behind-a-proxy). Closes argilla-io#3542 **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** - [x] `localhost/argilla` load in a web browser and can connect using `rg.init` with an NGINX local setup: <details> <summary>Local Nginx</summary> `docker-compose.yaml`: ```yaml version: '3.8' services: argilla: image: argilla/argilla-quickstart:pr-3543 environment: ARGILLA_BASE_URL: /argilla LOAD_DATASETS: none ports: - 6900:6900 nginx: image: nginx:latest ports: - 80:80 volumes: - ./nginx.conf:/etc/nginx/nginx.conf ``` `nginx.conf`: ``` events {} http { server { listen 80; server_name your_server_name_or_ip; location /argilla/ { proxy_pass http://argilla:6900/; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; } } } ``` </details> **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) * fix: execute build docker only if build python (argilla-io#3547) # Description This PR updates the `package.yaml` workflow to **only** execute the `build_server_docker_image` job if the `build_python_package` has been executed and it's execution has succeeded (as the first job needs the python package artifact generated by the second one) Closes argilla-io#3544 **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** N/A **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) * chore: bump frontend version to `1.14.0` * fix: `{FieldSchema, QuestionSchema}.name` attribute didn't have regex validation (argilla-io#3550) # Description This PR adds the regex validation to the `{FieldSchema, QuestionSchema}.name` attribute. This regex validation is already present in the server side, adding it to the client will allow to raise a `ValidationError` before calling the server. Closes argilla-io#3548 **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** Added new unit tests covering the described issue above. **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) --------- Co-authored-by: Alvaro Bartolome <alvaro@argilla.io> --------- Co-authored-by: gabrielmbmb <gmartinbdev@gmail.com> Co-authored-by: Alvaro Bartolome <alvaro@argilla.io> Co-authored-by: Gabriel Martin <gabriel@argilla.io> Co-authored-by: Natalia Elvira <126158523+nataliaElv@users.noreply.github.com> Co-authored-by: Natalia Elvira <natalia@argilla.io>
artikandri
added a commit
to CLARIN-PL/argilla
that referenced
this pull request
Oct 31, 2023
* chore: bump version to `1.14.0` * chore: add `argilla-office-hours` Calendly link back * fix: `push_to_argilla` to return `RemoteFeedbackDataset` without re-assigning class (argilla-io#3508) # Description This PR adds a `warnings.warn` message to let the users know that the returned object from `FeedbackDataset.push_to_argilla` needs to be handled, otherwise the dataset instance will remain local, as `push_to_argilla` with no arguments won't do anything. So on, before we had to `push_to_argilla` a new `FeedbackDataset` with name and/or workspaces, and then we could `push_to_argilla` with no arguments to push the updates, but we no longer need to do that, as now we can re-use the returned `FeedbackDataset` from `push_to_argilla` to have a `FeedbackDataset` fully integrated with Argilla. ```diff import argilla as rg dataset = rg.FeedbackDataset(...) - dataset.push_to_argilla(name="my-dataset", workspace="my-workspace") + remote_dataset = dataset.push_to_argilla(name="my-dataset", workspace="my-workspace") dataset.add_records(...) - dataset.push_to_argilla() ``` **Type of change** - [X] Bug fix (non-breaking change which fixes an issue) - [X] Breaking change (fix or feature that would cause existing functionality to not work as expected) **How Has This Been Tested** - [X] Catch returned object in `push_to_argilla` and handle `DeprecationWarning` **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [X] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- * feat: add `delete` method to `FeedbackDataset` in Argilla (argilla-io#3512) # Description This PR adds a `delete` method for `RemoteFeedbackDataset` which is a `FeedbackDataset` that has been pushed to Argilla. So on, the `delete` method deletes a dataset in Argilla, but it's just available for `owner` users and for `admin` users with that dataset within their workspace, otherwise the method won't work and will raise a `PermissionError`. So on, now both `owner` and `admin` users can delete a `FeedbackDataset` from Argilla as: ```python import argilla as rg rg.init(...) dataset = FeedbackDataset.from_argilla(...) dataset.delete() ``` Or alternatively ```python import argilla as rg rg.init(...) dataset = FeedbackDataset(...) remote_dataset = dataset.push_to_argilla(...) remote_dataset.delete() ``` Closes argilla-io#3413 **Type of change** - [X] New feature (non-breaking change which adds functionality) **How Has This Been Tested** - [X] Add integration tests for `RemoteFeedbackDataset.delete` including every role **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [X] My changes generate no new warnings - [X] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [X] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) * fix: `publish_dataset` to check `required=True` on at least one field/question (argilla-io#3511) # Description This PR fixes a bug with the `PUT /api/v1/datasets/{dataset_id}/publish` endpoint, as there was a missing check on the `required` flag for each field/question which was allowing to publish `FeedbackTask` datasets with no required fields and/or questions. **Type of change** - [X] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** - [X] Update existing unit/integration tests - [X] Add unit/integration tests with `required=True` and `required=False` **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [X] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- * docs: fix link to ASGI middleware tutorial (argilla-io#3518) # Description Fix broken link to ASGI middleware tutorial. **Type of change** - [x] Documentation update **How Has This Been Tested** N/A **Checklist** - [ ] I added relevant documentation - [x] follows the style guidelines of this project - [x] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) * fix: `thread_ts` is not always present (argilla-io#3538) # Description The `slack-post-credentials` action is failing from time to time because not all the messages have the `thread_ts` key. This PR fixes this issue using the `ts` key instead of the `thread_ts`. **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) The deployment job got executed fine for this PR: https://github.com/argilla-io/argilla/actions/runs/5818199084/job/15774977297?pr=3538 **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) * fix: restore `suggestions` and `responses` as rows in `HuggingFaceDatasetMixin` (argilla-io#3539) # Description This PR addresses the feature mentioned by @tomaarsen at argilla-io#3467, to basically export the `responses` for the existing questions in the `FeedbackDataset` when calling `push_to_huggingface` in a row-based format instead of using the `Sequence` from 🤗`datasets`. This makes the dataset from the HuggingFace Hub more readable, and also easier to use with other frameworks and/or libraries. ```diff - {"user_id": ["A", "B"], "value": [1, 2], "status": ["C", "D"]} + [{"user_id": "A", "value": 1, "status": "C"}, {"user_id": "B", "value": 2, "status": "D"}] ``` Additionally, this PR also ensure that the backwards compatibility is preserved with the previous versions, and assumes the new format as the default one when calling `format_as("datasets")`. Finally, this PR also solves an issue reported by @nataliaElv recently that was affecting the `suggestions` when calling `FeedbackDataset.from_argilla`, as those were just kept when there were `responses`, otherwise, a `continue` statement was being called so the `suggestions` were completely ignored. **Type of change** - [X] Bug fix (non-breaking change which fixes an issue) - [X] New feature (non-breaking change which adds functionality) **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) - [X] Ran the following script and tested different combinations as the connection to HuggingFace is mocked, but we should create a fake/testing user at some point to avoid overloading `argilla-io` ```python import argilla as rg dataset = rg.FeedbackDataset( fields=[ rg.TextField( name="prompt", required=True, ), ], questions=[ rg.TextQuestion( name="response-edit", title="Add or edit the response if necessary", required=True, ), ], ) dataset.add_records( rg.FeedbackRecord( fields={ "prompt": "This is the prompt!", }, suggestions=[ { "question_name": "response-edit", "value": "This is the suggestion!" } ], ) ) dataset.push_to_huggingface("<REPO_ID>") dataset = rg.FeedbackDataset.from_huggingface("<REPO_ID>") assert dataset.records[0].suggestions is not None ``` **Checklist** - [ ] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [X] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [X] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- * docs: Update dataset page (argilla-io#3535) <!-- Thanks for your contribution! As part of our Community Growers initiative 🌱, we're donating Justdiggit bunds in your name to reforest sub-Saharan Africa. To claim your Community Growers certificate, please contact David Berenstein in our Slack community or fill in this form https://tally.so/r/n9XrxK once your PR has been merged. --> # Description New page to showcase different workflows to update and make changes to an existing Argilla dataset. Closes argilla-io#3534 **Type of change** (Remember to title the PR according to the type of change) - [x] Documentation update **How Has This Been Tested** (Please describe the tests that you ran to verify your changes.) - [x] `sphinx-autobuild` (read [Developer Documentation](https://docs.argilla.io/en/latest/community/developer_docs.html#building-the-documentation) for more details) **Checklist** - [ ] I added relevant documentation - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) --------- * docs: align docs with `FeedbackDataset` refactor using `tab-set` (argilla-io#3531) This PR adds the `tab-set` for the outdated code-blocks with the upcoming release of Argilla v1.14.0 so as to showcase both the previous and the new code-blocks for users that are still using Argilla v1.14.0 or lower. Additionally, the style has been fixed in some documents while reviewing the outdated code-blocks, some file paths references have been fixed to point to the HTML files via relative paths, and some minor details. Finally, a `warning` has also been included to let the users know that Argilla v1.14.0 won't work for the moment with the `ArgillaCallbackHandler` in `LangChain`. **Type of change** - [X] Documentation update --------- * fix: Argilla not working behind proxy (argilla-io#3543) # Description This PR updates the URL in which the Argilla App is mounted to be `"/"`, as it's not required to change the URL of the server because the proxy will know what rewrite has to be done. In addition, the entrypoint scripts of both images have been updated to add the `--root-path $ARGILLA_BASE_URL` option to the `uvicorn` command if `ARGILLA_BASE_URL` env variable has been set. More info: [FastAPI - Behind a proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#behind-a-proxy). Closes argilla-io#3542 **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** - [x] `localhost/argilla` load in a web browser and can connect using `rg.init` with an NGINX local setup: <details> <summary>Local Nginx</summary> `docker-compose.yaml`: ```yaml version: '3.8' services: argilla: image: argilla/argilla-quickstart:pr-3543 environment: ARGILLA_BASE_URL: /argilla LOAD_DATASETS: none ports: - 6900:6900 nginx: image: nginx:latest ports: - 80:80 volumes: - ./nginx.conf:/etc/nginx/nginx.conf ``` `nginx.conf`: ``` events {} http { server { listen 80; server_name your_server_name_or_ip; location /argilla/ { proxy_pass http://argilla:6900/; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; } } } ``` </details> **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) * fix: execute build docker only if build python (argilla-io#3547) # Description This PR updates the `package.yaml` workflow to **only** execute the `build_server_docker_image` job if the `build_python_package` has been executed and it's execution has succeeded (as the first job needs the python package artifact generated by the second one) Closes argilla-io#3544 **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** N/A **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) * chore: bump frontend version to `1.14.0` * fix: `{FieldSchema, QuestionSchema}.name` attribute didn't have regex validation (argilla-io#3550) # Description This PR adds the regex validation to the `{FieldSchema, QuestionSchema}.name` attribute. This regex validation is already present in the server side, adding it to the client will allow to raise a `ValidationError` before calling the server. Closes argilla-io#3548 **Type of change** - [x] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** Added new unit tests covering the described issue above. **Checklist** - [x] I followed the style guidelines of this project - [x] I did a self-review of my code - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the `CHANGELOG.md` file (See https://keepachangelog.com/) --------- --------- Co-authored-by: gabrielmbmb <gmartinbdev@gmail.com> Co-authored-by: Alvaro Bartolome <alvaro@argilla.io> Co-authored-by: Gabriel Martin <gabriel@argilla.io> Co-authored-by: Natalia Elvira <126158523+nataliaElv@users.noreply.github.com> Co-authored-by: Natalia Elvira <natalia@argilla.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the
tab-setfor the outdated code-blocks with the upcoming release of Argilla v1.14.0 so as to showcase both the previous and the new code-blocks for users that are still using Argilla v1.14.0 or lower.Additionally, the style has been fixed in some documents while reviewing the outdated code-blocks, some file paths references have been fixed to point to the HTML files via relative paths, and some minor details.
Finally, a
warninghas also been included to let the users know that Argilla v1.14.0 won't work for the moment with theArgillaCallbackHandlerinLangChain.Type of change