rustem-burkhanov-careem commited on
Commit
8ef500f
·
verified ·
1 Parent(s): 4a27014

Upload folder using huggingface_hub

Browse files
Files changed (3) hide show
  1. .argilla/dataset.json +1 -0
  2. .argilla/settings.json +1 -0
  3. README.md +227 -47
.argilla/dataset.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"id": "265d250a-0944-4450-8e0b-ed61a62ef16c", "inserted_at": "2025-09-24T06:21:01.842532", "updated_at": "2025-09-24T06:21:04.549925", "name": "my_dataset_test_2", "status": "ready", "guidelines": "These are some guidelines.", "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}, "workspace_id": "d3906023-6021-4286-a4a2-78bc34e1dca5", "last_activity_at": "2025-09-24T06:22:44.195339"}
.argilla/settings.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"guidelines": "These are some guidelines.", "questions": [{"id": "9b06a303-8b2e-47ad-b0e4-d53b508894da", "inserted_at": "2025-09-24T06:21:03.749376", "updated_at": "2025-09-24T06:21:03.749376", "name": "query", "settings": {"type": "text", "use_markdown": false}, "title": "Please enter a search query", "description": "question description", "required": true, "dataset_id": "265d250a-0944-4450-8e0b-ed61a62ef16c", "type": "text"}, {"id": "15ca743e-b68c-4a5e-940b-0cc5e4d55223", "inserted_at": "2025-09-24T06:21:04.137408", "updated_at": "2025-09-24T06:21:04.137408", "name": "rating", "settings": {"type": "rating", "options": [{"value": 0}, {"value": 1}, {"value": 2}, {"value": 3}, {"value": 4}, {"value": 5}, {"value": 6}, {"value": 7}, {"value": 8}, {"value": 9}, {"value": 10}]}, "title": "How relevant is the query to the brand?", "description": "1 = slightly relevant, 10 = very relevant", "required": true, "dataset_id": "265d250a-0944-4450-8e0b-ed61a62ef16c", "type": "rating"}], "fields": [{"id": "295b1493-791e-4d2d-bf62-ca179c8f50ae", "inserted_at": "2025-09-24T06:21:02.977633", "updated_at": "2025-09-24T06:21:02.977633", "name": "brand_id", "settings": {"type": "text", "use_markdown": false}, "title": "Brand ID", "required": true, "description": null, "dataset_id": "265d250a-0944-4450-8e0b-ed61a62ef16c", "type": "text"}, {"id": "f5b7bb17-3708-403f-ae3c-efb27e53fc83", "inserted_at": "2025-09-24T06:21:03.350469", "updated_at": "2025-09-24T06:21:03.350469", "name": "brand_name", "settings": {"type": "text", "use_markdown": false}, "title": "Brand Name", "required": true, "description": null, "dataset_id": "265d250a-0944-4450-8e0b-ed61a62ef16c", "type": "text"}], "vectors": [], "metadata": [], "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}, "mapping": null}
README.md CHANGED
@@ -1,49 +1,229 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: id
5
- dtype: string
6
- - name: status
7
- dtype: string
8
- - name: _server_id
9
- dtype: string
10
- - name: brand_id
11
- dtype: string
12
- - name: brand_name
13
- dtype: string
14
- - name: query.responses
15
- list: string
16
- - name: query.responses.users
17
- list: string
18
- - name: query.responses.status
19
- list: string
20
- - name: rating.responses
21
- list: int64
22
- - name: rating.responses.users
23
- list: string
24
- - name: rating.responses.status
25
- list: string
26
- - name: query.suggestion
27
- dtype: string
28
- - name: query.suggestion.score
29
- dtype: 'null'
30
- - name: query.suggestion.agent
31
- dtype: 'null'
32
- - name: rating.suggestion
33
- dtype: int64
34
- - name: rating.suggestion.score
35
- dtype: 'null'
36
- - name: rating.suggestion.agent
37
- dtype: 'null'
38
- splits:
39
- - name: train
40
- num_bytes: 2722
41
- num_examples: 10
42
- download_size: 10351
43
- dataset_size: 2722
44
- configs:
45
- - config_name: default
46
- data_files:
47
- - split: train
48
- path: data/train-*
49
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ size_categories: n<1K
3
+ tags:
4
+ - rlfh
5
+ - argilla
6
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  ---
8
+
9
+ # Dataset Card for test
10
+
11
+
12
+
13
+
14
+
15
+
16
+
17
+ This dataset has been created with [Argilla](https://github.com/argilla-io/argilla). As shown in the sections below, this dataset can be loaded into your Argilla server as explained in [Load with Argilla](#load-with-argilla), or used directly with the `datasets` library in [Load with `datasets`](#load-with-datasets).
18
+
19
+
20
+ ## Using this dataset with Argilla
21
+
22
+ To load with Argilla, you'll just need to install Argilla as `pip install argilla --upgrade` and then use the following code:
23
+
24
+ ```python
25
+ import argilla as rg
26
+
27
+ ds = rg.Dataset.from_hub("rustem-burkhanov-careem/test", settings="auto")
28
+ ```
29
+
30
+ This will load the settings and records from the dataset repository and push them to you Argilla server for exploration and annotation.
31
+
32
+ ## Using this dataset with `datasets`
33
+
34
+ To load the records of this dataset with `datasets`, you'll just need to install `datasets` as `pip install datasets --upgrade` and then use the following code:
35
+
36
+ ```python
37
+ from datasets import load_dataset
38
+
39
+ ds = load_dataset("rustem-burkhanov-careem/test")
40
+ ```
41
+
42
+ This will only load the records of the dataset, but not the Argilla settings.
43
+
44
+ ## Dataset Structure
45
+
46
+ This dataset repo contains:
47
+
48
+ * Dataset records in a format compatible with HuggingFace `datasets`. These records will be loaded automatically when using `rg.Dataset.from_hub` and can be loaded independently using the `datasets` library via `load_dataset`.
49
+ * The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
50
+ * A dataset configuration folder conforming to the Argilla dataset format in `.argilla`.
51
+
52
+ The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.
53
+
54
+ ### Fields
55
+
56
+ The **fields** are the features or text of a dataset's records. For example, the 'text' column of a text classification dataset of the 'prompt' column of an instruction following dataset.
57
+
58
+ | Field Name | Title | Type | Required | Markdown |
59
+ | ---------- | ----- | ---- | -------- | -------- |
60
+ | brand_id | Brand ID | text | True | False |
61
+ | brand_name | Brand Name | text | True | False |
62
+
63
+
64
+ ### Questions
65
+
66
+ 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.
67
+
68
+ | Question Name | Title | Type | Required | Description | Values/Labels |
69
+ | ------------- | ----- | ---- | -------- | ----------- | ------------- |
70
+ | query | Please enter a search query | text | True | question description | N/A |
71
+ | rating | How relevant is the query to the brand? | rating | True | 1 = slightly relevant, 10 = very relevant | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] |
72
+
73
+
74
+ <!-- check length of metadata properties -->
75
+
76
+
77
+
78
+
79
+
80
+ ### Data Instances
81
+
82
+ An example of a dataset instance in Argilla looks as follows:
83
+
84
+ ```json
85
+ {
86
+ "_server_id": "994b8e4f-c871-48f0-b412-818ef14bdf54",
87
+ "fields": {
88
+ "brand_id": "123",
89
+ "brand_name": "McDonald\u0027s"
90
+ },
91
+ "id": "0cd61cb8-ebda-4d84-ac88-a0354ce4928b",
92
+ "metadata": {},
93
+ "responses": {
94
+ "query": [
95
+ {
96
+ "user_id": "4d9329fe-4e99-4018-ac42-1122209c9502",
97
+ "value": "sadf"
98
+ }
99
+ ],
100
+ "rating": [
101
+ {
102
+ "user_id": "4d9329fe-4e99-4018-ac42-1122209c9502",
103
+ "value": 2
104
+ }
105
+ ]
106
+ },
107
+ "status": "completed",
108
+ "suggestions": {
109
+ "query": {
110
+ "agent": null,
111
+ "score": null,
112
+ "value": ""
113
+ },
114
+ "rating": {
115
+ "agent": null,
116
+ "score": null,
117
+ "value": 1
118
+ }
119
+ },
120
+ "vectors": {}
121
+ }
122
+ ```
123
+
124
+ While the same record in HuggingFace `datasets` looks as follows:
125
+
126
+ ```json
127
+ {
128
+ "_server_id": "994b8e4f-c871-48f0-b412-818ef14bdf54",
129
+ "brand_id": "123",
130
+ "brand_name": "McDonald\u0027s",
131
+ "id": "0cd61cb8-ebda-4d84-ac88-a0354ce4928b",
132
+ "query.responses": [
133
+ "sadf"
134
+ ],
135
+ "query.responses.status": [
136
+ "submitted"
137
+ ],
138
+ "query.responses.users": [
139
+ "4d9329fe-4e99-4018-ac42-1122209c9502"
140
+ ],
141
+ "query.suggestion": "",
142
+ "query.suggestion.agent": null,
143
+ "query.suggestion.score": null,
144
+ "rating.responses": [
145
+ 2
146
+ ],
147
+ "rating.responses.status": [
148
+ "submitted"
149
+ ],
150
+ "rating.responses.users": [
151
+ "4d9329fe-4e99-4018-ac42-1122209c9502"
152
+ ],
153
+ "rating.suggestion": 1,
154
+ "rating.suggestion.agent": null,
155
+ "rating.suggestion.score": null,
156
+ "status": "completed"
157
+ }
158
+ ```
159
+
160
+
161
+ ### Data Splits
162
+
163
+ The dataset contains a single split, which is `train`.
164
+
165
+ ## Dataset Creation
166
+
167
+ ### Curation Rationale
168
+
169
+ [More Information Needed]
170
+
171
+ ### Source Data
172
+
173
+ #### Initial Data Collection and Normalization
174
+
175
+ [More Information Needed]
176
+
177
+ #### Who are the source language producers?
178
+
179
+ [More Information Needed]
180
+
181
+ ### Annotations
182
+
183
+ #### Annotation guidelines
184
+
185
+ These are some guidelines.
186
+
187
+ #### Annotation process
188
+
189
+ [More Information Needed]
190
+
191
+ #### Who are the annotators?
192
+
193
+ [More Information Needed]
194
+
195
+ ### Personal and Sensitive Information
196
+
197
+ [More Information Needed]
198
+
199
+ ## Considerations for Using the Data
200
+
201
+ ### Social Impact of Dataset
202
+
203
+ [More Information Needed]
204
+
205
+ ### Discussion of Biases
206
+
207
+ [More Information Needed]
208
+
209
+ ### Other Known Limitations
210
+
211
+ [More Information Needed]
212
+
213
+ ## Additional Information
214
+
215
+ ### Dataset Curators
216
+
217
+ [More Information Needed]
218
+
219
+ ### Licensing Information
220
+
221
+ [More Information Needed]
222
+
223
+ ### Citation Information
224
+
225
+ [More Information Needed]
226
+
227
+ ### Contributions
228
+
229
+ [More Information Needed]