Upload README.md with huggingface_hub

README.md

@@ -4,53 +4,6 @@ tags:
 - rlfh
 - argilla
 - human-feedback
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-dataset_info:
-  features:
-  - name: text
-    dtype: string
-    id: field
-  - name: label
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      dtype: string
-      id: question
-    - name: status
-      dtype: string
-      id: question
-  - name: label-suggestion
-    dtype: string
-    id: suggestion
-  - name: label-suggestion-metadata
-    struct:
-    - name: type
-      dtype: string
-      id: suggestion-metadata
-    - name: score
-      dtype: float32
-      id: suggestion-metadata
-    - name: agent
-      dtype: string
-      id: suggestion-metadata
-  - name: external_id
-    dtype: string
-    id: external_id
-  - name: metadata
-    dtype: string
-    id: metadata
-  splits:
-  - name: train
-    num_bytes: 20815
-    num_examples: 100
-  download_size: 13821
-  dataset_size: 20815
 ---
 
 # Dataset Card for emotion-custom
@@ -124,8 +77,7 @@ The **questions** are the questions that will be asked to the annotators. They c
 
 | Question Name | Title | Type | Required | Description | Values/Labels |
 | ------------- | ----- | ---- | -------- | ----------- | ------------- |
-| sentiment | Sentiment | label_selection | True | N/A | ['positive', 'neutral', 'negative'] |
-| mixed-emotion | Mixed-emotion | multi_label_selection | True | N/A | ['joy', 'anger', 'sadness', 'fear', 'surprise', 'love'] |
+| label | Label | label_selection | True | N/A | ['0', '1', '2', '3', '4', '5'] |
 
 
 The **suggestions** are human or machine generated recommendations for each question to assist the annotator during the annotation process, so those are always linked to the existing questions, and named appending "-suggestion" and "-suggestion-metadata" to those, containing the value/s of the suggestion and its metadata, respectively. So on, the possible values are the same as in the table above, but the column name is appended with "-suggestion" and the metadata is appended with "-suggestion-metadata".
@@ -150,20 +102,16 @@ An example of a dataset instance in Argilla looks as follows:
     "fields": {
         "text": "i didnt feel humiliated"
     },
-    "metadata": {},
+    "metadata": {
+        "split": "train"
+    },
     "responses": [
         {
             "status": "submitted",
             "user_id": "e53ee101-1d1c-45e3-8a68-692cd9fc71aa",
             "values": {
-                "mixed-emotion": {
-                    "value": [
-                        "anger",
-                        "sadness"
-                    ]
-                },
-                "sentiment": {
-                    "value": "positive"
+                "label": {
+                    "value": "0"
                 }
             }
         }
@@ -178,36 +126,20 @@ While the same record in HuggingFace `datasets` looks as follows:
 ```json
 {
     "external_id": null,
-    "metadata": "{}",
-    "mixed-emotion": [
-        {
-            "status": "submitted",
-            "user_id": "e53ee101-1d1c-45e3-8a68-692cd9fc71aa",
-            "value": [
-                "anger",
-                "sadness"
-            ]
-        }
-    ],
-    "mixed-emotion-suggestion": null,
-    "mixed-emotion-suggestion-metadata": {
-        "agent": null,
-        "score": null,
-        "type": null
-    },
-    "sentiment": [
+    "label": [
         {
             "status": "submitted",
             "user_id": "e53ee101-1d1c-45e3-8a68-692cd9fc71aa",
-            "value": "positive"
+            "value": "0"
         }
     ],
-    "sentiment-suggestion": null,
-    "sentiment-suggestion-metadata": {
+    "label-suggestion": null,
+    "label-suggestion-metadata": {
         "agent": null,
         "score": null,
         "type": null
     },
+    "metadata": "{\"split\": \"train\"}",
     "text": "i didnt feel humiliated"
 }
 ```
@@ -222,13 +154,11 @@ Among the dataset fields, we differentiate between the following:
 
 * **Questions:** These are the questions that will be asked to the annotators. They can be of different types, such as `RatingQuestion`, `TextQuestion`, `LabelQuestion`, `MultiLabelQuestion`, and `RankingQuestion`.
     
-    * **sentiment** is of type `label_selection` with the following allowed values ['positive', 'neutral', 'negative'].
-    * **mixed-emotion** is of type `multi_label_selection` with the following allowed values ['joy', 'anger', 'sadness', 'fear', 'surprise', 'love'].
+    * **label** is of type `label_selection` with the following allowed values ['0', '1', '2', '3', '4', '5'].
 
 * **Suggestions:** As of Argilla 1.13.0, the suggestions have been included to provide the annotators with suggestions to ease or assist during the annotation process. Suggestions are linked to the existing questions, are always optional, and contain not just the suggestion itself, but also the metadata linked to it, if applicable.
     
-    * (optional) **sentiment-suggestion** is of type `label_selection` with the following allowed values ['positive', 'neutral', 'negative'].
-    * (optional) **mixed-emotion-suggestion** is of type `multi_label_selection` with the following allowed values ['joy', 'anger', 'sadness', 'fear', 'surprise', 'love'].
+    * (optional) **label-suggestion** is of type `label_selection` with the following allowed values ['0', '1', '2', '3', '4', '5'].
 
 
 
@@ -261,7 +191,7 @@ The dataset contains a single split, which is `train`.
 
 #### Annotation guidelines
 
-Emotion is a dataset of English Twitter messages with six basic emotions: anger, fear, joy, love, sadness, and surprise.
+Argilla port of [dair-ai/emotion](https://huggingface.co/datasets/dair-ai/emotion).
 
 #### Annotation process