Hemg commited on
Commit
b7d9301
·
verified ·
1 Parent(s): 08f39fb

Upload folder using huggingface_hub

Browse files
Files changed (4) hide show
  1. .argilla/dataset.json +16 -0
  2. .argilla/settings.json +84 -0
  3. .argilla/version.json +3 -0
  4. README.md +127 -82
.argilla/dataset.json ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "id": "94204c94-e780-46b5-ba33-2502738d89b1",
3
+ "name": "my-distiset-be899639",
4
+ "guidelines": "Please review the text and provide or correct the label where needed.",
5
+ "allow_extra_metadata": false,
6
+ "status": "ready",
7
+ "distribution": {
8
+ "strategy": "overlap",
9
+ "min_submitted": 1
10
+ },
11
+ "metadata": null,
12
+ "workspace_id": "5eddffac-76ff-4812-8264-5f3940fbc4f4",
13
+ "last_activity_at": "2025-01-07T13:24:03.383050",
14
+ "inserted_at": "2025-01-07T13:24:02.457347",
15
+ "updated_at": "2025-01-07T13:24:03.383050"
16
+ }
.argilla/settings.json ADDED
@@ -0,0 +1,84 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "guidelines": "Please review the text and provide or correct the label where needed.",
3
+ "allow_extra_metadata": false,
4
+ "distribution": {
5
+ "strategy": "overlap",
6
+ "min_submitted": 1
7
+ },
8
+ "fields": [
9
+ {
10
+ "id": "ecdc9c05-e79a-48ff-9ea4-151161e435bf",
11
+ "name": "text",
12
+ "title": "Text",
13
+ "required": true,
14
+ "settings": {
15
+ "type": "text",
16
+ "use_markdown": false
17
+ },
18
+ "dataset_id": "94204c94-e780-46b5-ba33-2502738d89b1",
19
+ "inserted_at": "2025-01-07T13:24:02.803389",
20
+ "updated_at": "2025-01-07T13:24:02.803389"
21
+ }
22
+ ],
23
+ "questions": [
24
+ {
25
+ "id": "ce18f39e-5ecd-4006-be7d-844c8d1969ca",
26
+ "name": "labels",
27
+ "title": "Labels",
28
+ "description": "The labels of the conversation",
29
+ "required": true,
30
+ "settings": {
31
+ "type": "multi_label_selection",
32
+ "options": [
33
+ {
34
+ "value": "positive",
35
+ "text": "positive",
36
+ "description": null
37
+ },
38
+ {
39
+ "value": "negative",
40
+ "text": "negative",
41
+ "description": null
42
+ },
43
+ {
44
+ "value": "neutral",
45
+ "text": "neutral",
46
+ "description": null
47
+ }
48
+ ],
49
+ "visible_options": 3,
50
+ "options_order": "natural"
51
+ },
52
+ "dataset_id": "94204c94-e780-46b5-ba33-2502738d89b1",
53
+ "inserted_at": "2025-01-07T13:24:02.918677",
54
+ "updated_at": "2025-01-07T13:24:02.918677"
55
+ }
56
+ ],
57
+ "metadata": [
58
+ {
59
+ "id": "e03234aa-4836-4439-8b16-255ef43ed81c",
60
+ "name": "text_length",
61
+ "title": "Text Length",
62
+ "settings": {
63
+ "type": "integer",
64
+ "min": null,
65
+ "max": null
66
+ },
67
+ "visible_for_annotators": true,
68
+ "dataset_id": "94204c94-e780-46b5-ba33-2502738d89b1",
69
+ "inserted_at": "2025-01-07T13:24:03.238662",
70
+ "updated_at": "2025-01-07T13:24:03.238662"
71
+ }
72
+ ],
73
+ "vectors": [
74
+ {
75
+ "id": "493ad350-ddc5-44a9-b328-ba807f6f8d22",
76
+ "name": "text_embeddings",
77
+ "title": "text_embeddings",
78
+ "dimensions": 256,
79
+ "dataset_id": "94204c94-e780-46b5-ba33-2502738d89b1",
80
+ "inserted_at": "2025-01-07T13:24:03.135083",
81
+ "updated_at": "2025-01-07T13:24:03.135083"
82
+ }
83
+ ]
84
+ }
.argilla/version.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ {
2
+ "argilla": "2.6.0"
3
+ }
README.md CHANGED
@@ -1,115 +1,160 @@
1
  ---
2
- size_categories: n<1K
3
- dataset_info:
4
- features:
5
- - name: id
6
- dtype: string
7
- - name: status
8
- dtype: string
9
- - name: inserted_at
10
- dtype: timestamp[us]
11
- - name: updated_at
12
- dtype: timestamp[us]
13
- - name: _server_id
14
- dtype: string
15
- - name: text
16
- dtype: string
17
- - name: labels.responses
18
- dtype: 'null'
19
- - name: labels.responses.users
20
- dtype: 'null'
21
- - name: labels.responses.status
22
- dtype: 'null'
23
- - name: labels.suggestion
24
- sequence: string
25
- - name: labels.suggestion.agent
26
- dtype: 'null'
27
- - name: labels.suggestion.score
28
- dtype: 'null'
29
- - name: metadata.text_length
30
- dtype: int64
31
- - name: vector.text_embeddings
32
- sequence: float64
33
- splits:
34
- - name: train
35
- num_bytes: 24013
36
- num_examples: 10
37
- download_size: 29439
38
- dataset_size: 24013
39
- configs:
40
- - config_name: default
41
- data_files:
42
- - split: train
43
- path: data/train-*
44
  tags:
45
- - synthetic
46
- - distilabel
47
- - rlaif
48
- - datacraft
49
  ---
50
 
51
- <p align="left">
52
- <a href="https://github.com/argilla-io/distilabel">
53
- <img src="https://raw.githubusercontent.com/argilla-io/distilabel/main/docs/assets/distilabel-badge-light.png" alt="Built with Distilabel" width="200" height="32"/>
54
- </a>
55
- </p>
56
-
57
  # Dataset Card for my-distiset-be899639
58
 
59
- This dataset has been created with [distilabel](https://distilabel.argilla.io/).
60
-
61
 
62
 
63
- ## Dataset Summary
64
 
65
- This dataset contains a `pipeline.yaml` which can be used to reproduce the pipeline that generated it in distilabel using the `distilabel` CLI:
66
 
67
- ```console
68
- distilabel pipeline run --config "https://huggingface.co/datasets/Hemg/my-distiset-be899639/raw/main/pipeline.yaml"
69
- ```
70
 
71
- or explore the configuration:
72
 
73
- ```console
74
- distilabel pipeline info --config "https://huggingface.co/datasets/Hemg/my-distiset-be899639/raw/main/pipeline.yaml"
75
- ```
76
 
77
- ## Dataset structure
78
 
79
- The examples have the following structure per configuration:
80
 
 
81
 
82
- <details><summary> Configuration: default </summary><hr>
 
83
 
84
- ```json
85
- {
86
- "labels": [
87
- 0,
88
- 2
89
- ],
90
- "text": "The movie\u0027s plot was engaging and had some unexpected twists, but it didn\u0027t quite live up to the hype."
91
- }
92
  ```
93
 
94
- This subset can be loaded as:
 
 
 
 
95
 
96
  ```python
97
  from datasets import load_dataset
98
 
99
- ds = load_dataset("Hemg/my-distiset-be899639", "default")
100
  ```
101
 
102
- Or simply as it follows, since there's only one configuration and is named `default`:
103
 
104
- ```python
105
- from datasets import load_dataset
106
 
107
- ds = load_dataset("Hemg/my-distiset-be899639")
108
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
109
 
 
110
 
111
- </details>
112
 
 
113
 
 
114
 
 
115
 
 
 
1
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  tags:
3
+ - rlfh
4
+ - argilla
5
+ - human-feedback
 
6
  ---
7
 
 
 
 
 
 
 
8
  # Dataset Card for my-distiset-be899639
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("hemg/my-distiset-be899639", 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("hemg/my-distiset-be899639")
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
+ | labels | Labels | multi_label_selection | True | The labels of the conversation | ['positive', 'negative', 'neutral'] |
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
+ | text_length | Text Length | integer | - | True |
79
+
80
+
81
+
82
+
83
+ ### Vectors
84
+ The **vectors** contain a vector representation of the record that can be used in search.
85
+
86
+ | Vector Name | Title | Dimensions |
87
+ |-------------|-------|------------|
88
+ | text_embeddings | text_embeddings | [1, 256] |
89
+
90
+
91
+
92
+ ### Data Splits
93
+
94
+ The dataset contains a single split, which is `train`.
95
+
96
+ ## Dataset Creation
97
+
98
+ ### Curation Rationale
99
+
100
+ [More Information Needed]
101
+
102
+ ### Source Data
103
+
104
+ #### Initial Data Collection and Normalization
105
+
106
+ [More Information Needed]
107
+
108
+ #### Who are the source language producers?
109
+
110
+ [More Information Needed]
111
+
112
+ ### Annotations
113
+
114
+ #### Annotation guidelines
115
+
116
+ Please review the text and provide or correct the label where needed.
117
+
118
+ #### Annotation process
119
+
120
+ [More Information Needed]
121
+
122
+ #### Who are the annotators?
123
+
124
+ [More Information Needed]
125
+
126
+ ### Personal and Sensitive Information
127
+
128
+ [More Information Needed]
129
+
130
+ ## Considerations for Using the Data
131
+
132
+ ### Social Impact of Dataset
133
+
134
+ [More Information Needed]
135
+
136
+ ### Discussion of Biases
137
+
138
+ [More Information Needed]
139
+
140
+ ### Other Known Limitations
141
+
142
+ [More Information Needed]
143
+
144
+ ## Additional Information
145
+
146
+ ### Dataset Curators
147
+
148
+ [More Information Needed]
149
 
150
+ ### Licensing Information
151
 
152
+ [More Information Needed]
153
 
154
+ ### Citation Information
155
 
156
+ [More Information Needed]
157
 
158
+ ### Contributions
159
 
160
+ [More Information Needed]