dvilasuero HF staff commited on
Commit
204bbd2
1 Parent(s): 94b3d32

Upload folder using huggingface_hub

Browse files
Files changed (4) hide show
  1. .argilla/dataset.json +16 -0
  2. .argilla/settings.json +70 -0
  3. .argilla/version.json +3 -0
  4. README.md +143 -44
.argilla/dataset.json ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "id": "f3ce3309-7f92-446b-8234-75d37c2e4816",
3
+ "name": "emojis",
4
+ "guidelines": null,
5
+ "allow_extra_metadata": false,
6
+ "status": "ready",
7
+ "distribution": {
8
+ "strategy": "overlap",
9
+ "min_submitted": 1
10
+ },
11
+ "metadata": null,
12
+ "workspace_id": "3930233b-f754-480b-b2e8-d290d8bcb518",
13
+ "last_activity_at": "2024-12-16T15:05:35.226853",
14
+ "inserted_at": "2024-12-16T08:19:08.318262",
15
+ "updated_at": "2024-12-16T08:19:08.769259"
16
+ }
.argilla/settings.json ADDED
@@ -0,0 +1,70 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "guidelines": null,
3
+ "allow_extra_metadata": false,
4
+ "distribution": {
5
+ "strategy": "overlap",
6
+ "min_submitted": 1
7
+ },
8
+ "fields": [
9
+ {
10
+ "id": "e5b483ae-dc35-4a59-8ff3-396d8cf67a1a",
11
+ "name": "text",
12
+ "title": "text",
13
+ "required": true,
14
+ "settings": {
15
+ "type": "text",
16
+ "use_markdown": false
17
+ },
18
+ "dataset_id": "f3ce3309-7f92-446b-8234-75d37c2e4816",
19
+ "inserted_at": "2024-12-16T08:19:08.529321",
20
+ "updated_at": "2024-12-16T08:19:08.529321"
21
+ }
22
+ ],
23
+ "questions": [
24
+ {
25
+ "id": "97fd601f-18a1-4de3-ab23-1ba69e43c332",
26
+ "name": "text_question",
27
+ "title": "text_question",
28
+ "description": null,
29
+ "required": true,
30
+ "settings": {
31
+ "type": "text",
32
+ "use_markdown": false
33
+ },
34
+ "dataset_id": "f3ce3309-7f92-446b-8234-75d37c2e4816",
35
+ "inserted_at": "2024-12-16T08:19:08.582181",
36
+ "updated_at": "2024-12-16T08:19:08.582181"
37
+ },
38
+ {
39
+ "id": "9a316cb1-ef30-4b13-8c70-dbfa52545a82",
40
+ "name": "span_question",
41
+ "title": "span_question",
42
+ "description": null,
43
+ "required": true,
44
+ "settings": {
45
+ "type": "span",
46
+ "field": "text",
47
+ "options": [
48
+ {
49
+ "value": "PERSON",
50
+ "text": "PERSON",
51
+ "description": null
52
+ },
53
+ {
54
+ "value": "ORG",
55
+ "text": "ORG",
56
+ "description": null
57
+ }
58
+ ],
59
+ "visible_options": null,
60
+ "allow_overlapping": false,
61
+ "allow_character_annotation": true
62
+ },
63
+ "dataset_id": "f3ce3309-7f92-446b-8234-75d37c2e4816",
64
+ "inserted_at": "2024-12-16T08:19:08.681902",
65
+ "updated_at": "2024-12-16T08:19:08.681902"
66
+ }
67
+ ],
68
+ "metadata": [],
69
+ "vectors": []
70
+ }
.argilla/version.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ {
2
+ "argilla": "2.6.0dev0"
3
+ }
README.md CHANGED
@@ -1,46 +1,145 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: id
5
- dtype: string
6
- - name: status
7
- dtype: string
8
- - name: inserted_at
9
- dtype: timestamp[us]
10
- - name: updated_at
11
- dtype: timestamp[us]
12
- - name: _server_id
13
- dtype: string
14
- - name: text
15
- dtype: string
16
- - name: text_question.responses
17
- sequence: string
18
- - name: text_question.responses.users
19
- sequence: string
20
- - name: text_question.responses.status
21
- sequence: string
22
- - name: span_question.responses
23
- list:
24
- list:
25
- - name: end
26
- dtype: int64
27
- - name: label
28
- dtype: string
29
- - name: start
30
- dtype: int64
31
- - name: span_question.responses.users
32
- sequence: string
33
- - name: span_question.responses.status
34
- sequence: string
35
- splits:
36
- - name: train
37
- num_bytes: 655
38
- num_examples: 3
39
- download_size: 8529
40
- dataset_size: 655
41
- configs:
42
- - config_name: default
43
- data_files:
44
- - split: train
45
- path: data/train-*
46
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ tags:
3
+ - rlfh
4
+ - argilla
5
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ---
7
+
8
+ # Dataset Card for emojis
9
+
10
+
11
+
12
+
13
+
14
+
15
+
16
+ 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).
17
+
18
+
19
+ ## Using this dataset with Argilla
20
+
21
+ To load with Argilla, you'll just need to install Argilla as `pip install argilla --upgrade` and then use the following code:
22
+
23
+ ```python
24
+ import argilla as rg
25
+
26
+ ds = rg.Dataset.from_hub("dvilasuero/emojis", settings="auto")
27
+ ```
28
+
29
+ This will load the settings and records from the dataset repository and push them to you Argilla server for exploration and annotation.
30
+
31
+ ## Using this dataset with `datasets`
32
+
33
+ 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:
34
+
35
+ ```python
36
+ from datasets import load_dataset
37
+
38
+ ds = load_dataset("dvilasuero/emojis")
39
+ ```
40
+
41
+ This will only load the records of the dataset, but not the Argilla settings.
42
+
43
+ ## Dataset Structure
44
+
45
+ This dataset repo contains:
46
+
47
+ * 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`.
48
+ * The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
49
+ * A dataset configuration folder conforming to the Argilla dataset format in `.argilla`.
50
+
51
+ The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.
52
+
53
+ ### Fields
54
+
55
+ 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.
56
+
57
+ | Field Name | Title | Type | Required |
58
+ | ---------- | ----- | ---- | -------- |
59
+ | text | text | text | True |
60
+
61
+
62
+ ### Questions
63
+
64
+ 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.
65
+
66
+ | Question Name | Title | Type | Required | Description | Values/Labels |
67
+ | ------------- | ----- | ---- | -------- | ----------- | ------------- |
68
+ | text_question | text_question | text | True | N/A | N/A |
69
+ | span_question | span_question | span | True | N/A | ['PERSON', 'ORG'] |
70
+
71
+
72
+ <!-- check length of metadata properties -->
73
+
74
+
75
+
76
+
77
+ ### Data Splits
78
+
79
+ The dataset contains a single split, which is `train`.
80
+
81
+ ## Dataset Creation
82
+
83
+ ### Curation Rationale
84
+
85
+ [More Information Needed]
86
+
87
+ ### Source Data
88
+
89
+ #### Initial Data Collection and Normalization
90
+
91
+ [More Information Needed]
92
+
93
+ #### Who are the source language producers?
94
+
95
+ [More Information Needed]
96
+
97
+ ### Annotations
98
+
99
+ #### Annotation guidelines
100
+
101
+ [More Information Needed]
102
+
103
+ #### Annotation process
104
+
105
+ [More Information Needed]
106
+
107
+ #### Who are the annotators?
108
+
109
+ [More Information Needed]
110
+
111
+ ### Personal and Sensitive Information
112
+
113
+ [More Information Needed]
114
+
115
+ ## Considerations for Using the Data
116
+
117
+ ### Social Impact of Dataset
118
+
119
+ [More Information Needed]
120
+
121
+ ### Discussion of Biases
122
+
123
+ [More Information Needed]
124
+
125
+ ### Other Known Limitations
126
+
127
+ [More Information Needed]
128
+
129
+ ## Additional Information
130
+
131
+ ### Dataset Curators
132
+
133
+ [More Information Needed]
134
+
135
+ ### Licensing Information
136
+
137
+ [More Information Needed]
138
+
139
+ ### Citation Information
140
+
141
+ [More Information Needed]
142
+
143
+ ### Contributions
144
+
145
+ [More Information Needed]