frascuchon HF staff commited on
Commit
3d9d2ec
1 Parent(s): 90860db

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +23 -151
README.md CHANGED
@@ -4,134 +4,6 @@ tags:
4
  - rlfh
5
  - argilla
6
  - human-feedback
7
- dataset_info:
8
- features:
9
- - name: title
10
- dtype: string
11
- id: field
12
- - name: question
13
- dtype: string
14
- id: field
15
- - name: answer
16
- dtype: string
17
- id: field
18
- - name: title_question_fit
19
- list:
20
- - name: user_id
21
- dtype: string
22
- id: question
23
- - name: value
24
- dtype: string
25
- id: suggestion
26
- - name: status
27
- dtype: string
28
- id: question
29
- - name: title_question_fit-suggestion
30
- dtype: string
31
- id: suggestion
32
- - name: title_question_fit-suggestion-metadata
33
- struct:
34
- - name: type
35
- dtype: string
36
- id: suggestion-metadata
37
- - name: score
38
- dtype: float32
39
- id: suggestion-metadata
40
- - name: agent
41
- dtype: string
42
- id: suggestion-metadata
43
- - name: tags
44
- list:
45
- - name: user_id
46
- dtype: string
47
- id: question
48
- - name: value
49
- sequence: string
50
- id: suggestion
51
- - name: status
52
- dtype: string
53
- id: question
54
- - name: tags-suggestion
55
- sequence: string
56
- id: suggestion
57
- - name: tags-suggestion-metadata
58
- struct:
59
- - name: type
60
- dtype: string
61
- id: suggestion-metadata
62
- - name: score
63
- dtype: float32
64
- id: suggestion-metadata
65
- - name: agent
66
- dtype: string
67
- id: suggestion-metadata
68
- - name: answer_quality
69
- list:
70
- - name: user_id
71
- dtype: string
72
- id: question
73
- - name: value
74
- dtype: int32
75
- id: suggestion
76
- - name: status
77
- dtype: string
78
- id: question
79
- - name: answer_quality-suggestion
80
- dtype: int32
81
- id: suggestion
82
- - name: answer_quality-suggestion-metadata
83
- struct:
84
- - name: type
85
- dtype: string
86
- id: suggestion-metadata
87
- - name: score
88
- dtype: float32
89
- id: suggestion-metadata
90
- - name: agent
91
- dtype: string
92
- id: suggestion-metadata
93
- - name: new_answer
94
- list:
95
- - name: user_id
96
- dtype: string
97
- id: question
98
- - name: value
99
- dtype: string
100
- id: suggestion
101
- - name: status
102
- dtype: string
103
- id: question
104
- - name: new_answer-suggestion
105
- dtype: string
106
- id: suggestion
107
- - name: new_answer-suggestion-metadata
108
- struct:
109
- - name: type
110
- dtype: string
111
- id: suggestion-metadata
112
- - name: score
113
- dtype: float32
114
- id: suggestion-metadata
115
- - name: agent
116
- dtype: string
117
- id: suggestion-metadata
118
- - name: external_id
119
- dtype: string
120
- id: external_id
121
- - name: metadata
122
- dtype: string
123
- id: metadata
124
- splits:
125
- - name: train
126
- num_bytes: 380404
127
- num_examples: 200
128
- download_size: 209395
129
- dataset_size: 380404
130
- configs:
131
- - config_name: default
132
- data_files:
133
- - split: train
134
- path: data/train-*
135
  ---
136
 
137
  # Dataset Card for stackoverflow_feedback_demo
@@ -198,19 +70,19 @@ The **fields** are the dataset records themselves, for the moment just text fiel
198
 
199
  | Field Name | Title | Type | Required | Markdown |
200
  | ---------- | ----- | ---- | -------- | -------- |
201
- | title | Title | FieldTypes.text | True | False |
202
- | question | Question | FieldTypes.text | True | True |
203
- | answer | Answer | FieldTypes.text | True | True |
204
 
205
 
206
  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.
207
 
208
  | Question Name | Title | Type | Required | Description | Values/Labels |
209
  | ------------- | ----- | ---- | -------- | ----------- | ------------- |
210
- | title_question_fit | Does the title match the question? | QuestionTypes.label_selection | True | N/A | ['yes', 'no'] |
211
- | 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'] |
212
- | answer_quality | Rate the quality of the answer: | QuestionTypes.rating | True | N/A | [1, 2, 3, 4, 5] |
213
- | new_answer | If needed, correct the answer | QuestionTypes.text | False | If the rating is below 4, please provide a corrected answer | N/A |
214
 
215
 
216
  **✨ 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:
233
  "responses": [
234
  {
235
  "status": "submitted",
236
- "user_id": null,
237
  "values": {
238
  "answer_quality": {
239
  "value": 1
@@ -264,7 +136,7 @@ While the same record in HuggingFace `datasets` looks as follows:
264
  "answer_quality": [
265
  {
266
  "status": "submitted",
267
- "user_id": null,
268
  "value": 1
269
  }
270
  ],
@@ -279,7 +151,7 @@ While the same record in HuggingFace `datasets` looks as follows:
279
  "new_answer": [
280
  {
281
  "status": "submitted",
282
- "user_id": null,
283
  "value": "Sample answer"
284
  }
285
  ],
@@ -293,7 +165,7 @@ While the same record in HuggingFace `datasets` looks as follows:
293
  "tags": [
294
  {
295
  "status": "submitted",
296
- "user_id": null,
297
  "value": [
298
  "tkinter"
299
  ]
@@ -309,7 +181,7 @@ While the same record in HuggingFace `datasets` looks as follows:
309
  "title_question_fit": [
310
  {
311
  "status": "submitted",
312
- "user_id": null,
313
  "value": "yes"
314
  }
315
  ],
@@ -328,23 +200,23 @@ Among the dataset fields, we differentiate between the following:
328
 
329
  * **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.
330
 
331
- * **title** is of type `FieldTypes.text`.
332
- * **question** is of type `FieldTypes.text`.
333
- * **answer** is of type `FieldTypes.text`.
334
 
335
  * **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`.
336
 
337
- * **title_question_fit** is of type `QuestionTypes.label_selection` with the following allowed values ['yes', 'no'].
338
- * **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.".
339
- * **answer_quality** is of type `QuestionTypes.rating` with the following allowed values [1, 2, 3, 4, 5].
340
- * (optional) **new_answer** is of type `QuestionTypes.text`, and description "If the rating is below 4, please provide a corrected answer".
341
 
342
  * **✨ 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.
343
 
344
- * (optional) **title_question_fit-suggestion** is of type `QuestionTypes.label_selection` with the following allowed values ['yes', 'no'].
345
- * (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'].
346
- * (optional) **answer_quality-suggestion** is of type `QuestionTypes.rating` with the following allowed values [1, 2, 3, 4, 5].
347
- * (optional) **new_answer-suggestion** is of type `QuestionTypes.text`.
348
 
349
  Additionally, we also have one more field which is optional and is the following:
350
 
 
4
  - rlfh
5
  - argilla
6
  - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  ---
8
 
9
  # Dataset Card for stackoverflow_feedback_demo
 
70
 
71
  | Field Name | Title | Type | Required | Markdown |
72
  | ---------- | ----- | ---- | -------- | -------- |
73
+ | title | Title | text | True | False |
74
+ | question | Question | text | True | True |
75
+ | answer | Answer | text | True | True |
76
 
77
 
78
  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.
79
 
80
  | Question Name | Title | Type | Required | Description | Values/Labels |
81
  | ------------- | ----- | ---- | -------- | ----------- | ------------- |
82
+ | title_question_fit | Does the title match the question? | label_selection | True | N/A | ['yes', 'no'] |
83
+ | 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'] |
84
+ | answer_quality | Rate the quality of the answer: | rating | True | N/A | [1, 2, 3, 4, 5] |
85
+ | new_answer | If needed, correct the answer | text | False | N/A | N/A |
86
 
87
 
88
  **✨ 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.
 
105
  "responses": [
106
  {
107
  "status": "submitted",
108
+ "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
109
  "values": {
110
  "answer_quality": {
111
  "value": 1
 
136
  "answer_quality": [
137
  {
138
  "status": "submitted",
139
+ "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
140
  "value": 1
141
  }
142
  ],
 
151
  "new_answer": [
152
  {
153
  "status": "submitted",
154
+ "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
155
  "value": "Sample answer"
156
  }
157
  ],
 
165
  "tags": [
166
  {
167
  "status": "submitted",
168
+ "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
169
  "value": [
170
  "tkinter"
171
  ]
 
181
  "title_question_fit": [
182
  {
183
  "status": "submitted",
184
+ "user_id": "5a053951-24cd-4c9d-9e0c-8a054b95b812",
185
  "value": "yes"
186
  }
187
  ],
 
200
 
201
  * **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.
202
 
203
+ * **title** is of type `text`.
204
+ * **question** is of type `text`.
205
+ * **answer** is of type `text`.
206
 
207
  * **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`.
208
 
209
+ * **title_question_fit** is of type `label_selection` with the following allowed values ['yes', 'no'].
210
+ * **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'].
211
+ * **answer_quality** is of type `rating` with the following allowed values [1, 2, 3, 4, 5].
212
+ * (optional) **new_answer** is of type `text`.
213
 
214
  * **✨ 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.
215
 
216
+ * (optional) **title_question_fit-suggestion** is of type `label_selection` with the following allowed values ['yes', 'no'].
217
+ * (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'].
218
+ * (optional) **answer_quality-suggestion** is of type `rating` with the following allowed values [1, 2, 3, 4, 5].
219
+ * (optional) **new_answer-suggestion** is of type `text`.
220
 
221
  Additionally, we also have one more field which is optional and is the following:
222