shayan080 commited on
Commit
5f2be58
·
verified ·
1 Parent(s): a1a0904

Upload folder using huggingface_hub

Browse files
Files changed (4) hide show
  1. .argilla/dataset.json +16 -0
  2. .argilla/settings.json +96 -0
  3. .argilla/version.json +3 -0
  4. README.md +159 -41
.argilla/dataset.json ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "id": "3ed5fe2d-8f78-46e0-929c-204235d5b71e",
3
+ "name": "my-distiset-15694b42",
4
+ "guidelines": "Please review the conversation and provide a score for the assistant's response.",
5
+ "allow_extra_metadata": false,
6
+ "status": "ready",
7
+ "distribution": {
8
+ "strategy": "overlap",
9
+ "min_submitted": 1
10
+ },
11
+ "metadata": null,
12
+ "workspace_id": "0e13986c-c24b-44af-a300-29dc3a749b23",
13
+ "last_activity_at": "2025-02-11T15:30:48.684792",
14
+ "inserted_at": "2025-02-11T15:23:11.433201",
15
+ "updated_at": "2025-02-11T15:23:12.554537"
16
+ }
.argilla/settings.json ADDED
@@ -0,0 +1,96 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "guidelines": "Please review the conversation and provide a score for the assistant's response.",
3
+ "allow_extra_metadata": false,
4
+ "distribution": {
5
+ "strategy": "overlap",
6
+ "min_submitted": 1
7
+ },
8
+ "fields": [
9
+ {
10
+ "id": "55a631b6-0d45-45a8-8809-908642a556e4",
11
+ "name": "messages",
12
+ "title": "Messages",
13
+ "required": true,
14
+ "settings": {
15
+ "type": "chat",
16
+ "use_markdown": true
17
+ },
18
+ "dataset_id": "3ed5fe2d-8f78-46e0-929c-204235d5b71e",
19
+ "inserted_at": "2025-02-11T15:23:11.804971",
20
+ "updated_at": "2025-02-11T15:23:11.804971"
21
+ }
22
+ ],
23
+ "questions": [
24
+ {
25
+ "id": "f669a823-38f7-481d-bed6-ca42714f1a1f",
26
+ "name": "rating",
27
+ "title": "Rating",
28
+ "description": "The rating of the conversation",
29
+ "required": true,
30
+ "settings": {
31
+ "type": "rating",
32
+ "options": [
33
+ {
34
+ "value": 1
35
+ },
36
+ {
37
+ "value": 2
38
+ },
39
+ {
40
+ "value": 3
41
+ },
42
+ {
43
+ "value": 4
44
+ },
45
+ {
46
+ "value": 5
47
+ }
48
+ ]
49
+ },
50
+ "dataset_id": "3ed5fe2d-8f78-46e0-929c-204235d5b71e",
51
+ "inserted_at": "2025-02-11T15:23:11.933835",
52
+ "updated_at": "2025-02-11T15:23:11.933835"
53
+ }
54
+ ],
55
+ "metadata": [
56
+ {
57
+ "id": "584949a2-6d55-4d70-96b8-f3c96089cbc1",
58
+ "name": "user_message_length",
59
+ "title": "User Message Length",
60
+ "settings": {
61
+ "type": "integer",
62
+ "min": null,
63
+ "max": null
64
+ },
65
+ "visible_for_annotators": true,
66
+ "dataset_id": "3ed5fe2d-8f78-46e0-929c-204235d5b71e",
67
+ "inserted_at": "2025-02-11T15:23:12.180666",
68
+ "updated_at": "2025-02-11T15:23:12.180666"
69
+ },
70
+ {
71
+ "id": "cd8ec881-e4a9-4199-9cc1-8faf84df4ce3",
72
+ "name": "assistant_message_length",
73
+ "title": "Assistant Message Length",
74
+ "settings": {
75
+ "type": "integer",
76
+ "min": null,
77
+ "max": null
78
+ },
79
+ "visible_for_annotators": true,
80
+ "dataset_id": "3ed5fe2d-8f78-46e0-929c-204235d5b71e",
81
+ "inserted_at": "2025-02-11T15:23:12.397131",
82
+ "updated_at": "2025-02-11T15:23:12.397131"
83
+ }
84
+ ],
85
+ "vectors": [
86
+ {
87
+ "id": "ac9f25af-81cb-41b4-814a-2b500cf2c1b1",
88
+ "name": "messages_embeddings",
89
+ "title": "messages_embeddings",
90
+ "dimensions": 256,
91
+ "dataset_id": "3ed5fe2d-8f78-46e0-929c-204235d5b71e",
92
+ "inserted_at": "2025-02-11T15:23:12.063651",
93
+ "updated_at": "2025-02-11T15:23:12.063651"
94
+ }
95
+ ]
96
+ }
.argilla/version.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ {
2
+ "argilla": "2.7.1"
3
+ }
README.md CHANGED
@@ -1,43 +1,161 @@
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: messages
15
- list:
16
- - name: content
17
- dtype: string
18
- - name: role
19
- dtype: string
20
- - name: rating.responses
21
- sequence: int64
22
- - name: rating.responses.users
23
- sequence: string
24
- - name: rating.responses.status
25
- sequence: string
26
- - name: metadata.user_message_length
27
- dtype: int64
28
- - name: metadata.assistant_message_length
29
- dtype: int64
30
- - name: vector.messages_embeddings
31
- sequence: float64
32
- splits:
33
- - name: train
34
- num_bytes: 60139
35
- num_examples: 5
36
- download_size: 41977
37
- dataset_size: 60139
38
- configs:
39
- - config_name: default
40
- data_files:
41
- - split: train
42
- path: data/train-*
43
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ tags:
3
+ - rlfh
4
+ - argilla
5
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ---
7
+
8
+ # Dataset Card for medicare_agent
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("shayan080/medicare_agent", 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("shayan080/medicare_agent")
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
+ | messages | Messages | chat | 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
+ | rating | Rating | rating | True | The rating of the conversation | [1, 2, 3, 4, 5] |
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
+ | user_message_length | User Message Length | integer | - | True |
79
+ | assistant_message_length | Assistant Message Length | integer | - | True |
80
+
81
+
82
+
83
+
84
+ ### Vectors
85
+ The **vectors** contain a vector representation of the record that can be used in search.
86
+
87
+ | Vector Name | Title | Dimensions |
88
+ |-------------|-------|------------|
89
+ | messages_embeddings | messages_embeddings | [1, 256] |
90
+
91
+
92
+
93
+ ### Data Splits
94
+
95
+ The dataset contains a single split, which is `train`.
96
+
97
+ ## Dataset Creation
98
+
99
+ ### Curation Rationale
100
+
101
+ [More Information Needed]
102
+
103
+ ### Source Data
104
+
105
+ #### Initial Data Collection and Normalization
106
+
107
+ [More Information Needed]
108
+
109
+ #### Who are the source language producers?
110
+
111
+ [More Information Needed]
112
+
113
+ ### Annotations
114
+
115
+ #### Annotation guidelines
116
+
117
+ Please review the conversation and provide a score for the assistant's response.
118
+
119
+ #### Annotation process
120
+
121
+ [More Information Needed]
122
+
123
+ #### Who are the annotators?
124
+
125
+ [More Information Needed]
126
+
127
+ ### Personal and Sensitive Information
128
+
129
+ [More Information Needed]
130
+
131
+ ## Considerations for Using the Data
132
+
133
+ ### Social Impact of Dataset
134
+
135
+ [More Information Needed]
136
+
137
+ ### Discussion of Biases
138
+
139
+ [More Information Needed]
140
+
141
+ ### Other Known Limitations
142
+
143
+ [More Information Needed]
144
+
145
+ ## Additional Information
146
+
147
+ ### Dataset Curators
148
+
149
+ [More Information Needed]
150
+
151
+ ### Licensing Information
152
+
153
+ [More Information Needed]
154
+
155
+ ### Citation Information
156
+
157
+ [More Information Needed]
158
+
159
+ ### Contributions
160
+
161
+ [More Information Needed]