Release v1.8.0 (argilla-io#3024)

kcentric · May 31, 2023 · bdd5314 · bdd5314
2 parents 1d496cb + 77b0336
commit bdd5314
Show file tree

Hide file tree

Showing 292 changed files with 21,269 additions and 1,771 deletions.
diff --git a/.codecov.yml b/.codecov.yml
@@ -1,2 +1,12 @@
 comment:
   require_changes: true
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 2%
+    patch:
+      default:
+        target: auto
+        threshold: 2%
diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml
@@ -11,6 +11,8 @@ on:
       - "develop"
       - "integration"
       - "releases/**"
+      - "feature/**"
+      - "feat/**"
 
 
   pull_request:
@@ -21,6 +23,7 @@ on:
       - "feature/**"
       - "feat/**"
 
+
 env:
   # Increase this value to reset cache if etc/example-environment.yml has not changed
   CACHE_NUMBER:  5

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -26,7 +26,7 @@ repos:
         additional_dependencies: ["typer==0.7.0"]
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.263
+    rev: v0.0.269
     hooks:
       # Simulate isort via (the much faster) ruff
       - id: ruff

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -8,7 +8,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "mambaforge-4.10"
+    python: "3.8"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -18,5 +18,10 @@ sphinx:
 #formats:
 #  - pdf
 
-conda:
-  environment: environment_docs.yml
+python:
+  install:
+    - requirements: docs/_source/requirements.txt
+    -  method: pip
+       path: .
+       extra_requirements:
+       - listeners
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,8 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres to [Semanti
+c Versioning](https://semver.org/spec/v2.0.0.html).
 
 <!--
 These are the section headers that we use:
@@ -17,9 +18,67 @@ These are the section headers that we use:
 
 ## [Unreleased]
 
+
+## [1.8.0](https://github.com/argilla-io/argilla/compare/v1.7.0...v1.8.0)
+
+## Added
+
+- `/api/v1/datasets` new endpoint to list and create datasets ([#2615]).
+- `/api/v1/datasets/{dataset_id}` new endpoint to get and delete datasets ([#2615]).
+- `/api/v1/datasets/{dataset_id}/publish` new endpoint to publish a dataset ([#2615]).
+- `/api/v1/datasets/{dataset_id}/questions` new endpoint to list and create dataset questions ([#2615])
+- `/api/v1/datasets/{dataset_id}/fields` new endpoint to list and create dataset fields ([#2615])
+- `/api/v1/datasets/{dataset_id}/questions/{question_id}` new endpoint to delete a dataset questions ([#2615])
+- `/api/v1/datasets/{dataset_id}/fields/{field_id}` new endpoint to delete a dataset field ([#2615])
+- `/api/v1/workspaces/{workspace_id}` new endpoint to get workspaces by id ([#2615])
+- `/api/v1/responses/{response_id}` new endpoint to update and delete a response ([#2615])
+- `/api/v1/datasets/{dataset_id}/records` new endpoint to create and list dataset records ([#2615])
+- `/api/v1/me/datasets` new endpoint to list user visible datasets ([#2615])
+- `/api/v1/me/dataset/{dataset_id}/records` new endpoint to list  dataset records with user responses ([#2615])
+- `/api/v1/me/datasets/{dataset_id}/metrics` new endpoint to get the dataset user metrics ([#2615])
+- `/api/v1/me/records/{record_id}/responses` new endpoint to create record user responses ([#2615])
+- showing new feedback task datasets in datasets list ([#2719])
+- new page for feedback task ([#2680])
+- show feedback task metrics ([#2822])
+- user can delete dataset in dataset settings page ([#2792])
+- Support for `FeedbackDataset` in Python client (parent PR [#2615], and nested PRs: [#2949], [#2827], [#2943], [#2945], [#2962], and [#3003])
+- Integration with the HuggingFace Hub ([#2949])
+- Added `ArgillaPeftTrainer` for text and token classificaiton [#2854](https://github.com/argilla-io/argilla/issues/2854)
+- Added `predict_proba()` method to `ArgillaSetFitTrainer`
+- Added `ArgillaAutoTrainTrainer` for Text Classification [#2664](https://github.com/argilla-io/argilla/issues/2664)
+
+- New `database revisions` command showing database revisions info
+
+[#2615]: https://github.com/argilla-io/argilla/issues/2615
+
+### Fixes
+
+- Avoid rendering html for invalid html strings in Text2text ([#2911]https://github.com/argilla-io/argilla/issues/2911)
+
 ### Changed
 
-- Argilla server docker image is built with PostgreSQL support. Closes [#2686](https://github.com/argilla-io/argilla/issues/2686)
+- The `database migrate` command accepts a `--revision` param to provide specific revision id
+- `tokens_length` metrics function returns empty data ([#3045])
+- `token_length` metrics function returns empty data ([#3045])
+- `mention_length` metrics function returns empty data ([#3045])
+- `entity_density` metrics function returns empty data ([#3045])
+
+
+### Deprecated
+
+- Using argilla with python 3.7 runtime is deprecated and support will be removed from version 1.9.0 ([#2902](https://github.com/argilla-io/argilla/issues/2902))
+- `tokens_length` metrics function has been deprecated and will be removed in 1.10.0 ([#3045])
+- `token_length` metrics function has been deprecated and will be removed in 1.10.0 ([#3045])
+- `mention_length` metrics function has been deprecated and will be removed in 1.10.0 ([#3045])
+- `entity_density` metrics function has been deprecated and will be removed in 1.10.0 ([#3045])
+
+### Removed
+
+- Removed mention `density`, `tokens_length` and `chars_length` metrics from token classification metrics storage ([#3045])
+- Removed token `char_start`, `char_end`, `tag`, and `score` metrics from token classification metrics storage ([#3045])
+- Removed tags-related metrics from token classification metrics storage ([#3045])
+
+[#3045]: https://github.com/argilla-io/argilla/pull/3045
 
 ## [1.7.0](https://github.com/argilla-io/argilla/compare/v1.6.0...v1.7.0)
 
@@ -33,6 +92,10 @@ These are the section headers that we use:
 - Added `ArgillaSpanMarkerTrainer` for Named Entity Recognition ([#2693](https://github.com/argilla-io/argilla/pull/2693))
 - Added `ArgillaTrainer` CLI support. Closes ([#2809](https://github.com/argilla-io/argilla/issues/2809))
 
+### Fixes
+
+- fix image alignment on token classification
+
 ### Changed
 
 - Argilla quickstart image dependencies are externalized into `quickstart.requirements.txt`. See [#2666](https://github.com/argilla-io/argilla/pull/2666)
@@ -46,7 +109,6 @@ These are the section headers that we use:
 
 - `argilla.training` bugfixes and unification ([#2665](https://github.com/argilla-io/argilla/issues/2665))
 - Resolved several small bugs in the `ArgillaTrainer`.
-- Avoid rendering html for invalid html strings in Text2text ([#2911]https://github.com/argilla-io/argilla/issues/2911)
 
 ### Deprecated
 
@@ -74,7 +136,6 @@ These are the section headers that we use:
 - Added `Argilla.training` module with support for `spacy`, `setfit`, and `transformers`. Closes [#2504](https://github.com/argilla-io/argilla/issues/2496)
 
 ### Fixes
-
 - Now the `prepare_for_training` method is working when `multi_label=True`. Closes [#2606](https://github.com/argilla-io/argilla/issues/2606)
 
 ### Changed
@@ -98,6 +159,8 @@ These are the section headers that we use:
 
 [#2564]: https://github.com/argilla-io/argilla/issues/2564
 
+
+
 ## [1.5.1](https://github.com/argilla-io/argilla/compare/v1.5.0...v1.5.1) - 2023-03-30
 
 ### Fixes

diff --git a/README.md b/README.md
@@ -45,10 +45,10 @@ https://user-images.githubusercontent.com/25269220/235918158-359726bb-a479-4239-
 <h3>
 <p align="center">
 <a href="https://docs.argilla.io">📄 Documentation</a> | </span>
-<a href="#🚀-quickstart">🚀 Quickstart</a> <span> | </span>
-<a href="#🎼-cheatsheet">🎼 Cheatsheet</a> <span> | </span>
-<a href="#📏-principles">📏 Principles</a> | </span>
-<a href="#🫱🏾‍🫲🏼-contribute">🫱🏾‍🫲🏼 Contribute</a>
+<a href="#-quickstart">🚀 Quickstart</a> <span> | </span>
+<a href="#-cheatsheet">🎼 Cheatsheet</a> <span> | </span>
+<a href="#-principles">📏 Principles</a> | </span>
+<a href="#-contribute">🫱🏾‍🫲🏼 Contribute</a>
 </p>
 </h3>
 
@@ -66,35 +66,51 @@ There are different options to get started:
 
 ## 🎼 Cheatsheet
 
-<table>
-<tr>
-<td> <b>Feature</b> </td> <td> <b>Description</b> </td>
-</tr>
-<tr>
-<td>
 
-<a href="https://docs.argilla.io/en/latest/getting_started/installation/deployments/docker-quickstart.html"> Deploy Locally</a>
-</td>
-<td>
+<h3><a href="https://docs.argilla.io/en/latest/getting_started/installation/deployments/docker-quickstart.html"> Deploy Locally</a></h3>
+
 
 ```bash
 docker run -d --name argilla -p 6900:6900 argilla/argilla-quickstart:latest
 ```
 
-</td>
-</tr>
-<tr>
-<td>
-<a href="https://argilla.io/blog/launching-argilla-huggingface-hub/">Deploy on Hugging Face Hub</a>
-</td>
-<td>
+<hr>
+<h3><a href="https://argilla.io/blog/launching-argilla-huggingface-hub/">Deploy on Hugging Face Hub</a></h3>
+
 <a href="https://argilla.io/blog/launching-argilla-huggingface-hub/"><img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/spaces-argilla-embed-space.png" width="100%"></a>
-</td>
-</tr>
-<tr>
-<td>
-<a href="https://docs.argilla.io/en/latest/guides/log_load_and_prepare_data.html#Argilla-Records">Create Records</a></td>
-<td>
+
+<hr>
+<h3><a href="https://docs.argilla.io/en/latest/guides/guides/llms/conceptual_guides/conceptual_guides.html">LLM support</a></h3>
+
+```python
+import argilla as rg
+
+dataset = rg.FeedbackDataset(
+    guidelines="Please, read the question carefully and try to answer it as accurately as possible.",
+    fields=[
+        rg.TextField(name="question"),
+        rg.TextField(name="answer"),
+    ],
+    questions=[
+        rg.RatingQuestion(
+            name="answer_quality",
+            description="How would you rate the quality of the answer?",
+            values=[1, 2, 3, 4, 5],
+        ),
+        rg.TextQuestion(
+            name="answer_correction",
+            description="If you think the answer is not accurate, please, correct it.",
+            required=False,
+        ),
+    ]
+)
+```
+
+<a href="https://docs.argilla.io/en/latest/guides/guides/llms/conceptual_guides/conceptual_guides.html"><img src="https://docs.argilla.io/en/latest/_images/snapshot-feedback-demo.png" width="100%"></a>
+
+<hr>
+<h3><a href="https://docs.argilla.io/en/latest/guides/log_load_and_prepare_data.html#Argilla-Records">Create Records</a></h3>
+
 
 ```python
 import argilla as rg
@@ -108,13 +124,10 @@ rg.log(records=record, name="news")
 ```
 
 <a href="https://docs.argilla.io/en/latest/guides/log_load_and_prepare_data.html#Argilla-Records"><img src="https://docs.argilla.io/en/latest/_images/features-annotate.png" width="100%"></a>
-</td>
-</tr>
-<tr>
-<td>
-<a href="https://docs.argilla.io/en/latest/guides/query_datasets.html">Query datasets</a>
-</td>
-<td>
+
+<hr>
+<h3><a href="https://docs.argilla.io/en/latest/guides/query_datasets.html">Query datasets</a></h3>
+
 
 ```python
 import argilla as rg
@@ -123,13 +136,9 @@ rg.load(name="news", query="text:spor*")
 ```
 
 <a href="https://docs.argilla.io/en/latest/guides/query_datasets.html"><img src="https://docs.argilla.io/en/latest/_images/features-search.png" width="100%">
-</td>
-</tr>
-<tr>
-<td>
-<a href="https://docs.argilla.io/en/latest/guides/label_records_with_semanticsearch.html">Semantic search</a>
-</td>
-<td>
+
+<hr>
+<h3><a href="https://docs.argilla.io/en/latest/guides/label_records_with_semanticsearch.html">Semantic search</a></h3>
 
 ```python
 import argilla as rg
@@ -144,13 +153,9 @@ rg.load(name="dataset", vector=("my_vector_name", [0, 43, 1985]))
 
 <a href="https://docs.argilla.io/en/latest/guides/label_records_with_semanticsearch.html"><img src="https://docs.argilla.io/en/latest/_images/features-similaritysearch.png" width="100%"></a>
 
-</td>
-</tr>
-<tr>
-<td>
-<a href="https://docs.argilla.io/en/latest/guides/programmatic_labeling_with_rules.html">Weak supervision</a>
-</td>
-<td>
+<hr>
+<h3><a href="https://docs.argilla.io/en/latest/guides/programmatic_labeling_with_rules.html">Weak supervision</a></h3>
+
 
 ```python
 from argilla.labeling.text_classification import add_rules, Rule
@@ -160,8 +165,7 @@ add_rules(dataset="go_emotion", rules=[rule])
 ```
 
 <a href="https://docs.argilla.io/en/latest/guides/programmatic_labeling_with_rules.html"><img src="https://docs.argilla.io/en/latest/_images/features-weak-labelling.png" width="100%"></a>
-</td>
-</tr>
+
 <!-- <tr>
 <td>
 <a href="https://argilla.io/blog/introducing-argilla-trainer">Active Learning</a>
@@ -178,11 +182,9 @@ plugin.start()
 <video src="https://share.descript.com/view/nvlUjF8tNcZ"/>
 </td>
 </tr> -->
-<tr>
-<td>
-<a href="https://argilla.io/blog/introducing-argilla-trainer">Train models</a>
-</td>
-<td>
+
+<hr>
+<h3><a href="https://argilla.io/blog/introducing-argilla-trainer">Train models</a></h3>
 
 ```python
 from argilla.training import ArgillaTrainer
@@ -192,9 +194,7 @@ trainer.train()
 ```
 
 <a href="https://argilla.io/blog/introducing-argilla-trainer"><img src="https://argilla.io/blog/introducing-argilla-trainer/train.png" width="100%"></a>
-</td>
-</tr>
-</table>
+
 
 
 ## 📏 Principles

diff --git a/docs/_source/_common/features_all.md b/docs/_source/_common/features_all.md