jfcalvo commited on
Commit
53a7942
1 Parent(s): 33e228c

Upload folder using huggingface_hub

Browse files
Files changed (4) hide show
  1. .argilla/dataset.json +16 -0
  2. .argilla/settings.json +87 -0
  3. .argilla/version.json +3 -0
  4. README.md +152 -37
.argilla/dataset.json ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "id": "6005571a-b628-48e6-99af-c63df171e4c1",
3
+ "name": "dataset-0",
4
+ "guidelines": null,
5
+ "allow_extra_metadata": true,
6
+ "status": "ready",
7
+ "distribution": {
8
+ "strategy": "overlap",
9
+ "min_submitted": 1
10
+ },
11
+ "metadata": null,
12
+ "workspace_id": "d9931ed9-8b40-4511-b261-cca126037b28",
13
+ "last_activity_at": "2024-12-13T15:58:15.751626",
14
+ "inserted_at": "2024-12-13T15:58:15.751626",
15
+ "updated_at": "2024-12-13T15:58:15.751626"
16
+ }
.argilla/settings.json ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "guidelines": null,
3
+ "allow_extra_metadata": true,
4
+ "distribution": {
5
+ "strategy": "overlap",
6
+ "min_submitted": 1
7
+ },
8
+ "fields": [
9
+ {
10
+ "id": "f0713367-453e-4f87-b8dc-40bf563e4689",
11
+ "name": "text",
12
+ "title": "Field Title",
13
+ "required": false,
14
+ "settings": {
15
+ "type": "text",
16
+ "use_markdown": false
17
+ },
18
+ "dataset_id": "6005571a-b628-48e6-99af-c63df171e4c1",
19
+ "inserted_at": "2024-12-13T15:58:15.752253",
20
+ "updated_at": "2024-12-13T15:58:15.752253"
21
+ }
22
+ ],
23
+ "questions": [
24
+ {
25
+ "id": "de370cca-0870-4b39-a528-5c8396879a76",
26
+ "name": "text-question",
27
+ "title": "Question Title",
28
+ "description": "Question Description",
29
+ "required": true,
30
+ "settings": {
31
+ "type": "text",
32
+ "use_markdown": false
33
+ },
34
+ "dataset_id": "6005571a-b628-48e6-99af-c63df171e4c1",
35
+ "inserted_at": "2024-12-13T15:58:15.752804",
36
+ "updated_at": "2024-12-13T15:58:15.752804"
37
+ }
38
+ ],
39
+ "metadata": [
40
+ {
41
+ "id": "f3baddc4-7e31-4fc5-b6fe-b95a8f1ef5c1",
42
+ "name": "metadata-terms",
43
+ "title": "Metadata Terms",
44
+ "settings": {
45
+ "type": "terms",
46
+ "values": [
47
+ "term-a",
48
+ "term-b",
49
+ "term-c"
50
+ ]
51
+ },
52
+ "visible_for_annotators": true,
53
+ "dataset_id": "6005571a-b628-48e6-99af-c63df171e4c1",
54
+ "inserted_at": "2024-12-13T15:58:15.755264",
55
+ "updated_at": "2024-12-13T15:58:15.755264"
56
+ },
57
+ {
58
+ "id": "054e8377-81ef-475d-9da0-b162b982e5c3",
59
+ "name": "metadata-integer",
60
+ "title": "Metadata Integer",
61
+ "settings": {
62
+ "type": "integer",
63
+ "min": null,
64
+ "max": null
65
+ },
66
+ "visible_for_annotators": true,
67
+ "dataset_id": "6005571a-b628-48e6-99af-c63df171e4c1",
68
+ "inserted_at": "2024-12-13T15:58:15.755665",
69
+ "updated_at": "2024-12-13T15:58:15.755665"
70
+ },
71
+ {
72
+ "id": "a6ce8050-6662-49ac-92cd-10189f32a509",
73
+ "name": "metadata-float",
74
+ "title": "Metadata Float",
75
+ "settings": {
76
+ "type": "float",
77
+ "min": null,
78
+ "max": null
79
+ },
80
+ "visible_for_annotators": true,
81
+ "dataset_id": "6005571a-b628-48e6-99af-c63df171e4c1",
82
+ "inserted_at": "2024-12-13T15:58:15.755938",
83
+ "updated_at": "2024-12-13T15:58:15.755938"
84
+ }
85
+ ],
86
+ "vectors": []
87
+ }
.argilla/version.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ {
2
+ "argilla": "2.6.0dev0"
3
+ }
README.md CHANGED
@@ -1,39 +1,154 @@
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
- dtype: 'null'
18
- - name: text-question.responses.users
19
- dtype: 'null'
20
- - name: text-question.responses.status
21
- dtype: 'null'
22
- - name: metadata.metadata-terms
23
- sequence: string
24
- - name: metadata.metadata-integer
25
- dtype: int64
26
- - name: metadata.metadata-float
27
- dtype: float64
28
- splits:
29
- - name: train
30
- num_bytes: 139
31
- num_examples: 1
32
- download_size: 5676
33
- dataset_size: 139
34
- configs:
35
- - config_name: default
36
- data_files:
37
- - split: train
38
- path: data/train-*
39
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ tags:
3
+ - rlfh
4
+ - argilla
5
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ---
7
+
8
+ # Dataset Card for argilla-server-dataset-test-605b8aee-6575-46fa-b2c7-4dbff5bdd0f8
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("argilla-internal-testing/argilla-server-dataset-test-605b8aee-6575-46fa-b2c7-4dbff5bdd0f8", 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("argilla-internal-testing/argilla-server-dataset-test-605b8aee-6575-46fa-b2c7-4dbff5bdd0f8")
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 | Field Title | text | False |
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 | Question Title | text | True | Question Description | N/A |
69
+
70
+
71
+ <!-- check length of metadata properties -->
72
+
73
+ ### Metadata
74
+
75
+ The **metadata** is a dictionary that can be used to provide additional information about the dataset record.
76
+ | Metadata Name | Title | Type | Values | Visible for Annotators |
77
+ | ------------- | ----- | ---- | ------ | ---------------------- |
78
+ | metadata-terms | Metadata Terms | terms | ['term-a', 'term-b', 'term-c'] | True |
79
+ | metadata-integer | Metadata Integer | integer | - | True |
80
+ | metadata-float | Metadata Float | float | - | True |
81
+
82
+
83
+
84
+
85
+
86
+ ### Data Splits
87
+
88
+ The dataset contains a single split, which is `train`.
89
+
90
+ ## Dataset Creation
91
+
92
+ ### Curation Rationale
93
+
94
+ [More Information Needed]
95
+
96
+ ### Source Data
97
+
98
+ #### Initial Data Collection and Normalization
99
+
100
+ [More Information Needed]
101
+
102
+ #### Who are the source language producers?
103
+
104
+ [More Information Needed]
105
+
106
+ ### Annotations
107
+
108
+ #### Annotation guidelines
109
+
110
+ [More Information Needed]
111
+
112
+ #### Annotation process
113
+
114
+ [More Information Needed]
115
+
116
+ #### Who are the annotators?
117
+
118
+ [More Information Needed]
119
+
120
+ ### Personal and Sensitive Information
121
+
122
+ [More Information Needed]
123
+
124
+ ## Considerations for Using the Data
125
+
126
+ ### Social Impact of Dataset
127
+
128
+ [More Information Needed]
129
+
130
+ ### Discussion of Biases
131
+
132
+ [More Information Needed]
133
+
134
+ ### Other Known Limitations
135
+
136
+ [More Information Needed]
137
+
138
+ ## Additional Information
139
+
140
+ ### Dataset Curators
141
+
142
+ [More Information Needed]
143
+
144
+ ### Licensing Information
145
+
146
+ [More Information Needed]
147
+
148
+ ### Citation Information
149
+
150
+ [More Information Needed]
151
+
152
+ ### Contributions
153
+
154
+ [More Information Needed]