khalilayeb commited on
Commit
defb60f
1 Parent(s): 36f3b56

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +218 -47
README.md CHANGED
@@ -1,49 +1,220 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: text
5
- dtype: string
6
- id: field
7
- - name: sentiment
8
- list:
9
- - name: user_id
10
- dtype: string
11
- id: question
12
- - name: value
13
- dtype: string
14
- id: suggestion
15
- - name: status
16
- dtype: string
17
- id: question
18
- - name: sentiment-suggestion
19
- dtype: string
20
- id: suggestion
21
- - name: sentiment-suggestion-metadata
22
- struct:
23
- - name: type
24
- dtype: string
25
- id: suggestion-metadata
26
- - name: score
27
- dtype: float32
28
- id: suggestion-metadata
29
- - name: agent
30
- dtype: string
31
- id: suggestion-metadata
32
- - name: external_id
33
- dtype: string
34
- id: external_id
35
- - name: metadata
36
- dtype: string
37
- id: metadata
38
- splits:
39
- - name: train
40
- num_bytes: 63
41
- num_examples: 1
42
- download_size: 5482
43
- dataset_size: 63
44
- configs:
45
- - config_name: default
46
- data_files:
47
- - split: train
48
- path: data/train-*
49
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ size_categories: n<1K
3
+ tags:
4
+ - rlfh
5
+ - argilla
6
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  ---
8
+
9
+ # Dataset Card for khalil-argilla
10
+
11
+ This dataset has been created with [Argilla](https://docs.argilla.io).
12
+
13
+ As shown in the sections below, this dataset can be loaded into Argilla as explained in [Load with Argilla](#load-with-argilla), or used directly with the `datasets` library in [Load with `datasets`](#load-with-datasets).
14
+
15
+ ## Dataset Description
16
+
17
+ - **Homepage:** https://argilla.io
18
+ - **Repository:** https://github.com/argilla-io/argilla
19
+ - **Paper:**
20
+ - **Leaderboard:**
21
+ - **Point of Contact:**
22
+
23
+ ### Dataset Summary
24
+
25
+ This dataset contains:
26
+
27
+ * A dataset configuration file conforming to the Argilla dataset format named `argilla.yaml`. This configuration file will be used to configure the dataset when using the `FeedbackDataset.from_huggingface` method in Argilla.
28
+
29
+ * Dataset records in a format compatible with HuggingFace `datasets`. These records will be loaded automatically when using `FeedbackDataset.from_huggingface` and can be loaded independently using the `datasets` library via `load_dataset`.
30
+
31
+ * The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
32
+
33
+ ### Load with Argilla
34
+
35
+ To load with Argilla, you'll just need to install Argilla as `pip install argilla --upgrade` and then use the following code:
36
+
37
+ ```python
38
+ import argilla as rg
39
+
40
+ ds = rg.FeedbackDataset.from_huggingface("khalilayeb/khalil-argilla")
41
+ ```
42
+
43
+ ### Load with `datasets`
44
+
45
+ To load this dataset with `datasets`, you'll just need to install `datasets` as `pip install datasets --upgrade` and then use the following code:
46
+
47
+ ```python
48
+ from datasets import load_dataset
49
+
50
+ ds = load_dataset("khalilayeb/khalil-argilla")
51
+ ```
52
+
53
+ ### Supported Tasks and Leaderboards
54
+
55
+ This dataset can contain [multiple fields, questions and responses](https://docs.argilla.io/en/latest/conceptual_guides/data_model.html#feedback-dataset) so it can be used for different NLP tasks, depending on the configuration. The dataset structure is described in the [Dataset Structure section](#dataset-structure).
56
+
57
+ There are no leaderboards associated with this dataset.
58
+
59
+ ### Languages
60
+
61
+ [More Information Needed]
62
+
63
+ ## Dataset Structure
64
+
65
+ ### Data in Argilla
66
+
67
+ The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.
68
+
69
+ The **fields** are the dataset records themselves, for the moment just text fields are supported. These are the ones that will be used to provide responses to the questions.
70
+
71
+ | Field Name | Title | Type | Required | Markdown |
72
+ | ---------- | ----- | ---- | -------- | -------- |
73
+ | text | Text | text | True | False |
74
+
75
+
76
+ 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.
77
+
78
+ | Question Name | Title | Type | Required | Description | Values/Labels |
79
+ | ------------- | ----- | ---- | -------- | ----------- | ------------- |
80
+ | sentiment | Sentiment | label_selection | True | N/A | ['positive', 'neutral', 'negative'] |
81
+
82
+
83
+ The **suggestions** are human or machine generated recommendations for each question to assist the annotator during the annotation process, so those are always linked to the existing questions, and named appending "-suggestion" and "-suggestion-metadata" to those, containing the value/s of the suggestion and its metadata, respectively. So on, the possible values are the same as in the table above, but the column name is appended with "-suggestion" and the metadata is appended with "-suggestion-metadata".
84
+
85
+ The **metadata** is a dictionary that can be used to provide additional information about the dataset record. This can be useful to provide additional context to the annotators, or to provide additional information about the dataset record itself. For example, you can use this to provide a link to the original source of the dataset record, or to provide additional information about the dataset record itself, such as the author, the date, or the source. The metadata is always optional, and can be potentially linked to the `metadata_properties` defined in the dataset configuration file in `argilla.yaml`.
86
+
87
+
88
+
89
+ | Metadata Name | Title | Type | Values | Visible for Annotators |
90
+ | ------------- | ----- | ---- | ------ | ---------------------- |
91
+
92
+
93
+ The **guidelines**, are optional as well, and are just a plain string that can be used to provide instructions to the annotators. Find those in the [annotation guidelines](#annotation-guidelines) section.
94
+
95
+ ### Data Instances
96
+
97
+ An example of a dataset instance in Argilla looks as follows:
98
+
99
+ ```json
100
+ {
101
+ "external_id": null,
102
+ "fields": {
103
+ "text": "This is a positive text."
104
+ },
105
+ "metadata": {},
106
+ "responses": [],
107
+ "suggestions": [],
108
+ "vectors": {}
109
+ }
110
+ ```
111
+
112
+ While the same record in HuggingFace `datasets` looks as follows:
113
+
114
+ ```json
115
+ {
116
+ "external_id": null,
117
+ "metadata": "{}",
118
+ "sentiment": [],
119
+ "sentiment-suggestion": null,
120
+ "sentiment-suggestion-metadata": {
121
+ "agent": null,
122
+ "score": null,
123
+ "type": null
124
+ },
125
+ "text": "This is a positive text."
126
+ }
127
+ ```
128
+
129
+ ### Data Fields
130
+
131
+ Among the dataset fields, we differentiate between the following:
132
+
133
+ * **Fields:** These are the dataset records themselves, for the moment just text fields are supported. These are the ones that will be used to provide responses to the questions.
134
+
135
+ * **text** is of type `text`.
136
+
137
+ * **Questions:** These are the questions that will be asked to the annotators. They can be of different types, such as `RatingQuestion`, `TextQuestion`, `LabelQuestion`, `MultiLabelQuestion`, and `RankingQuestion`.
138
+
139
+ * **sentiment** is of type `label_selection` with the following allowed values ['positive', 'neutral', 'negative'].
140
+
141
+ * **Suggestions:** As of Argilla 1.13.0, the suggestions have been included to provide the annotators with suggestions to ease or assist during the annotation process. Suggestions are linked to the existing questions, are always optional, and contain not just the suggestion itself, but also the metadata linked to it, if applicable.
142
+
143
+ * (optional) **sentiment-suggestion** is of type `label_selection` with the following allowed values ['positive', 'neutral', 'negative'].
144
+
145
+
146
+
147
+ Additionally, we also have two more fields that are optional and are the following:
148
+
149
+ * **metadata:** This is an optional field that can be used to provide additional information about the dataset record. This can be useful to provide additional context to the annotators, or to provide additional information about the dataset record itself. For example, you can use this to provide a link to the original source of the dataset record, or to provide additional information about the dataset record itself, such as the author, the date, or the source. The metadata is always optional, and can be potentially linked to the `metadata_properties` defined in the dataset configuration file in `argilla.yaml`.
150
+ * **external_id:** This is an optional field that can be used to provide an external ID for the dataset record. This can be useful if you want to link the dataset record to an external resource, such as a database or a file.
151
+
152
+ ### Data Splits
153
+
154
+ The dataset contains a single split, which is `train`.
155
+
156
+ ## Dataset Creation
157
+
158
+ ### Curation Rationale
159
+
160
+ [More Information Needed]
161
+
162
+ ### Source Data
163
+
164
+ #### Initial Data Collection and Normalization
165
+
166
+ [More Information Needed]
167
+
168
+ #### Who are the source language producers?
169
+
170
+ [More Information Needed]
171
+
172
+ ### Annotations
173
+
174
+ #### Annotation guidelines
175
+
176
+ Classify the sentiment of the text.
177
+
178
+ #### Annotation process
179
+
180
+ [More Information Needed]
181
+
182
+ #### Who are the annotators?
183
+
184
+ [More Information Needed]
185
+
186
+ ### Personal and Sensitive Information
187
+
188
+ [More Information Needed]
189
+
190
+ ## Considerations for Using the Data
191
+
192
+ ### Social Impact of Dataset
193
+
194
+ [More Information Needed]
195
+
196
+ ### Discussion of Biases
197
+
198
+ [More Information Needed]
199
+
200
+ ### Other Known Limitations
201
+
202
+ [More Information Needed]
203
+
204
+ ## Additional Information
205
+
206
+ ### Dataset Curators
207
+
208
+ [More Information Needed]
209
+
210
+ ### Licensing Information
211
+
212
+ [More Information Needed]
213
+
214
+ ### Citation Information
215
+
216
+ [More Information Needed]
217
+
218
+ ### Contributions
219
+
220
+ [More Information Needed]