Upload README.md with huggingface_hub

README.md

@@ -4,134 +4,6 @@ tags:
 - rlfh
 - argilla
 - human-feedback
-dataset_info:
-  features:
-  - name: title
-    dtype: string
-    id: field
-  - name: question
-    dtype: string
-    id: field
-  - name: answer
-    dtype: string
-    id: field
-  - name: title_question_fit
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      dtype: string
-      id: suggestion
-    - name: status
-      dtype: string
-      id: question
-  - name: title_question_fit-suggestion
-    dtype: string
-    id: suggestion
-  - name: title_question_fit-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: tags
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      sequence: string
-      id: suggestion
-    - name: status
-      dtype: string
-      id: question
-  - name: tags-suggestion
-    sequence: string
-    id: suggestion
-  - name: tags-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: answer_quality
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      dtype: int32
-      id: suggestion
-    - name: status
-      dtype: string
-      id: question
-  - name: answer_quality-suggestion
-    dtype: int32
-    id: suggestion
-  - name: answer_quality-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: new_answer
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      dtype: string
-      id: suggestion
-    - name: status
-      dtype: string
-      id: question
-  - name: new_answer-suggestion
-    dtype: string
-    id: suggestion
-  - name: new_answer-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: 380404
-    num_examples: 200
-  download_size: 209395
-  dataset_size: 380404
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
 ---
 
 # Dataset Card for stackoverflow_feedback_demo
@@ -198,19 +70,19 @@ The **fields** are the dataset records themselves, for the moment just text fiel
 
 | Field Name | Title | Type | Required | Markdown |
 | ---------- | ----- | ---- | -------- | -------- |
-| title | Title | FieldTypes.text | True | False |
-| question | Question | FieldTypes.text | True | True |
-| answer | Answer | FieldTypes.text | True | True |
+| title | Title | text | True | False |
+| question | Question | text | True | True |
+| answer | Answer | text | True | True |
 
 
 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 |
 | ------------- | ----- | ---- | -------- | ----------- | ------------- |
-| title_question_fit | Does the title match the question? | QuestionTypes.label_selection | True | N/A | ['yes', 'no'] |
-| tags | What are the topics mentioned in this question? | QuestionTypes.multi_label_selection | True | Select all that apply. | ['python', 'django', 'python-2.7', 'list', 'python-3.x', 'numpy', 'pandas', 'regex', 'dictionary', 'string', 'matplotlib', 'arrays', 'google-app-engine', 'csv', 'tkinter', 'flask', 'json', 'linux', 'mysql', 'html', 'function', 'file', 'class', 'algorithm', 'windows', 'scipy', 'loops', 'multithreading', 'beautifulsoup', 'django-models', 'for-loop', 'javascript', 'xml', 'sqlalchemy', 'parsing', 'performance', 'datetime', 'osx', 'sorting', 'unicode', 'c++', 'dataframe', 'selenium', 'subprocess', 'pygame', 'java', 'pyqt', 'pip', 'tuples', 'scrapy'] |
-| answer_quality | Rate the quality of the answer: | QuestionTypes.rating | True | N/A | [1, 2, 3, 4, 5] |
-| new_answer | If needed, correct the answer | QuestionTypes.text | False | If the rating is below 4, please provide a corrected answer | N/A |
+| title_question_fit | Does the title match the question? | label_selection | True | N/A | ['yes', 'no'] |
+| tags | What are the topics mentioned in this question? | multi_label_selection | True | N/A | ['python', 'django', 'python-2.7', 'list', 'python-3.x', 'numpy', 'pandas', 'regex', 'dictionary', 'string', 'matplotlib', 'arrays', 'google-app-engine', 'csv', 'tkinter', 'flask', 'json', 'linux', 'mysql', 'html', 'function', 'file', 'class', 'algorithm', 'windows', 'scipy', 'loops', 'multithreading', 'beautifulsoup', 'django-models', 'for-loop', 'javascript', 'xml', 'sqlalchemy', 'parsing', 'performance', 'datetime', 'osx', 'sorting', 'unicode', 'c++', 'dataframe', 'selenium', 'subprocess', 'pygame', 'java', 'pyqt', 'pip', 'tuples', 'scrapy'] |
+| answer_quality | Rate the quality of the answer: | rating | True | N/A | [1, 2, 3, 4, 5] |
+| new_answer | If needed, correct the answer | text | False | N/A | N/A |
 
 
 **✨ NEW** Additionally, we also have **suggestions**, which are linked to the existing questions, and so on, 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.
@@ -233,7 +105,7 @@ An example of a dataset instance in Argilla looks as follows:
     "responses": [
         {
             "status": "submitted",
-            "user_id": null,
+            "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
             "values": {
                 "answer_quality": {
                     "value": 1
@@ -264,7 +136,7 @@ While the same record in HuggingFace `datasets` looks as follows:
     "answer_quality": [
         {
             "status": "submitted",
-            "user_id": null,
+            "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
             "value": 1
         }
     ],
@@ -279,7 +151,7 @@ While the same record in HuggingFace `datasets` looks as follows:
     "new_answer": [
         {
             "status": "submitted",
-            "user_id": null,
+            "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
             "value": "Sample answer"
         }
     ],
@@ -293,7 +165,7 @@ While the same record in HuggingFace `datasets` looks as follows:
     "tags": [
         {
             "status": "submitted",
-            "user_id": null,
+            "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
             "value": [
                 "tkinter"
             ]
@@ -309,7 +181,7 @@ While the same record in HuggingFace `datasets` looks as follows:
     "title_question_fit": [
         {
             "status": "submitted",
-            "user_id": null,
+            "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
             "value": "yes"
         }
     ],
@@ -328,23 +200,23 @@ Among the dataset fields, we differentiate between the following:
 
 * **Fields:** These are the dataset records themselves, for the moment just text fields are suppported. These are the ones that will be used to provide responses to the questions.
     
-    * **title** is of type `FieldTypes.text`.
-    * **question** is of type `FieldTypes.text`.
-    * **answer** is of type `FieldTypes.text`.
+    * **title** is of type `text`.
+    * **question** is of type `text`.
+    * **answer** is of type `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`.
     
-    * **title_question_fit** is of type `QuestionTypes.label_selection` with the following allowed values ['yes', 'no'].
-    * **tags** is of type `QuestionTypes.multi_label_selection` with the following allowed values ['python', 'django', 'python-2.7', 'list', 'python-3.x', 'numpy', 'pandas', 'regex', 'dictionary', 'string', 'matplotlib', 'arrays', 'google-app-engine', 'csv', 'tkinter', 'flask', 'json', 'linux', 'mysql', 'html', 'function', 'file', 'class', 'algorithm', 'windows', 'scipy', 'loops', 'multithreading', 'beautifulsoup', 'django-models', 'for-loop', 'javascript', 'xml', 'sqlalchemy', 'parsing', 'performance', 'datetime', 'osx', 'sorting', 'unicode', 'c++', 'dataframe', 'selenium', 'subprocess', 'pygame', 'java', 'pyqt', 'pip', 'tuples', 'scrapy'], and description "Select all that apply.".
-    * **answer_quality** is of type `QuestionTypes.rating` with the following allowed values [1, 2, 3, 4, 5].
-    * (optional) **new_answer** is of type `QuestionTypes.text`, and description "If the rating is below 4, please provide a corrected answer".
+    * **title_question_fit** is of type `label_selection` with the following allowed values ['yes', 'no'].
+    * **tags** is of type `multi_label_selection` with the following allowed values ['python', 'django', 'python-2.7', 'list', 'python-3.x', 'numpy', 'pandas', 'regex', 'dictionary', 'string', 'matplotlib', 'arrays', 'google-app-engine', 'csv', 'tkinter', 'flask', 'json', 'linux', 'mysql', 'html', 'function', 'file', 'class', 'algorithm', 'windows', 'scipy', 'loops', 'multithreading', 'beautifulsoup', 'django-models', 'for-loop', 'javascript', 'xml', 'sqlalchemy', 'parsing', 'performance', 'datetime', 'osx', 'sorting', 'unicode', 'c++', 'dataframe', 'selenium', 'subprocess', 'pygame', 'java', 'pyqt', 'pip', 'tuples', 'scrapy'].
+    * **answer_quality** is of type `rating` with the following allowed values [1, 2, 3, 4, 5].
+    * (optional) **new_answer** is of type `text`.
 
 * **✨ NEW** **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) **title_question_fit-suggestion** is of type `QuestionTypes.label_selection` with the following allowed values ['yes', 'no'].
-    * (optional) **tags-suggestion** is of type `QuestionTypes.multi_label_selection` with the following allowed values ['python', 'django', 'python-2.7', 'list', 'python-3.x', 'numpy', 'pandas', 'regex', 'dictionary', 'string', 'matplotlib', 'arrays', 'google-app-engine', 'csv', 'tkinter', 'flask', 'json', 'linux', 'mysql', 'html', 'function', 'file', 'class', 'algorithm', 'windows', 'scipy', 'loops', 'multithreading', 'beautifulsoup', 'django-models', 'for-loop', 'javascript', 'xml', 'sqlalchemy', 'parsing', 'performance', 'datetime', 'osx', 'sorting', 'unicode', 'c++', 'dataframe', 'selenium', 'subprocess', 'pygame', 'java', 'pyqt', 'pip', 'tuples', 'scrapy'].
-    * (optional) **answer_quality-suggestion** is of type `QuestionTypes.rating` with the following allowed values [1, 2, 3, 4, 5].
-    * (optional) **new_answer-suggestion** is of type `QuestionTypes.text`.
+    * (optional) **title_question_fit-suggestion** is of type `label_selection` with the following allowed values ['yes', 'no'].
+    * (optional) **tags-suggestion** is of type `multi_label_selection` with the following allowed values ['python', 'django', 'python-2.7', 'list', 'python-3.x', 'numpy', 'pandas', 'regex', 'dictionary', 'string', 'matplotlib', 'arrays', 'google-app-engine', 'csv', 'tkinter', 'flask', 'json', 'linux', 'mysql', 'html', 'function', 'file', 'class', 'algorithm', 'windows', 'scipy', 'loops', 'multithreading', 'beautifulsoup', 'django-models', 'for-loop', 'javascript', 'xml', 'sqlalchemy', 'parsing', 'performance', 'datetime', 'osx', 'sorting', 'unicode', 'c++', 'dataframe', 'selenium', 'subprocess', 'pygame', 'java', 'pyqt', 'pip', 'tuples', 'scrapy'].
+    * (optional) **answer_quality-suggestion** is of type `rating` with the following allowed values [1, 2, 3, 4, 5].
+    * (optional) **new_answer-suggestion** is of type `text`.
 
 Additionally, we also have one more field which is optional and is the following: