jfcalvo commited on
Commit
9b998b4
1 Parent(s): 4c50fd5

Upload folder using huggingface_hub

Browse files
Files changed (4) hide show
  1. .argilla/dataset.json +36 -0
  2. .argilla/settings.json +67 -0
  3. .argilla/version.json +3 -0
  4. README.md +143 -35
.argilla/dataset.json ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "id": "950c0cbe-7412-4af6-94e6-64d49b44a1ee",
3
+ "name": "imdb-with-custom",
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": "9b40ede0-87d5-4b20-9299-690c0c385c66",
33
+ "last_activity_at": "2024-12-02T14:40:52.372368",
34
+ "inserted_at": "2024-11-29T12:59:35.501032",
35
+ "updated_at": "2024-11-29T12:59:35.580005"
36
+ }
.argilla/settings.json ADDED
@@ -0,0 +1,67 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "guidelines": null,
3
+ "allow_extra_metadata": true,
4
+ "distribution": {
5
+ "strategy": "overlap",
6
+ "min_submitted": 1
7
+ },
8
+ "fields": [
9
+ {
10
+ "id": "4b7fd98b-32bb-4296-81ab-3dbe9735d833",
11
+ "name": "text",
12
+ "title": "text",
13
+ "required": false,
14
+ "settings": {
15
+ "type": "text",
16
+ "use_markdown": false
17
+ },
18
+ "dataset_id": "950c0cbe-7412-4af6-94e6-64d49b44a1ee",
19
+ "inserted_at": "2024-11-29T12:59:35.540379",
20
+ "updated_at": "2024-11-29T12:59:35.540379"
21
+ },
22
+ {
23
+ "id": "1e1b8134-5d83-4869-a55f-08de196c6fc4",
24
+ "name": "custom",
25
+ "title": "Custom",
26
+ "required": false,
27
+ "settings": {
28
+ "type": "custom",
29
+ "template": "hello",
30
+ "advanced_mode": false
31
+ },
32
+ "dataset_id": "950c0cbe-7412-4af6-94e6-64d49b44a1ee",
33
+ "inserted_at": "2024-11-29T13:02:14.928389",
34
+ "updated_at": "2024-11-29T13:02:14.928389"
35
+ }
36
+ ],
37
+ "questions": [
38
+ {
39
+ "id": "0da13c6b-a60d-41b1-b0f3-571c17244e20",
40
+ "name": "label",
41
+ "title": "label",
42
+ "description": null,
43
+ "required": true,
44
+ "settings": {
45
+ "type": "label_selection",
46
+ "options": [
47
+ {
48
+ "value": "neg",
49
+ "text": "neg",
50
+ "description": null
51
+ },
52
+ {
53
+ "value": "pos",
54
+ "text": "pos",
55
+ "description": null
56
+ }
57
+ ],
58
+ "visible_options": null
59
+ },
60
+ "dataset_id": "950c0cbe-7412-4af6-94e6-64d49b44a1ee",
61
+ "inserted_at": "2024-11-29T12:59:35.560686",
62
+ "updated_at": "2024-11-29T12:59:35.560686"
63
+ }
64
+ ],
65
+ "metadata": [],
66
+ "vectors": []
67
+ }
.argilla/version.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ {
2
+ "argilla": "2.6.0dev0"
3
+ }
README.md CHANGED
@@ -1,37 +1,145 @@
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: custom
13
- struct:
14
- - name: one
15
- dtype: string
16
- - name: three
17
- dtype: string
18
- - name: two
19
- dtype: string
20
- - name: label.responses
21
- sequence: string
22
- - name: label.responses.users
23
- sequence: string
24
- - name: label.responses.status
25
- sequence: string
26
- splits:
27
- - name: train
28
- num_bytes: 14023070
29
- num_examples: 10000
30
- download_size: 8800811
31
- dataset_size: 14023070
32
- configs:
33
- - config_name: default
34
- data_files:
35
- - split: train
36
- path: data/train-*
37
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ tags:
3
+ - rlfh
4
+ - argilla
5
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6
  ---
7
+
8
+ # Dataset Card for imdb-with-custom
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("jfcalvo/imdb-with-custom", 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("jfcalvo/imdb-with-custom")
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
+ | custom | Custom | custom | 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
+ | label | label | label_selection | True | N/A | [] |
70
+
71
+
72
+ <!-- check length of metadata properties -->
73
+
74
+
75
+
76
+
77
+ ### Data Splits
78
+
79
+ The dataset contains a single split, which is `train`.
80
+
81
+ ## Dataset Creation
82
+
83
+ ### Curation Rationale
84
+
85
+ [More Information Needed]
86
+
87
+ ### Source Data
88
+
89
+ #### Initial Data Collection and Normalization
90
+
91
+ [More Information Needed]
92
+
93
+ #### Who are the source language producers?
94
+
95
+ [More Information Needed]
96
+
97
+ ### Annotations
98
+
99
+ #### Annotation guidelines
100
+
101
+ [More Information Needed]
102
+
103
+ #### Annotation process
104
+
105
+ [More Information Needed]
106
+
107
+ #### Who are the annotators?
108
+
109
+ [More Information Needed]
110
+
111
+ ### Personal and Sensitive Information
112
+
113
+ [More Information Needed]
114
+
115
+ ## Considerations for Using the Data
116
+
117
+ ### Social Impact of Dataset
118
+
119
+ [More Information Needed]
120
+
121
+ ### Discussion of Biases
122
+
123
+ [More Information Needed]
124
+
125
+ ### Other Known Limitations
126
+
127
+ [More Information Needed]
128
+
129
+ ## Additional Information
130
+
131
+ ### Dataset Curators
132
+
133
+ [More Information Needed]
134
+
135
+ ### Licensing Information
136
+
137
+ [More Information Needed]
138
+
139
+ ### Citation Information
140
+
141
+ [More Information Needed]
142
+
143
+ ### Contributions
144
+
145
+ [More Information Needed]