Upload README.md with huggingface_hub

README.md

@@ -4,75 +4,6 @@ tags:
 - rlfh
 - argilla
 - human-feedback
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: _server_id
-    dtype: string
-  - name: text
-    dtype: string
-  - name: label.responses
-    sequence: string
-  - name: label.responses.users
-    sequence: string
-  - name: label.suggestion
-    dtype: string
-  - name: label.suggestion.score
-    dtype: 'null'
-  - name: label.suggestion.agent
-    dtype: 'null'
-  - name: topics.suggestion
-    sequence: string
-  - name: topics.suggestion.score
-    sequence: float64
-  - name: topics.suggestion.agent
-    dtype: 'null'
-  - name: ranking.suggestion
-    sequence: string
-  - name: ranking.suggestion.score
-    dtype: 'null'
-  - name: ranking.suggestion.agent
-    dtype: 'null'
-  - name: span.suggestion.agent
-    dtype: 'null'
-  - name: vector
-    sequence: float64
-  - name: span.suggestion
-    list:
-    - name: end
-      dtype: int64
-    - name: label
-      dtype: string
-    - name: start
-      dtype: int64
-  - name: comment.suggestion.agent
-    dtype: 'null'
-  - name: rating.suggestion.agent
-    dtype: 'null'
-  - name: span.suggestion.score
-    dtype: 'null'
-  - name: rating.suggestion
-    dtype: int64
-  - name: rating.suggestion.score
-    dtype: 'null'
-  - name: comment.suggestion.score
-    dtype: float64
-  - name: comment_score
-    dtype: float64
-  - name: comment.suggestion
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 1185
-    num_examples: 4
-  download_size: 16225
-  dataset_size: 1185
 ---
 
 # Dataset Card for test-argilla-dataset
@@ -83,7 +14,7 @@ dataset_info:
 
 
 
-This dataset has been created with [Argilla](https://argilla-io.github.io). As shown in the sections below, this dataset can be loaded into Argilla as explained in [Load with Argilla](#load-with-argilla), or used directly with the `datasets` library in [Load with `datasets`](#load-with-datasets).
+This dataset has been created with [Argilla](https://github.com/argilla-io/argilla). As shown in the sections below, this dataset can be loaded into your Argilla server as explained in [Load with Argilla](#load-with-argilla), or used directly with the `datasets` library in [Load with `datasets`](#load-with-datasets).
 
 
 ## Using this dataset with Argilla
@@ -96,7 +27,7 @@ import argilla as rg
 ds = rg.Dataset.from_hub("burtenshaw/test-argilla-dataset")
 ```
 
-This will load the settings and records from the dataset repository and push them to the Argilla instance.
+This will load the settings and records from the dataset repository and push them to you Argilla server for exploration and annotation.
 
 ## Using this dataset with `datasets`
 
@@ -108,7 +39,7 @@ from datasets import load_dataset
 ds = load_dataset("burtenshaw/test-argilla-dataset")
 ```
 
-This will only load the records of the dataset, but not the Argilla settings. 
+This will only load the records of the dataset, but not the Argilla settings.
 
 ## Dataset Structure
 
@@ -122,7 +53,7 @@ The dataset is created in Argilla with: **fields**, **questions**, **suggestions
 
 ### Fields
 
-The **fields** are the dataset samples like a 'text' field.
+The **fields** are the features or text of a dataset's records. For example, the 'text' column of a text classification dataset of the 'prompt' column of an instruction following dataset.
 
 | Field Name | Title | Type | Required | Markdown |
 | ---------- | ----- | ---- | -------- | -------- |
@@ -147,7 +78,7 @@ The **questions** are the questions that will be asked to the annotators. They c
 
 ### Metadata
 
-The **metadata** is a dictionary that can be used to provide additional information about the dataset record. 
+The **metadata** is a dictionary that can be used to provide additional information about the dataset record.
 | Metadata Name | Title | Type | Values | Visible for Annotators |
 | ------------- | ----- | ---- | ------ | ---------------------- |
  | comment_score | comment_score |  | None - None | True |
@@ -171,11 +102,11 @@ An example of a dataset instance in Argilla looks as follows:
 
 ```json
 {
-    "_server_id": "91db788a-430c-4c73-b086-a65088efd117",
+    "_server_id": "40e489d9-9175-4fc0-bd17-52e7987a415b",
     "fields": {
         "text": "Hello World, how are you?"
     },
-    "id": "04bd17cf-6e6b-4cc3-a9f6-4f6b7e88194c",
+    "id": "dced7d10-90e5-4199-89a6-5df41b637ebf",
     "metadata": {},
     "responses": {
         "label": [
@@ -211,12 +142,12 @@ While the same record in HuggingFace `datasets` looks as follows:
 
 ```json
 {
-    "_server_id": "91db788a-430c-4c73-b086-a65088efd117",
+    "_server_id": "40e489d9-9175-4fc0-bd17-52e7987a415b",
     "comment.suggestion": null,
     "comment.suggestion.agent": null,
     "comment.suggestion.score": null,
     "comment_score": null,
-    "id": "04bd17cf-6e6b-4cc3-a9f6-4f6b7e88194c",
+    "id": "dced7d10-90e5-4199-89a6-5df41b637ebf",
     "label.responses": [
         "positive"
     ],