burtenshaw HF staff commited on
Commit
ad43cae
·
verified ·
1 Parent(s): 0e11749

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 +159 -29
.argilla/dataset.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"id": "9e90dd32-560e-41d0-a52e-0e3c532aeaee", "inserted_at": "2024-08-20T09:41:01.836402", "updated_at": "2024-08-20T09:41:01.978580", "name": "image_dataset", "status": "ready", "guidelines": null, "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}, "workspace_id": "735cae0d-eb08-45c3-ad79-0a11ad4dd2c2", "last_activity_at": "2024-08-20T09:41:01.978580"}
.argilla/settings.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"guidelines": null, "questions": [{"id": "389fead1-a751-42ac-ad89-3c7cf30885a8", "name": "label", "settings": {"type": "text", "use_markdown": false}, "title": "label", "description": null, "required": true, "inserted_at": "2024-08-20T09:41:01.866112", "updated_at": "2024-08-20T09:41:01.866112", "type": "text"}], "fields": [{"id": "718f254b-f9a6-4531-9ac6-9146a212598b", "inserted_at": "2024-08-20T09:41:01.854365", "updated_at": "2024-08-20T09:41:01.854365", "name": "image", "settings": {"type": "image"}, "title": "image", "required": true, "description": null, "dataset_id": "9e90dd32-560e-41d0-a52e-0e3c532aeaee", "type": "image"}], "vectors": [], "metadata": [], "allow_extra_metadata": false, "distribution": {"strategy": "overlap", "min_submitted": 1}}
README.md CHANGED
@@ -1,31 +1,161 @@
1
  ---
2
- dataset_info:
3
- features:
4
- - name: image
5
- dtype: image
6
- - name: label
7
- dtype:
8
- class_label:
9
- names:
10
- '0': '0'
11
- '1': '1'
12
- '2': '2'
13
- '3': '3'
14
- '4': '4'
15
- '5': '5'
16
- '6': '6'
17
- '7': '7'
18
- '8': '8'
19
- '9': '9'
20
- splits:
21
- - name: test
22
- num_bytes: 2789.0
23
- num_examples: 10
24
- download_size: 5564
25
- dataset_size: 2789.0
26
- configs:
27
- - config_name: default
28
- data_files:
29
- - split: test
30
- path: data/test-*
31
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ size_categories: n<1K
3
+ tags:
4
+ - rlfh
5
+ - argilla
6
+ - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  ---
8
+
9
+ # Dataset Card for test_import_image_dataset_from_hub
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("argilla-internal-testing/test_import_image_dataset_from_hub")
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("argilla-internal-testing/test_import_image_dataset_from_hub")
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
+ | image | image | image | True | |
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 | text | True | N/A | N/A |
70
+
71
+
72
+ <!-- check length of metadata properties -->
73
+
74
+
75
+
76
+
77
+
78
+ ### Data Instances
79
+
80
+ An example of a dataset instance in Argilla looks as follows:
81
+
82
+ ```json
83
+ {}
84
+ ```
85
+
86
+ While the same record in HuggingFace `datasets` looks as follows:
87
+
88
+ ```json
89
+ "No sample records provided"
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
+ [More Information Needed]
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]