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
@@ -118,10 +49,10 @@ This dataset repo contains:
 * The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
 * A dataset configuration folder conforming to the Argilla dataset format in `.argilla`.
 
-### Data in Argilla
-
 The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.
 
+### Fields
+
 The **fields** are the dataset samples like a 'text' field.
 
 | Field Name | Title | Type | Required | Markdown |
@@ -129,6 +60,8 @@ The **fields** are the dataset samples like a 'text' field.
 | text | text | text | True | False |
 
 
+### Questions
+
 The **questions** are the questions that will be asked to the annotators. They can be of different types, such as rating, text, label_selection, multi_label_selection, or ranking.
 
 | Question Name | Title | Type | Required | Description | Values/Labels |
@@ -141,6 +74,10 @@ The **questions** are the questions that will be asked to the annotators. They c
 | span | span | span | True | N/A | N/A |
 
 
+<!-- check length of metadata properties -->
+
+### Metadata
+
 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 |
 | ------------- | ----- | ---- | ------ | ---------------------- |
@@ -148,6 +85,8 @@ The **metadata** is a dictionary that can be used to provide additional informat
 
 
 
+
+### Vectors
 The **vectors** contain a vector representation of the record that can be used in  search.
 
 | Vector Name | Title | Dimensions |
@@ -157,26 +96,58 @@ The **vectors** contain a vector representation of the record that can be used i
 
 
 
-The **guidelines**, are optional as well, and are just a plain string that can be used to provide instructions to the annotators. Find those in the [annotation guidelines](#annotation-guidelines) section.
-
 ### Data Instances
 
 An example of a dataset instance in Argilla looks as follows:
 
 ```json
-"{\"id\":\"b583ab1c-6765-4915-94ff-245172fa92a9\",\"inserted_at\":null,\"updated_at\":null,\"fields\":{\"text\":\"Hello World, how are you?\"},\"metadata\":{},\"vectors\":{},\"responses\":[{\"values\":{\"label\":{\"value\":\"positive\"}},\"status\":\"draft\",\"user_id\":\"06f7d4c0-e048-43d2-ab3f-06f147616ac6\"}],\"suggestions\":[{\"value\":\"positive\",\"question_name\":\"label\",\"type\":null,\"score\":null,\"agent\":null,\"id\":\"49c86119-669f-4702-bc14-eb7f4da2bb9d\",\"question_id\":\"890c7c5b-d068-411d-9626-52b9ba49c8f5\"},{\"value\":[\"topic1\",\"topic2\"],\"question_name\":\"topics\",\"type\":null,\"score\":[0.9,0.8],\"agent\":null,\"id\":\"208722a7-4f5d-4bf8-a422-f92b8d8d589c\",\"question_id\":\"fc60838a-a0ad-4678-bad9-a86017585aff\"}],\"external_id\":\"8374351f-20ee-492e-afde-216958053b0f\"}"
+{
+    "_server_id": "91db788a-430c-4c73-b086-a65088efd117",
+    "fields": {
+        "text": "Hello World, how are you?"
+    },
+    "id": "04bd17cf-6e6b-4cc3-a9f6-4f6b7e88194c",
+    "metadata": {},
+    "responses": {
+        "label": [
+            {
+                "user_id": "06f7d4c0-e048-43d2-ab3f-06f147616ac6",
+                "value": "positive"
+            }
+        ]
+    },
+    "suggestions": {
+        "label": {
+            "agent": null,
+            "score": null,
+            "value": "positive"
+        },
+        "topics": {
+            "agent": null,
+            "score": [
+                0.9,
+                0.8
+            ],
+            "value": [
+                "topic1",
+                "topic2"
+            ]
+        }
+    },
+    "vectors": {}
+}
 ```
 
 While the same record in HuggingFace `datasets` looks as follows:
 
 ```json
 {
-    "_server_id": "b583ab1c-6765-4915-94ff-245172fa92a9",
+    "_server_id": "91db788a-430c-4c73-b086-a65088efd117",
     "comment.suggestion": null,
     "comment.suggestion.agent": null,
     "comment.suggestion.score": null,
     "comment_score": null,
-    "id": "8374351f-20ee-492e-afde-216958053b0f",
+    "id": "04bd17cf-6e6b-4cc3-a9f6-4f6b7e88194c",
     "label.responses": [
         "positive"
     ],