Skip to content

Commit b4fe7d8

Browse files
davidberenstein1957burtenshawpre-commit-ci[bot]
authored
docs: final documentation changes (#5080)
# Pull Request Template <!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. --> Closes #<issue_number> **Type of change** <!-- Please delete options that are not relevant. Remember to title the PR according to the 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** <!-- Please add some reference about how your feature has been tested. --> **Checklist** <!-- Please go over the list and make sure you've taken everything into account --> - 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>
1 parent 82aa0b8 commit b4fe7d8

File tree

9 files changed

+100
-88
lines changed

9 files changed

+100
-88
lines changed

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434

3535
Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
3636

37+
> [!NOTE]
38+
> 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)
39+
3740
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/).
3841

3942
## Why use Argilla?

‎argilla-frontend/README.md‎

Lines changed: 20 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,45 @@
11
<h1 align="center">
22
<a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
33
<br>
4-
✨ Argilla ✨
4+
Argilla
55
<br>
66
</h1>
7+
<h3 align="center">Work on data together, make your model outputs better!</h2>
8+
79
<p align="center">
810
<a href="https://pypi.org/project/argilla/">
9-
<img alt="CI" src="https://img.shields.io/pypi/v/argilla.svg?style=flat-square&logo=pypi&logoColor=white">
11+
<img alt="CI" src="https://img.shields.io/pypi/v/argilla.svg?style=flat-round&logo=pypi&logoColor=white">
1012
</a>
11-
<!--a href="https://anaconda.org/conda-forge/rubrix">
12-
<img alt="CI" src="https://img.shields.io/conda/vn/conda-forge/rubrix?logo=anaconda&style=flat&color=orange">
13-
</!a-->
1413
<img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
1514
<a href="https://pepy.tech/project/argilla">
16-
<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">
15+
<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">
1716
</a>
18-
<a href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
19-
<img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg" />
17+
<a href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
18+
<img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg"/>
2019
</a>
2120
</p>
2221

23-
<h2 align="center">Open-source data curation platform for LLMs</h2>
24-
<h3 align="center">MLOps for NLP: from data labeling to model monitoring</h2>
25-
26-
<br>
27-
28-
https://github.com/argilla-io/argilla/assets/1107111/49e28d64-9799-4cac-be49-19dce0f6bd86
29-
3022
<p align="center">
31-
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
32-
<img src="https://img.shields.io/badge/JOIN US ON SLACK-4A154B?style=for-the-badge&logo=slack&logoColor=white" />
23+
<a href="https://twitter.com/argilla_io">
24+
<img src="https://img.shields.io/badge/twitter-black?logo=x"/>
3325
</a>
34-
<a href="https://linkedin.com/company/argilla-io">
35-
<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" />
26+
<a href="https://www.linkedin.com/company/argilla-io">
27+
<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
3628
</a>
37-
<a href="https://twitter.com/argilla_io">
38-
<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" />
29+
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
30+
<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
3931
</a>
4032
</p>
4133

42-
<br>
34+
Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
4335

44-
<h3>
45-
<p align="center">
46-
<a href="https://docs.argilla.io">📄 Documentation</a> | </span>
47-
<a href="#-quickstart">🚀 Quickstart</a> <span> | </span>
48-
<a href="#-cheatsheet">🎼 Cheatsheet</a> <span> | </span>
49-
<a href="#-contribute">🫱🏾‍🫲🏼 Contribute</a> <span> | </span>
50-
<a href="#-roadmap">🗺️ Roadmap</a>
51-
</p>
52-
</h3>
36+
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/).
5337

54-
## 🚀 Quickstart
38+
This repository only contains developer info about the front end. If you want to get started, we recommend taking a
39+
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
5540

56-
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.
57-
58-
There are different options to get started:
59-
60-
1. Take a look at our [quickstart page](https://docs.argilla.io/en/latest/getting_started/quickstart.html) 🚀
61-
62-
2. Start contributing by looking at our [contributor guidelines](#🫱🏾‍🫲🏼-contribute) 🫱🏾‍🫲🏼
63-
64-
3. Skip some steps with our [cheatsheet](#🎼-cheatsheet) 🎼
41+
Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
42+
documentation below.
6543

6644
## 🖥️ FRONTEND
6745

@@ -99,9 +77,7 @@ npm run generate
9977

10078
## 🫱🏾‍🫲🏼 Contribute
10179

102-
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.
103-
104-
## 🥇 Contributors
80+
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.
10581

10682
<a href="https://github.com/argilla-io/argilla/graphs/contributors">
10783

‎argilla-server/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ These are the section headers that we use:
1616

1717
## [Unreleased]()
1818

19+
## [2.0.0rc1](https://github.com/argilla-io/argilla/compare/v1.29.0...v2.0.0rc1)
20+
1921
### Removed
2022

2123
- Removed all API v0 endpoints. ([#4852](https://github.com/argilla-io/argilla/pull/4852))

‎argilla-server/README.md‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
<h1 align="center">
22
<a href=""><img src="https://github.com/dvsrepo/imgs/raw/main/rg.svg" alt="Argilla" width="150"></a>
33
<br>
4-
Argilla-Server
4+
Argilla
55
<br>
66
</h1>
7-
<h3 align="center">The repository for the Python native FastAPI server for Argilla backend.</h2>
8-
7+
<h3 align="center">Work on data together, make your model outputs better!</h2>
98

109
<p align="center">
11-
<a href="https://pypi.org/project/argilla-server/">
10+
<a href="https://pypi.org/project/argilla/">
1211
<img alt="CI" src="https://img.shields.io/pypi/v/argilla.svg?style=flat-round&logo=pypi&logoColor=white">
1312
</a>
14-
<img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla-server/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
15-
<a href="https://pepy.tech/project/argilla-server">
16-
<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">
13+
<img alt="Codecov" src="https://codecov.io/gh/argilla-io/argilla/branch/main/graph/badge.svg?token=VDVR29VOMG"/>
14+
<a href="https://pepy.tech/project/argilla">
15+
<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">
1716
</a>
1817
<a href="https://huggingface.co/new-space?template=argilla/argilla-template-space">
1918
<img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-sm.svg"/>
@@ -32,11 +31,13 @@
3231
</a>
3332
</p>
3433

35-
Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full
36-
data ownership, and overall efficiency**.
34+
Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
35+
36+
> [!NOTE]
37+
> 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)
3738
3839
This repository only contains developer info about the backend server. If you want to get started, we recommend taking a
39-
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/).
40+
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
4041

4142
Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
4243
documentation below.
@@ -108,3 +109,17 @@ the [argilla-frontend](/argilla-frontend/README.md) project
108109
```sh
109110
pdm server
110111
```
112+
113+
## 🫱🏾‍🫲🏼 Contribute
114+
115+
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.
116+
117+
<a href="https://github.com/argilla-io/argilla/graphs/contributors">
118+
119+
<img src="https://contrib.rocks/image?repo=argilla-io/argilla" />
120+
121+
</a>
122+
123+
## 🗺️ Roadmap
124+
125+
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.

‎argilla-v1/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ These are the section headers that we use:
1616

1717
## [Unreleased]()
1818

19+
## [2.0.0rc1](https://github.com/argilla-io/argilla/compare/v1.29.0...v2.0.0rc1)
20+
1921
> [!NOTE]
2022
> 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).
2123

‎argilla-v1/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@
3434

3535
Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
3636

37+
> [!NOTE]
38+
> 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).
39+
3740
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/).
3841

3942
## Why use Argilla?

‎argilla/CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These are the section headers that we use:
1717
## [2.0.0rc1](https://github.com/argilla-io/argilla/compare/v1.29.0...v2.0.0rc)
1818

1919
> [!NOTE]
20-
> 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).
20+
> 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).
2121
2222
## [1.29.0](https://github.com/argilla-io/argilla/compare/v1.28.0...v1.29.0)
2323

‎argilla/docs/how_to_guides/annotate.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ If the dataset contains metadata, responses and suggestions, click on **Filter*
172172
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.
173173

174174
!!! note
175-
The text and ranking questions are not available for filtering.
175+
The text and ranking questions are not available for filtering.
176176

177177
=== "By suggestions"
178178

‎docs/_source/_common/snippets/start_page.md‎

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Welcome to
44

5-
## Argilla is a platform to build high-quality AI datasets
5+
## Argilla is a platform for building high-quality AI datasets
66

77
If you need support join the [Argilla Slack community](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g)
88

@@ -12,19 +12,15 @@ If you need support join the [Argilla Slack community](https://join.slack.com/t/
1212

1313
Get started by publishing your first dataset.
1414

15-
### 1. Open an IDE, Jupyter or Collab
16-
17-
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).
18-
19-
### 2. Install the SDK with pip
15+
### 1. Install the SDK with pip
2016

2117
To work with Argilla datasets, you need to use the Argilla SDK. You can install the SDK with pip as follows:
2218

2319
```sh
24-
pip install argilla -U
20+
pip install argilla -U --pre
2521
```
2622

27-
### 3. Connect to your Argilla server
23+
### 2. Connect to your Argilla server
2824

2925
Get your `ARGILLA_API_URL`:
3026

@@ -38,51 +34,66 @@ Make sure to replace `ARGILLA_API_URL` and `ARGILLA_API_KEY` in the code below.
3834
```python
3935
import argilla as rg
4036

41-
rg.init(
42-
api_url="ARGILLA_API_URL",
43-
api_key="ARGILLA_API_KEY",
44-
# extra_headers={"Authorization": f"Bearer {"HF_TOKEN"}"}
37+
client = rg.Argilla(
38+
api_url="<api_url>",
39+
api_key="<api_key>"
40+
# extra_headers={"Authorization": f"Bearer {HF_TOKEN}"}
4541
)
4642
```
4743

48-
### 4. Create your first dataset
44+
### 3. Create your first dataset
4945

50-
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).
46+
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/).
5147

52-
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).
48+
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>".
5349

5450
```python
55-
dataset = rg.FeedbackDataset.for_text_classification(
56-
labels=["sadness", "joy"],
57-
multi_label=False,
58-
use_markdown=True,
59-
guidelines=None,
60-
metadata_properties=None,
61-
vectors_settings=None,
51+
settings = rg.Settings(
52+
guidelines="Classify the reviews as positive or negative.",
53+
fields=[
54+
rg.TextField(
55+
name="review",
56+
title="Text from the review",
57+
use_markdown=False,
58+
),
59+
],
60+
questions=[
61+
rg.LabelQuestion(
62+
name="my_label",
63+
title="In which category does this article fit?",
64+
labels=["positive", "negative"],
65+
)
66+
],
6267
)
63-
dataset.push_to_argilla(name="my-first-dataset", workspace="<your-workspace>")
68+
dataset = rg.Dataset(
69+
name=f"my_first_dataset",
70+
workspace="<your-workspace>",
71+
settings=settings,
72+
client=client,
73+
)
74+
dataset.create()
6475
```
6576

66-
### 5. Add records
77+
### 4. Add records
6778

68-
Create a list with the records you want to add. Ensure that you match the fields with the ones specified in the previous step.
79+
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.
6980

70-
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).
81+
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/).
7182

7283
```python
7384
records = [
74-
rg.FeedbackRecord(
85+
rg.Record(
7586
fields={
76-
"text": "I am so happy today",
87+
"review": "This is a great product.",
7788
},
7889
),
79-
rg.FeedbackRecord(
90+
rg.Record(
8091
fields={
81-
"text": "I feel sad today",
92+
"review": "This is a bad product.",
8293
},
83-
)
94+
),
8495
]
85-
dataset.add_records(records)
96+
dataset.records.log(records)
8697
```
8798

8899
</div>

0 commit comments

Comments
 (0)