frascuchon HF staff commited on
Commit
15643fb
1 Parent(s): 1295734

Upload folder using huggingface_hub

Browse files
Files changed (4) hide show
  1. .argilla/dataset.json +36 -0
  2. .argilla/settings.json +53 -0
  3. .argilla/version.json +3 -0
  4. README.md +142 -37
.argilla/dataset.json ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "id": "6df01fac-4fb7-4a6d-8d2a-d62c5e782342",
3
+ "name": "hydrate-test",
4
+ "guidelines": null,
5
+ "allow_extra_metadata": true,
6
+ "status": "ready",
7
+ "distribution": {
8
+ "strategy": "overlap",
9
+ "min_submitted": 1
10
+ },
11
+ "metadata": {
12
+ "repoId": "stanfordnlp/imdb",
13
+ "subset": "plain_text",
14
+ "split": "train",
15
+ "mapping": {
16
+ "fields": [
17
+ {
18
+ "source": "text",
19
+ "target": "text"
20
+ }
21
+ ],
22
+ "metadata": [],
23
+ "suggestions": [
24
+ {
25
+ "source": "label",
26
+ "target": "label"
27
+ }
28
+ ]
29
+ },
30
+ "imported": "UI"
31
+ },
32
+ "workspace_id": "3930233b-f754-480b-b2e8-d290d8bcb518",
33
+ "last_activity_at": "2024-12-10T15:15:22.839938",
34
+ "inserted_at": "2024-11-25T15:04:24.880403",
35
+ "updated_at": "2024-11-25T15:04:25.645358"
36
+ }
.argilla/settings.json ADDED
@@ -0,0 +1,53 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "guidelines": null,
3
+ "allow_extra_metadata": true,
4
+ "distribution": {
5
+ "strategy": "overlap",
6
+ "min_submitted": 1
7
+ },
8
+ "fields": [
9
+ {
10
+ "id": "60ab1e29-cc44-4fd1-8049-cc766b92cabd",
11
+ "name": "text",
12
+ "title": "text",
13
+ "required": false,
14
+ "settings": {
15
+ "type": "text",
16
+ "use_markdown": false
17
+ },
18
+ "dataset_id": "6df01fac-4fb7-4a6d-8d2a-d62c5e782342",
19
+ "inserted_at": "2024-11-25T15:04:25.131178",
20
+ "updated_at": "2024-11-25T15:04:25.131178"
21
+ }
22
+ ],
23
+ "questions": [
24
+ {
25
+ "id": "ffe6db1a-1360-4611-af1b-6569e94d1630",
26
+ "name": "label",
27
+ "title": "label",
28
+ "description": null,
29
+ "required": true,
30
+ "settings": {
31
+ "type": "label_selection",
32
+ "options": [
33
+ {
34
+ "value": "neg",
35
+ "text": "neg",
36
+ "description": null
37
+ },
38
+ {
39
+ "value": "pos",
40
+ "text": "pos",
41
+ "description": null
42
+ }
43
+ ],
44
+ "visible_options": null
45
+ },
46
+ "dataset_id": "6df01fac-4fb7-4a6d-8d2a-d62c5e782342",
47
+ "inserted_at": "2024-11-25T15:04:25.391358",
48
+ "updated_at": "2024-11-25T15:04:25.391358"
49
+ }
50
+ ],
51
+ "metadata": [],
52
+ "vectors": []
53
+ }
.argilla/version.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ {
2
+ "argilla": "2.6.0dev0"
3
+ }
README.md CHANGED
@@ -1,39 +1,144 @@
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: label.responses
17
- sequence: string
18
- - name: label.responses.users
19
- sequence: string
20
- - name: label.responses.status
21
- sequence: string
22
- - name: label.suggestion
23
- dtype: string
24
- - name: label.suggestion.agent
25
- dtype: 'null'
26
- - name: label.suggestion.score
27
- dtype: 'null'
28
- splits:
29
- - name: train
30
- num_bytes: 14129529
31
- num_examples: 10000
32
- download_size: 8915950
33
- dataset_size: 14129529
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 hydrate-test
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("frascuchon/hydrate-test", 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("frascuchon/hydrate-test")
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 | 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
+ | label | label | label_selection | True | N/A | [] |
69
+
70
+
71
+ <!-- check length of metadata properties -->
72
+
73
+
74
+
75
+
76
+ ### Data Splits
77
+
78
+ The dataset contains a single split, which is `train`.
79
+
80
+ ## Dataset Creation
81
+
82
+ ### Curation Rationale
83
+
84
+ [More Information Needed]
85
+
86
+ ### Source Data
87
+
88
+ #### Initial Data Collection and Normalization
89
+
90
+ [More Information Needed]
91
+
92
+ #### Who are the source language producers?
93
+
94
+ [More Information Needed]
95
+
96
+ ### Annotations
97
+
98
+ #### Annotation guidelines
99
+
100
+ [More Information Needed]
101
+
102
+ #### Annotation process
103
+
104
+ [More Information Needed]
105
+
106
+ #### Who are the annotators?
107
+
108
+ [More Information Needed]
109
+
110
+ ### Personal and Sensitive Information
111
+
112
+ [More Information Needed]
113
+
114
+ ## Considerations for Using the Data
115
+
116
+ ### Social Impact of Dataset
117
+
118
+ [More Information Needed]
119
+
120
+ ### Discussion of Biases
121
+
122
+ [More Information Needed]
123
+
124
+ ### Other Known Limitations
125
+
126
+ [More Information Needed]
127
+
128
+ ## Additional Information
129
+
130
+ ### Dataset Curators
131
+
132
+ [More Information Needed]
133
+
134
+ ### Licensing Information
135
+
136
+ [More Information Needed]
137
+
138
+ ### Citation Information
139
+
140
+ [More Information Needed]
141
+
142
+ ### Contributions
143
+
144
+ [More Information Needed]