Upload README.md with huggingface_hub

README.md

@@ -4,53 +4,6 @@ tags:
 - rlfh
 - argilla
 - human-feedback
-dataset_info:
-  features:
-  - name: text
-    dtype: string
-    id: field
-  - name: label
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      dtype: string
-      id: suggestion
-    - 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: 343408
-    num_examples: 1000
-  download_size: 181964
-  dataset_size: 343408
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
 ---
 
 # Dataset Card for end2end_textclassification
@@ -117,14 +70,14 @@ The **fields** are the dataset records themselves, for the moment just text fiel
 
 | Field Name | Title | Type | Required | Markdown |
 | ---------- | ----- | ---- | -------- | -------- |
-| text | Text | text | True | False |
+| text | Text | FieldTypes.text | True | False |
 
 
 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 |
 | ------------- | ----- | ---- | -------- | ----------- | ------------- |
-| label | Label | label_selection | True | N/A | ['World', 'Sports', 'Business', 'Sci/Tech'] |
+| label | Label | QuestionTypes.label_selection | True | N/A | ['World', 'Sports', 'Business', 'Sci/Tech'] |
 
 
 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".
@@ -135,6 +88,9 @@ The **metadata** is a dictionary that can be used to provide additional informat
 
 | Metadata Name | Title | Type | Values | Visible for Annotators |
 | ------------- | ----- | ---- | ------ | ---------------------- |
+ | group | Annotation Group | terms | ['group-1', 'group-2', 'group-3'] | True |
+ | length | Length of the text | integer | 100 - 862 | True |
+ | length_std | Standard deviation of the length of the text | float | 139.096 - 361.398 | True |
 
 
 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.
@@ -149,7 +105,11 @@ An example of a dataset instance in Argilla looks as follows:
     "fields": {
         "text": "Wall St. Bears Claw Back Into the Black (Reuters) Reuters - Short-sellers, Wall Street\u0027s dwindling\\band of ultra-cynics, are seeing green again."
     },
-    "metadata": {},
+    "metadata": {
+        "group": "group-2",
+        "length": 144,
+        "length_std": 144.0
+    },
     "responses": [],
     "suggestions": [],
     "vectors": {}
@@ -168,7 +128,7 @@ While the same record in HuggingFace `datasets` looks as follows:
         "score": null,
         "type": null
     },
-    "metadata": "{}",
+    "metadata": "{\"group\": \"group-2\", \"length\": 144, \"length_std\": 144.0}",
     "text": "Wall St. Bears Claw Back Into the Black (Reuters) Reuters - Short-sellers, Wall Street\u0027s dwindling\\band of ultra-cynics, are seeing green again."
 }
 ```
@@ -179,15 +139,15 @@ Among the dataset fields, we differentiate between the following:
 
 * **Fields:** These are the dataset records themselves, for the moment just text fields are supported. These are the ones that will be used to provide responses to the questions.
     
-    * **text** is of type `text`.
+    * **text** is of type `FieldTypes.text`.
 
 * **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`.
     
-    * **label** is of type `label_selection` with the following allowed values ['World', 'Sports', 'Business', 'Sci/Tech'].
+    * **label** is of type `QuestionTypes.label_selection` with the following allowed values ['World', 'Sports', 'Business', 'Sci/Tech'].
 
 * **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) **label-suggestion** is of type `label_selection` with the following allowed values ['World', 'Sports', 'Business', 'Sci/Tech'].
+    * (optional) **label-suggestion** is of type `QuestionTypes.label_selection` with the following allowed values ['World', 'Sports', 'Business', 'Sci/Tech'].