Likies commited on
Commit
a934dbf
·
verified ·
1 Parent(s): e8cf916

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 +191 -52
.argilla/dataset.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"id": "3548ba81-5e1b-4dff-be28-17a6cf37c531", "inserted_at": "2025-07-30T07:23:18.310500", "updated_at": "2025-07-30T07:23:18.700358", "name": "ag_news", "status": "ready", "guidelines": null, "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}, "workspace_id": "cd735cee-80a1-471e-a871-36d80c808159", "last_activity_at": "2025-07-30T07:43:40.689964"}
.argilla/settings.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"guidelines": null, "questions": [{"id": "fb7eb807-eeb3-4f9b-8708-eebc1a8cdbe9", "inserted_at": "2025-07-30T07:23:18.559685", "updated_at": "2025-07-30T07:23:18.559685", "name": "label", "settings": {"type": "label_selection", "options": [{"value": "Business", "text": "Business", "description": null}, {"value": "Sci/Tech", "text": "Sci/Tech", "description": null}, {"value": "Sports", "text": "Sports", "description": null}, {"value": "World", "text": "World", "description": null}], "visible_options": 4}, "title": "Classify the text:", "description": null, "required": true, "dataset_id": "3548ba81-5e1b-4dff-be28-17a6cf37c531", "type": "label_selection"}, {"id": "21de89eb-1d74-49d4-83a7-7f7aeb2ca8f3", "inserted_at": "2025-07-30T07:23:18.624962", "updated_at": "2025-07-30T07:23:18.624962", "name": "entities", "settings": {"type": "span", "allow_overlapping": false, "field": "text", "options": [{"value": "PERSON", "text": "PERSON", "description": null}, {"value": "ORG", "text": "ORG", "description": null}, {"value": "LOC", "text": "LOC", "description": null}, {"value": "EVENT", "text": "EVENT", "description": null}], "visible_options": 4}, "title": "Highlight all the entities in the text:", "description": null, "required": true, "dataset_id": "3548ba81-5e1b-4dff-be28-17a6cf37c531", "type": "span"}], "fields": [{"id": "821c3d57-7580-447d-8a99-ebe1b6a5faeb", "inserted_at": "2025-07-30T07:23:18.481633", "updated_at": "2025-07-30T07:23:18.481633", "name": "text", "settings": {"type": "text", "use_markdown": false}, "title": "text", "required": true, "description": null, "dataset_id": "3548ba81-5e1b-4dff-be28-17a6cf37c531", "type": "text"}], "vectors": [], "metadata": [], "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}, "mapping": null}
README.md CHANGED
@@ -1,54 +1,193 @@
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: text
11
- dtype: string
12
- - name: label.suggestion
13
- dtype:
14
- class_label:
15
- names:
16
- '0': Business
17
- '1': Sci/Tech
18
- '2': Sports
19
- '3': World
20
- - name: label.suggestion.score
21
- dtype: 'null'
22
- - name: label.suggestion.agent
23
- dtype: 'null'
24
- - name: label.responses
25
- list: string
26
- - name: entities.responses
27
- list:
28
- list:
29
- - name: end
30
- dtype: int64
31
- - name: label
32
- dtype: string
33
- - name: start
34
- dtype: int64
35
- - name: label.responses.users
36
- list: string
37
- - name: entities.responses.users
38
- list: string
39
- - name: entities.responses.status
40
- list: string
41
- - name: label.responses.status
42
- list: string
43
- splits:
44
- - name: train
45
- num_bytes: 40716625
46
- num_examples: 120000
47
- download_size: 24023694
48
- dataset_size: 40716625
49
- configs:
50
- - config_name: default
51
- data_files:
52
- - split: train
53
- path: data/train-*
54
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ size_categories: 100K<n<1M
3
+ tags:
4
+ - rlfh
5
+ - argilla
6
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  ---
8
+
9
+ # Dataset Card for my_dataset
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("Likies/my_dataset", 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("Likies/my_dataset")
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
+ | text | text | text | True | False |
61
+
62
+
63
+ ### Questions
64
+
65
+ 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.
66
+
67
+ | Question Name | Title | Type | Required | Description | Values/Labels |
68
+ | ------------- | ----- | ---- | -------- | ----------- | ------------- |
69
+ | label | Classify the text: | label_selection | True | N/A | ['Business', 'Sci/Tech', 'Sports', 'World'] |
70
+ | entities | Highlight all the entities in the text: | span | True | N/A | N/A |
71
+
72
+
73
+ <!-- check length of metadata properties -->
74
+
75
+
76
+
77
+
78
+
79
+ ### Data Instances
80
+
81
+ An example of a dataset instance in Argilla looks as follows:
82
+
83
+ ```json
84
+ {
85
+ "_server_id": "0844d8e4-b9c0-4339-a011-08c137bf1a71",
86
+ "fields": {
87
+ "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."
88
+ },
89
+ "id": "train_0",
90
+ "metadata": {},
91
+ "responses": {},
92
+ "status": "pending",
93
+ "suggestions": {
94
+ "label": {
95
+ "agent": null,
96
+ "score": null,
97
+ "value": "Business"
98
+ }
99
+ },
100
+ "vectors": {}
101
+ }
102
+ ```
103
+
104
+ While the same record in HuggingFace `datasets` looks as follows:
105
+
106
+ ```json
107
+ {
108
+ "_server_id": "0844d8e4-b9c0-4339-a011-08c137bf1a71",
109
+ "entities.responses": null,
110
+ "entities.responses.status": null,
111
+ "entities.responses.users": null,
112
+ "id": "train_0",
113
+ "label.responses": null,
114
+ "label.responses.status": null,
115
+ "label.responses.users": null,
116
+ "label.suggestion": 0,
117
+ "label.suggestion.agent": null,
118
+ "label.suggestion.score": null,
119
+ "status": "pending",
120
+ "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."
121
+ }
122
+ ```
123
+
124
+
125
+ ### Data Splits
126
+
127
+ The dataset contains a single split, which is `train`.
128
+
129
+ ## Dataset Creation
130
+
131
+ ### Curation Rationale
132
+
133
+ [More Information Needed]
134
+
135
+ ### Source Data
136
+
137
+ #### Initial Data Collection and Normalization
138
+
139
+ [More Information Needed]
140
+
141
+ #### Who are the source language producers?
142
+
143
+ [More Information Needed]
144
+
145
+ ### Annotations
146
+
147
+ #### Annotation guidelines
148
+
149
+ [More Information Needed]
150
+
151
+ #### Annotation process
152
+
153
+ [More Information Needed]
154
+
155
+ #### Who are the annotators?
156
+
157
+ [More Information Needed]
158
+
159
+ ### Personal and Sensitive Information
160
+
161
+ [More Information Needed]
162
+
163
+ ## Considerations for Using the Data
164
+
165
+ ### Social Impact of Dataset
166
+
167
+ [More Information Needed]
168
+
169
+ ### Discussion of Biases
170
+
171
+ [More Information Needed]
172
+
173
+ ### Other Known Limitations
174
+
175
+ [More Information Needed]
176
+
177
+ ## Additional Information
178
+
179
+ ### Dataset Curators
180
+
181
+ [More Information Needed]
182
+
183
+ ### Licensing Information
184
+
185
+ [More Information Needed]
186
+
187
+ ### Citation Information
188
+
189
+ [More Information Needed]
190
+
191
+ ### Contributions
192
+
193
+ [More Information Needed]