docs: final documentation changes (#5080)

# Pull Request Template  Closes #<issue_number> **Type of change**  - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Refactor (change restructuring the codebase without changing functionality) - Improvement (change adding some improvement to an existing functionality) - Documentation update **How Has This Been Tested**  **Checklist**  - I added relevant documentation - follows the style guidelines of this project - I did a self-review of my code - I made corresponding changes to the documentation - I confirm My changes generate no new warnings - I have added tests that prove my fix is effective or that my feature works - I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: burtenshaw <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
argilla-io · Jun 21, 2024 · b4fe7d8 · b4fe7d8
1 parent 82aa0b8
commit b4fe7d8
Show file tree

Hide file tree

Showing 9 changed files with 100 additions and 88 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,9 @@
 
 Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
 
+> [!NOTE]
+> This README represents the release candidate for the 2.0.0 SDK version. The README for the last stable version of the 1x SDK can be found [1.x](./argilla-v1/README.md)
+
 If you just want to get started, we recommend our [UI demo](https://demo.argilla.io/sign-in?auth=ZGVtbzoxMjM0NTY3OA%3D%3D) or our [free Hugging Face Spaces deployment integration](https://huggingface.co/new-space?template=argilla/argilla-template-space). Curious, and want to know more? Read our [documentation](https://argilla-io.github.io/argilla/latest/).
 
 ## Why use Argilla?

diff --git a/argilla-frontend/README.md b/argilla-frontend/README.md
@@ -1,67 +1,45 @@
 <h1 align="center">
   <a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
   <br>
-  ✨ Argilla ✨
+  Argilla
   <br>
 </h1>
+<h3 align="center">Work on data together, make your model outputs better!</h2>
+
 <p align="center">
 <a  href="https://pypi.org/project/argilla/">
-<img  alt="CI"  src="https://img.shields.io/pypi/v/argilla.svg?style=flat-square&logo=pypi&logoColor=white">
+<img alt="CI" src="https://img.shields.io/pypi/v/argilla.svg?style=flat-round&logo=pypi&logoColor=white">
 </a>
-<!--a  href="https://anaconda.org/conda-forge/rubrix">
-<img  alt="CI"  src="https://img.shields.io/conda/vn/conda-forge/rubrix?logo=anaconda&style=flat&color=orange">
-</!a-->
 <img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
 <a href="https://pepy.tech/project/argilla">
-<img  alt="CI"  src="https://static.pepy.tech/personalized-badge/argilla?period=month&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads/month">
+<img alt="CI" src="https://static.pepy.tech/personalized-badge/argilla?period=month&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads/month">
 </a>
-<a  href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
-<img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg" />
+<a href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
+<img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg"/>
 </a>
 </p>
 
-<h2 align="center">Open-source data curation platform for LLMs</h2>
-<h3 align="center">MLOps for NLP: from data labeling to model monitoring</h2>
-
-<br>
-
-https://github.com/argilla-io/argilla/assets/1107111/49e28d64-9799-4cac-be49-19dce0f6bd86
-
 <p align="center">
-<a  href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
-<img src="https://img.shields.io/badge/JOIN US ON SLACK-4A154B?style=for-the-badge&logo=slack&logoColor=white" />
+<a href="https://twitter.com/argilla_io">
+<img src="https://img.shields.io/badge/twitter-black?logo=x"/>
 </a>
-<a href="https://linkedin.com/company/argilla-io">
-<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" />
+<a href="https://www.linkedin.com/company/argilla-io">
+<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
 </a>
-<a  href="https://twitter.com/argilla_io">
-<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" />
+<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
+<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
 </a>
 </p>
 
-<br>
+Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
 
-<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="#-contribute">🫱🏾‍🫲🏼 Contribute</a> <span> | </span>
-<a href="#-roadmap">🗺️ Roadmap</a>
-</p>
-</h3>
+If you just want to get started, we recommend our [UI demo](https://demo.argilla.io/sign-in?auth=ZGVtbzoxMjM0NTY3OA%3D%3D) or our [free Hugging Face Spaces deployment integration](https://huggingface.co/new-space?template=argilla/argilla-template-space). Curious, and want to know more? Read our [documentation](https://argilla-io.github.io/argilla/latest/).
 
-## 🚀 Quickstart
+This repository only contains developer info about the front end. If you want to get started, we recommend taking a
+look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
 
-Argilla 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.
-
-There are different options to get started:
-
-1. Take a look at our [quickstart page](https://docs.argilla.io/en/latest/getting_started/quickstart.html) 🚀
-
-2. Start contributing by looking at our [contributor guidelines](#🫱🏾‍🫲🏼-contribute) 🫱🏾‍🫲🏼
-
-3. Skip some steps with our [cheatsheet](#🎼-cheatsheet) 🎼
+Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
+documentation below.
 
 ## 🖥️ FRONTEND
 
@@ -99,9 +77,7 @@ npm run generate
 
 ## 🫱🏾‍🫲🏼 Contribute
 
- To help our community with the creation of contributions, we have created our [developer](https://docs.argilla.io/en/latest/community/developer_docs.html) and [contributor](https://docs.argilla.io/en/latest/community/contributing.html) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
-
-## 🥇 Contributors
+To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
 
 <a  href="https://github.com/argilla-io/argilla/graphs/contributors">
 

diff --git a/argilla-server/CHANGELOG.md b/argilla-server/CHANGELOG.md
@@ -16,6 +16,8 @@ These are the section headers that we use:
 
 ## [Unreleased]()
 
+## [2.0.0rc1](https://github.com/argilla-io/argilla/compare/v1.29.0...v2.0.0rc1)
+
 ### Removed
 
 - Removed all API v0 endpoints. ([#4852](https://github.com/argilla-io/argilla/pull/4852))

diff --git a/argilla-server/README.md b/argilla-server/README.md
@@ -1,19 +1,18 @@
 <h1 align="center">
   <a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
   <br>
-  Argilla-Server
+  Argilla
   <br>
 </h1>
-<h3 align="center">The repository for the Python native FastAPI server for Argilla backend.</h2>
-
+<h3 align="center">Work on data together, make your model outputs better!</h2>
 
 <p align="center">
-<a  href="https://pypi.org/project/argilla-server/">
+<a  href="https://pypi.org/project/argilla/">
 <img alt="CI" src="https://img.shields.io/pypi/v/argilla.svg?style=flat-round&logo=pypi&logoColor=white">
 </a>
-<img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla-server/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
-<a href="https://pepy.tech/project/argilla-server">
-<img alt="CI" src="https://static.pepy.tech/personalized-badge/argilla-server?period=month&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads/month">
+<img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
+<a href="https://pepy.tech/project/argilla">
+<img alt="CI" src="https://static.pepy.tech/personalized-badge/argilla?period=month&units=international_system&left_color=grey&right_color=blue&left_text=pypi%20downloads/month">
 </a>
 <a href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
 <img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg"/>
@@ -32,11 +31,13 @@
 </a>
 </p>
 
-Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full
-data ownership, and overall efficiency**.
+Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
+
+> [!NOTE]
+> This README represents the release candidate for the 2.0.0 SDK version. The README for the last stable version of the 1x SDK can be found [1.x](../argilla-v1/README.md)
 
 This repository only contains developer info about the backend server. If you want to get started, we recommend taking a
-look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/).
+look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
 
 Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
 documentation below.
@@ -108,3 +109,17 @@ the [argilla-frontend](/argilla-frontend/README.md) project
 ```sh
 pdm server
 ```
+
+## 🫱🏾‍🫲🏼 Contribute
+
+To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
+
+<a  href="https://github.com/argilla-io/argilla/graphs/contributors">
+
+<img  src="https://contrib.rocks/image?repo=argilla-io/argilla" />
+
+</a>
+
+## 🗺️ Roadmap
+
+We continuously work on updating [our plans and our roadmap](https://github.com/orgs/argilla-io/projects/10/views/1) and we love to discuss those with our community. Feel encouraged to participate.
diff --git a/argilla-v1/CHANGELOG.md b/argilla-v1/CHANGELOG.md
@@ -16,6 +16,8 @@ These are the section headers that we use:
 
 ## [Unreleased]()
 
+## [2.0.0rc1](https://github.com/argilla-io/argilla/compare/v1.29.0...v2.0.0rc1)
+
 > [!NOTE]
 > As per the release of our 2.0 SDK, this changelog is deprecated and will only contain potential bug fixes for the 1.x SDK, but it will not contain any new features. For the latest features and changes, please refer to the [2.0 SDK changelog](../argilla/CHANGELOG.md).
 

diff --git a/argilla-v1/README.md b/argilla-v1/README.md
@@ -34,6 +34,9 @@
 
 Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
 
+> [!NOTE]
+> This README represents the 1.29 SDK version. We have stopped development for the 1.x SDK version, while still committing to bug fixes. If you are looking for the README of the 2.x SDK version take a look [here](../README.md).
+
 If you just want to get started, we recommend our [UI demo](https://demo.argilla.io/sign-in?auth=ZGVtbzoxMjM0NTY3OA%3D%3D) or our [2-click deployment quick start](https://docs.argilla.io/en/latest/getting_started/cheatsheet.html). Curious, and want to know more? Read our [documentation](https://docs.argilla.io/).
 
 ## Why use Argilla?

diff --git a/argilla/CHANGELOG.md b/argilla/CHANGELOG.md
@@ -17,7 +17,7 @@ These are the section headers that we use:
 ## [2.0.0rc1](https://github.com/argilla-io/argilla/compare/v1.29.0...v2.0.0rc)
 
 > [!NOTE]
-> This releas for 2.0.0rc1 does not contain any changelog entries because it is the first release candidate for the 2.0.0 version. The following versions will contain the changelog entries again. For a general overview of the changes in the 2.0.0 version, please refer to [our blog](https://argilla.io/blog/) or [our new documentation](https://argilla-io.github.io/argilla/latest).
+> This release for 2.0.0rc1 does not contain any changelog entries because it is the first release candidate for the 2.0.0 version. The following versions will contain the changelog entries again. For a general overview of the changes in the 2.0.0 version, please refer to [our blog](https://argilla.io/blog/) or [our new documentation](https://argilla-io.github.io/argilla/latest).
 
 ## [1.29.0](https://github.com/argilla-io/argilla/compare/v1.28.0...v1.29.0)
 

diff --git a/argilla/docs/how_to_guides/annotate.md b/argilla/docs/how_to_guides/annotate.md
@@ -172,7 +172,7 @@ If the dataset contains metadata, responses and suggestions, click on **Filter*
     From the `Responses` dropdown, type and select the question. You can set a range for rating questions and select specific values for label, multi-label, and span questions.
 
     !!! note
-    The text and ranking questions are not available for filtering.
+        The text and ranking questions are not available for filtering.
 
 === "By suggestions"
 

diff --git a/docs/_source/_common/snippets/start_page.md b/docs/_source/_common/snippets/start_page.md
@@ -2,7 +2,7 @@
 
 # Welcome to
 
-## Argilla is a platform to build high-quality AI datasets
+## Argilla is a platform for building high-quality AI datasets
 
 If you need support join the [Argilla Slack community](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g)
 
@@ -12,19 +12,15 @@ If you need support join the [Argilla Slack community](https://join.slack.com/t/
 
 Get started by publishing your first dataset.
 
-### 1. Open an IDE, Jupyter or Collab
-
-If you're a Collab user, you can directly use our [introductory tutorial](https://colab.research.google.com/github/argilla-io/argilla/blob/develop/docs/_source/getting_started/quickstart_workflow_feedback.ipynb).
-
-### 2. Install the SDK with pip
+### 1. Install the SDK with pip
 
 To work with Argilla datasets, you need to use the Argilla SDK. You can install the SDK with pip as follows:
 
 ```sh
-pip install argilla -U
+pip install argilla -U --pre
 ```
 
-### 3. Connect to your Argilla server
+### 2. Connect to your Argilla server
 
 Get your `ARGILLA_API_URL`:
 
@@ -38,51 +34,66 @@ Make sure to replace `ARGILLA_API_URL` and `ARGILLA_API_KEY` in the code below.
 ```python
 import argilla as rg
 
-rg.init(
-    api_url="ARGILLA_API_URL",
-    api_key="ARGILLA_API_KEY",
-    # extra_headers={"Authorization": f"Bearer {"HF_TOKEN"}"}
+client = rg.Argilla(
+    api_url="<api_url>",
+    api_key="<api_key>"
+    # extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
 )
 ```
 
-### 4. Create your first dataset
+### 3. Create your first dataset
 
-Specify a workspace where the dataset will be created. Check your workspaces in ["My settings"](/user-settings). To create a new workspace, check the [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/workspace_management.html).
+Specify a workspace where the dataset will be created. Check your workspaces in ["My settings"](/user-settings). To create a new workspace, check the [docs](https://argilla-io.github.io/argilla/latest/how_to_guides/workspace/).
 
-Create a Dataset with two labels ("sadness" and "joy"). Don't forget to replace "<your-workspace>". Here, we are using a task template, check the docs to [create a fully custom dataset](https://docs.argilla.io/en/latest/practical_guides/create_update_dataset/create_dataset.html).
+Here, we are defining a creating a dataset with a text field and a label question ("positive" and "negative"), check the docs to [create a fully custom dataset](https://argilla-io.github.io/argilla/latest/how_to_guides/dataset/). Don't forget to replace "<your-workspace>".
 
 ```python
-dataset = rg.FeedbackDataset.for_text_classification(
-    labels=["sadness", "joy"],
-    multi_label=False,
-    use_markdown=True,
-    guidelines=None,
-    metadata_properties=None,
-    vectors_settings=None,
+settings = rg.Settings(
+    guidelines="Classify the reviews as positive or negative.",
+    fields=[
+        rg.TextField(
+            name="review",
+            title="Text from the review",
+            use_markdown=False,
+        ),
+    ],
+    questions=[
+        rg.LabelQuestion(
+            name="my_label",
+            title="In which category does this article fit?",
+            labels=["positive", "negative"],
+        )
+    ],
 )
-dataset.push_to_argilla(name="my-first-dataset", workspace="<your-workspace>")
+dataset = rg.Dataset(
+    name=f"my_first_dataset",
+    workspace="<your-workspace>",
+    settings=settings,
+    client=client,
+)
+dataset.create()
 ```
 
-### 5. Add records
+### 4. Add records
 
-Create a list with the records you want to add. Ensure that you match the fields with the ones specified in the previous step.
+You can create a list with records that you want to add. Ensure that you match the fields with those specified in the question settings.
 
-You can also use `pandas` or `load_dataset` to [read an existing dataset and create records from it](https://docs.argilla.io/en/latest/practical_guides/create_update_dataset/records.html#add-records).
+You can also use `pandas` or `datasets.load_dataset` to [read an existing dataset and create records from it](https://argilla-io.github.io/argilla/latest/how_to_guides/record/).
 
 ```python
 records = [
-    rg.FeedbackRecord(
+    rg.Record(
         fields={
-            "text": "I am so happy today",
+            "review": "This is a great product.",
         },
     ),
-    rg.FeedbackRecord(
+    rg.Record(
         fields={
-            "text": "I feel sad today",
+            "review": "This is a bad product.",
         },
-    )
+    ),
 ]
-dataset.add_records(records)
+dataset.records.log(records)
 ```
 
 </div>