SeungAhSon commited on
Commit
40de4f2
1 Parent(s): 19ec280

Upload folder using huggingface_hub

Browse files
Files changed (3) hide show
  1. .argilla/dataset.json +1 -0
  2. .argilla/settings.json +1 -0
  3. README.md +197 -33
.argilla/dataset.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"id": "cac7a175-df8d-478e-b2bc-5d28cc5cf084", "inserted_at": "2024-09-06T02:03:28.799128", "updated_at": "2024-09-06T02:03:29.452661", "name": "setfit_tutorial_dataset", "status": "ready", "guidelines": null, "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}, "workspace_id": "54beafd1-003b-4ae1-97c9-661fb1afe46b", "last_activity_at": "2024-09-06T02:03:29.452661"}
.argilla/settings.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"guidelines": null, "questions": [{"id": "fd634328-8d0a-4a3e-9518-f515189d636d", "name": "topics", "settings": {"type": "multi_label_selection", "options": [{"value": "activate_my_card", "text": "activate_my_card", "description": null}, {"value": "age_limit", "text": "age_limit", "description": null}, {"value": "apple_pay_or_google_pay", "text": "apple_pay_or_google_pay", "description": null}, {"value": "atm_support", "text": "atm_support", "description": null}, {"value": "automatic_top_up", "text": "automatic_top_up", "description": null}, {"value": "balance_not_updated_after_bank_transfer", "text": "balance_not_updated_after_bank_transfer", "description": null}, {"value": "balance_not_updated_after_cheque_or_cash_deposit", "text": "balance_not_updated_after_cheque_or_cash_deposit", "description": null}, {"value": "beneficiary_not_allowed", "text": "beneficiary_not_allowed", "description": null}, {"value": "cancel_transfer", "text": "cancel_transfer", "description": null}, {"value": "card_about_to_expire", "text": "card_about_to_expire", "description": null}, {"value": "card_acceptance", "text": "card_acceptance", "description": null}, {"value": "card_arrival", "text": "card_arrival", "description": null}, {"value": "card_delivery_estimate", "text": "card_delivery_estimate", "description": null}, {"value": "card_linking", "text": "card_linking", "description": null}, {"value": "card_not_working", "text": "card_not_working", "description": null}, {"value": "card_payment_fee_charged", "text": "card_payment_fee_charged", "description": null}, {"value": "card_payment_not_recognised", "text": "card_payment_not_recognised", "description": null}, {"value": "card_payment_wrong_exchange_rate", "text": "card_payment_wrong_exchange_rate", "description": null}, {"value": "card_swallowed", "text": "card_swallowed", "description": null}, {"value": "cash_withdrawal_charge", "text": "cash_withdrawal_charge", "description": null}, {"value": "cash_withdrawal_not_recognised", "text": "cash_withdrawal_not_recognised", "description": null}, {"value": "change_pin", "text": "change_pin", "description": null}, {"value": "compromised_card", "text": "compromised_card", "description": null}, {"value": "contactless_not_working", "text": "contactless_not_working", "description": null}, {"value": "country_support", "text": "country_support", "description": null}, {"value": "declined_card_payment", "text": "declined_card_payment", "description": null}, {"value": "declined_cash_withdrawal", "text": "declined_cash_withdrawal", "description": null}, {"value": "declined_transfer", "text": "declined_transfer", "description": null}, {"value": "direct_debit_payment_not_recognised", "text": "direct_debit_payment_not_recognised", "description": null}, {"value": "disposable_card_limits", "text": "disposable_card_limits", "description": null}, {"value": "edit_personal_details", "text": "edit_personal_details", "description": null}, {"value": "exchange_charge", "text": "exchange_charge", "description": null}, {"value": "exchange_rate", "text": "exchange_rate", "description": null}, {"value": "exchange_via_app", "text": "exchange_via_app", "description": null}, {"value": "extra_charge_on_statement", "text": "extra_charge_on_statement", "description": null}, {"value": "failed_transfer", "text": "failed_transfer", "description": null}, {"value": "fiat_currency_support", "text": "fiat_currency_support", "description": null}, {"value": "get_disposable_virtual_card", "text": "get_disposable_virtual_card", "description": null}, {"value": "get_physical_card", "text": "get_physical_card", "description": null}, {"value": "getting_spare_card", "text": "getting_spare_card", "description": null}, {"value": "getting_virtual_card", "text": "getting_virtual_card", "description": null}, {"value": "lost_or_stolen_card", "text": "lost_or_stolen_card", "description": null}, {"value": "lost_or_stolen_phone", "text": "lost_or_stolen_phone", "description": null}, {"value": "order_physical_card", "text": "order_physical_card", "description": null}, {"value": "passcode_forgotten", "text": "passcode_forgotten", "description": null}, {"value": "pending_card_payment", "text": "pending_card_payment", "description": null}, {"value": "pending_cash_withdrawal", "text": "pending_cash_withdrawal", "description": null}, {"value": "pending_top_up", "text": "pending_top_up", "description": null}, {"value": "pending_transfer", "text": "pending_transfer", "description": null}, {"value": "pin_blocked", "text": "pin_blocked", "description": null}, {"value": "receiving_money", "text": "receiving_money", "description": null}, {"value": "Refund_not_showing_up", "text": "Refund_not_showing_up", "description": null}, {"value": "request_refund", "text": "request_refund", "description": null}, {"value": "reverted_card_payment?", "text": "reverted_card_payment?", "description": null}, {"value": "supported_cards_and_currencies", "text": "supported_cards_and_currencies", "description": null}, {"value": "terminate_account", "text": "terminate_account", "description": null}, {"value": "top_up_by_bank_transfer_charge", "text": "top_up_by_bank_transfer_charge", "description": null}, {"value": "top_up_by_card_charge", "text": "top_up_by_card_charge", "description": null}, {"value": "top_up_by_cash_or_cheque", "text": "top_up_by_cash_or_cheque", "description": null}, {"value": "top_up_failed", "text": "top_up_failed", "description": null}, {"value": "top_up_limits", "text": "top_up_limits", "description": null}, {"value": "top_up_reverted", "text": "top_up_reverted", "description": null}, {"value": "topping_up_by_card", "text": "topping_up_by_card", "description": null}, {"value": "transaction_charged_twice", "text": "transaction_charged_twice", "description": null}, {"value": "transfer_fee_charged", "text": "transfer_fee_charged", "description": null}, {"value": "transfer_into_account", "text": "transfer_into_account", "description": null}, {"value": "transfer_not_received_by_recipient", "text": "transfer_not_received_by_recipient", "description": null}, {"value": "transfer_timing", "text": "transfer_timing", "description": null}, {"value": "unable_to_verify_identity", "text": "unable_to_verify_identity", "description": null}, {"value": "verify_my_identity", "text": "verify_my_identity", "description": null}, {"value": "verify_source_of_funds", "text": "verify_source_of_funds", "description": null}, {"value": "verify_top_up", "text": "verify_top_up", "description": null}, {"value": "virtual_card_not_working", "text": "virtual_card_not_working", "description": null}, {"value": "visa_or_mastercard", "text": "visa_or_mastercard", "description": null}, {"value": "why_verify_identity", "text": "why_verify_identity", "description": null}, {"value": "wrong_amount_of_cash_received", "text": "wrong_amount_of_cash_received", "description": null}, {"value": "wrong_exchange_rate_for_cash_withdrawal", "text": "wrong_exchange_rate_for_cash_withdrawal", "description": null}], "visible_options": 10, "options_order": "natural"}, "title": "Select the topic(s) of the request", "description": null, "required": true, "inserted_at": "2024-09-06T02:03:29.059691", "updated_at": "2024-09-06T02:03:29.059691", "type": "multi_label_selection"}, {"id": "2f05b5c8-339b-4ba5-9f47-ef2e85af1bfa", "name": "sentiment", "settings": {"type": "label_selection", "options": [{"value": "positive", "text": "positive", "description": null}, {"value": "neutral", "text": "neutral", "description": null}, {"value": "negative", "text": "negative", "description": null}], "visible_options": 3}, "title": "What is the sentiment of the message?", "description": null, "required": true, "inserted_at": "2024-09-06T02:03:29.152445", "updated_at": "2024-09-06T02:03:29.152445", "type": "label_selection"}], "fields": [{"id": "0e7ded18-ce13-4424-9d15-34b0fa36fea9", "inserted_at": "2024-09-06T02:03:28.969129", "updated_at": "2024-09-06T02:03:28.969129", "name": "text", "settings": {"type": "text", "use_markdown": false}, "title": "text", "required": true, "description": null, "dataset_id": "cac7a175-df8d-478e-b2bc-5d28cc5cf084", "type": "text"}], "vectors": [], "metadata": [], "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}}
README.md CHANGED
@@ -1,35 +1,199 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: id
5
- dtype: string
6
- - name: status
7
- dtype: string
8
- - name: _server_id
9
- dtype: string
10
- - name: text
11
- dtype: string
12
- - name: sentiment.suggestion
13
- dtype: string
14
- - name: sentiment.suggestion.score
15
- dtype: 'null'
16
- - name: sentiment.suggestion.agent
17
- dtype: 'null'
18
- - name: topics.suggestion
19
- sequence: string
20
- - name: topics.suggestion.score
21
- dtype: 'null'
22
- - name: topics.suggestion.agent
23
- dtype: 'null'
24
- splits:
25
- - name: train
26
- num_bytes: 624567
27
- num_examples: 3080
28
- download_size: 342569
29
- dataset_size: 624567
30
- configs:
31
- - config_name: default
32
- data_files:
33
- - split: train
34
- path: data/train-*
35
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ size_categories: 1K<n<10K
3
+ tags:
4
+ - rlfh
5
+ - argilla
6
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  ---
8
+
9
+ # Dataset Card for my_setfit_dataset
10
+
11
+
12
+
13
+
14
+
15
+
16
+
17
+ 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).
18
+
19
+
20
+ ## Using this dataset with Argilla
21
+
22
+ To load with Argilla, you'll just need to install Argilla as `pip install argilla --upgrade` and then use the following code:
23
+
24
+ ```python
25
+ import argilla as rg
26
+
27
+ ds = rg.Dataset.from_hub("SeungAhSon/my_setfit_dataset")
28
+ ```
29
+
30
+ This will load the settings and records from the dataset repository and push them to you Argilla server for exploration and annotation.
31
+
32
+ ## Using this dataset with `datasets`
33
+
34
+ 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:
35
+
36
+ ```python
37
+ from datasets import load_dataset
38
+
39
+ ds = load_dataset("SeungAhSon/my_setfit_dataset")
40
+ ```
41
+
42
+ This will only load the records of the dataset, but not the Argilla settings.
43
+
44
+ ## Dataset Structure
45
+
46
+ This dataset repo contains:
47
+
48
+ * 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`.
49
+ * The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
50
+ * A dataset configuration folder conforming to the Argilla dataset format in `.argilla`.
51
+
52
+ The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.
53
+
54
+ ### Fields
55
+
56
+ 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.
57
+
58
+ | Field Name | Title | Type | Required | Markdown |
59
+ | ---------- | ----- | ---- | -------- | -------- |
60
+ | text | text | text | True | False |
61
+
62
+
63
+ ### Questions
64
+
65
+ 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.
66
+
67
+ | Question Name | Title | Type | Required | Description | Values/Labels |
68
+ | ------------- | ----- | ---- | -------- | ----------- | ------------- |
69
+ | topics | Select the topic(s) of the request | multi_label_selection | True | N/A | ['activate_my_card', 'age_limit', 'apple_pay_or_google_pay', 'atm_support', 'automatic_top_up', 'balance_not_updated_after_bank_transfer', 'balance_not_updated_after_cheque_or_cash_deposit', 'beneficiary_not_allowed', 'cancel_transfer', 'card_about_to_expire', 'card_acceptance', 'card_arrival', 'card_delivery_estimate', 'card_linking', 'card_not_working', 'card_payment_fee_charged', 'card_payment_not_recognised', 'card_payment_wrong_exchange_rate', 'card_swallowed', 'cash_withdrawal_charge', 'cash_withdrawal_not_recognised', 'change_pin', 'compromised_card', 'contactless_not_working', 'country_support', 'declined_card_payment', 'declined_cash_withdrawal', 'declined_transfer', 'direct_debit_payment_not_recognised', 'disposable_card_limits', 'edit_personal_details', 'exchange_charge', 'exchange_rate', 'exchange_via_app', 'extra_charge_on_statement', 'failed_transfer', 'fiat_currency_support', 'get_disposable_virtual_card', 'get_physical_card', 'getting_spare_card', 'getting_virtual_card', 'lost_or_stolen_card', 'lost_or_stolen_phone', 'order_physical_card', 'passcode_forgotten', 'pending_card_payment', 'pending_cash_withdrawal', 'pending_top_up', 'pending_transfer', 'pin_blocked', 'receiving_money', 'Refund_not_showing_up', 'request_refund', 'reverted_card_payment?', 'supported_cards_and_currencies', 'terminate_account', 'top_up_by_bank_transfer_charge', 'top_up_by_card_charge', 'top_up_by_cash_or_cheque', 'top_up_failed', 'top_up_limits', 'top_up_reverted', 'topping_up_by_card', 'transaction_charged_twice', 'transfer_fee_charged', 'transfer_into_account', 'transfer_not_received_by_recipient', 'transfer_timing', 'unable_to_verify_identity', 'verify_my_identity', 'verify_source_of_funds', 'verify_top_up', 'virtual_card_not_working', 'visa_or_mastercard', 'why_verify_identity', 'wrong_amount_of_cash_received', 'wrong_exchange_rate_for_cash_withdrawal'] |
70
+ | sentiment | What is the sentiment of the message? | label_selection | True | N/A | ['positive', 'neutral', 'negative'] |
71
+
72
+
73
+ <!-- check length of metadata properties -->
74
+
75
+
76
+
77
+
78
+
79
+ ### Data Instances
80
+
81
+ An example of a dataset instance in Argilla looks as follows:
82
+
83
+ ```json
84
+ {
85
+ "_server_id": "70e66e5f-32a6-4376-9b89-48c355365e56",
86
+ "fields": {
87
+ "text": "I need to reset my passcode. How do I do it?"
88
+ },
89
+ "id": "74194048-4270-4e14-b5d8-58193abd969c",
90
+ "metadata": {},
91
+ "responses": {},
92
+ "status": "pending",
93
+ "suggestions": {
94
+ "sentiment": {
95
+ "agent": null,
96
+ "score": null,
97
+ "value": "neutral"
98
+ },
99
+ "topics": {
100
+ "agent": null,
101
+ "score": null,
102
+ "value": [
103
+ "passcode_forgotten"
104
+ ]
105
+ }
106
+ },
107
+ "vectors": {}
108
+ }
109
+ ```
110
+
111
+ While the same record in HuggingFace `datasets` looks as follows:
112
+
113
+ ```json
114
+ {
115
+ "_server_id": "70e66e5f-32a6-4376-9b89-48c355365e56",
116
+ "id": "74194048-4270-4e14-b5d8-58193abd969c",
117
+ "sentiment.suggestion": "neutral",
118
+ "sentiment.suggestion.agent": null,
119
+ "sentiment.suggestion.score": null,
120
+ "status": "pending",
121
+ "text": "I need to reset my passcode. How do I do it?",
122
+ "topics.suggestion": [
123
+ "passcode_forgotten"
124
+ ],
125
+ "topics.suggestion.agent": null,
126
+ "topics.suggestion.score": null
127
+ }
128
+ ```
129
+
130
+
131
+ ### Data Splits
132
+
133
+ The dataset contains a single split, which is `train`.
134
+
135
+ ## Dataset Creation
136
+
137
+ ### Curation Rationale
138
+
139
+ [More Information Needed]
140
+
141
+ ### Source Data
142
+
143
+ #### Initial Data Collection and Normalization
144
+
145
+ [More Information Needed]
146
+
147
+ #### Who are the source language producers?
148
+
149
+ [More Information Needed]
150
+
151
+ ### Annotations
152
+
153
+ #### Annotation guidelines
154
+
155
+ [More Information Needed]
156
+
157
+ #### Annotation process
158
+
159
+ [More Information Needed]
160
+
161
+ #### Who are the annotators?
162
+
163
+ [More Information Needed]
164
+
165
+ ### Personal and Sensitive Information
166
+
167
+ [More Information Needed]
168
+
169
+ ## Considerations for Using the Data
170
+
171
+ ### Social Impact of Dataset
172
+
173
+ [More Information Needed]
174
+
175
+ ### Discussion of Biases
176
+
177
+ [More Information Needed]
178
+
179
+ ### Other Known Limitations
180
+
181
+ [More Information Needed]
182
+
183
+ ## Additional Information
184
+
185
+ ### Dataset Curators
186
+
187
+ [More Information Needed]
188
+
189
+ ### Licensing Information
190
+
191
+ [More Information Needed]
192
+
193
+ ### Citation Information
194
+
195
+ [More Information Needed]
196
+
197
+ ### Contributions
198
+
199
+ [More Information Needed]