Upload folder using huggingface_hub

.argilla/dataset.json

@@ -0,0 +1 @@
+{"id": "21be54bc-1ffd-401c-a637-97c8345e9c6c", "inserted_at": "2024-10-12T18:40:37.510221", "updated_at": "2024-10-12T18:48:45.427558", "name": "inspect_asr_eval_results_prod_with_extra_metadata", "status": "ready", "guidelines": "Inspect ASR evaluation results and data.", "allow_extra_metadata": true, "distribution": {"strategy": "overlap", "min_submitted": 1}, "workspace_id": "69902674-829b-455f-82a9-6ea6a8df2ee3", "last_activity_at": "2024-10-12T18:48:45.427256"}

.argilla/settings.json

@@ -0,0 +1 @@
+{"guidelines": "Inspect ASR evaluation results and data.", "questions": [{"id": "d641a6a3-57f3-429a-b792-d4d525fb5aac", "name": "error_types", "settings": {"type": "multi_label_selection", "options": [{"value": "none", "text": "OK - no errors", "description": null}, {"value": "spacing", "text": "Spacing", "description": null}, {"value": "punctuation", "text": "Punctuation", "description": null}, {"value": "numerical", "text": "Numerical", "description": null}, {"value": "removal", "text": "Missing words", "description": null}, {"value": "addition", "text": "Added words", "description": null}, {"value": "replacement", "text": "Replaced words", "description": null}, {"value": "spelling", "text": "Spelling error", "description": null}, {"value": "syntax", "text": "Syntax error", "description": null}, {"value": "foreign_language", "text": "Foreign language related", "description": null}, {"value": "empty", "text": "Empty hypothesis", "description": null}, {"value": "hallucination", "text": "Hallucination", "description": null}], "visible_options": 10, "options_order": "natural"}, "title": "Mark all ASR errors present in the hypothesis or select OK - no errors.", "description": "Select all that apply.", "required": true, "inserted_at": "2024-10-12T18:40:38.726415", "updated_at": "2024-10-12T18:40:38.726415", "type": "multi_label_selection"}, {"id": "c3097cb3-edc5-4e01-8d8b-2ff67cbe2320", "name": "asr_error", "settings": {"type": "span", "allow_overlapping": false, "field": "hyp", "options": [{"value": "major", "text": "Major - Impairs correct understanding", "description": null}, {"value": "minor", "text": "Minor - Negligible impact on understanding", "description": null}], "visible_options": null}, "title": "If applicable, mark error spans in ASR hypothesis.", "description": "Mark and classify ASR errors.", "required": false, "inserted_at": "2024-10-12T18:40:38.988991", "updated_at": "2024-10-12T18:40:38.988991", "type": "span"}, {"id": "36a5d0d9-d987-4a89-8617-260392f9b58e", "name": "ref_issue", "settings": {"type": "label_selection", "options": [{"value": "minor", "text": "Minor - normalization, spelling", "description": null}, {"value": "major", "text": "Major - syntax, semantics", "description": null}, {"value": "critical", "text": "Critical - incomplete, gibberish, etc.", "description": null}], "visible_options": 3}, "title": "If applicable, mark issues in reference.", "description": null, "required": false, "inserted_at": "2024-10-12T18:40:39.245769", "updated_at": "2024-10-12T18:40:39.245769", "type": "label_selection"}, {"id": "762654ef-ef0e-4044-bf9c-d4e0bc40b45d", "name": "audio_issue", "settings": {"type": "label_selection", "options": [{"value": "invalid", "text": "Invalid audio (too short, corrupted, cut-off, etc.)", "description": null}, {"value": "hard_noise", "text": "Hard to comprehend due to background noise", "description": null}, {"value": "hard_interlocutor", "text": "Hard to comprehend due to interlocutor (accent, hesitations, mumbling etc.)", "description": null}], "visible_options": 3}, "title": "If applicable, mark issues in audio.", "description": null, "required": false, "inserted_at": "2024-10-12T18:40:39.519553", "updated_at": "2024-10-12T18:40:39.519553", "type": "label_selection"}], "fields": [{"id": "1f82cf3c-3d11-404c-af82-383cd6e29cb1", "inserted_at": "2024-10-12T18:40:37.961159", "updated_at": "2024-10-12T18:40:37.961159", "name": "audio", "settings": {"type": "text", "use_markdown": true}, "title": "Audio file", "required": true, "description": null, "dataset_id": "21be54bc-1ffd-401c-a637-97c8345e9c6c", "type": "text"}, {"id": "8fa002f4-9e7c-4eb8-880e-b972e3d244d7", "inserted_at": "2024-10-12T18:40:38.217973", "updated_at": "2024-10-12T18:40:38.217973", "name": "hyp", "settings": {"type": "text", "use_markdown": false}, "title": "ASR output", "required": true, "description": null, "dataset_id": "21be54bc-1ffd-401c-a637-97c8345e9c6c", "type": "text"}, {"id": "ea0e11a4-6241-466d-9f49-5751909cdc31", "inserted_at": "2024-10-12T18:40:38.462957", "updated_at": "2024-10-12T18:40:38.462957", "name": "ref", "settings": {"type": "text", "use_markdown": false}, "title": "Reference transcription", "required": true, "description": null, "dataset_id": "21be54bc-1ffd-401c-a637-97c8345e9c6c", "type": "text"}], "vectors": [], "metadata": [], "allow_extra_metadata": true, "distribution": {"strategy": "overlap", "min_submitted": 1}, "mapping": null}

README.md

@@ -1,61 +1,230 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: status
-    dtype: string
-  - name: _server_id
-    dtype: string
-  - name: audio
-    dtype: string
-  - name: ref
-    dtype: string
-  - name: hyp
-    dtype: string
-  - name: subset
-    dtype: string
-  - name: error_types.responses
-    sequence:
-      sequence: string
-  - name: error_types.responses.users
-    sequence: string
-  - name: error_types.responses.status
-    sequence: string
-  - name: asr_error.responses
-    list:
-      list:
-      - name: end
-        dtype: int64
-      - name: label
-        dtype: string
-      - name: start
-        dtype: int64
-  - name: asr_error.responses.users
-    sequence: string
-  - name: asr_error.responses.status
-    sequence: string
-  - name: ref_issue.responses.users
-    sequence: string
-  - name: audio_issue.responses.users
-    sequence: string
-  - name: audio_issue.responses.status
-    sequence: string
-  - name: ref_issue.responses
-    sequence: string
-  - name: audio_issue.responses
-    sequence: string
-  - name: ref_issue.responses.status
-    sequence: string
-  splits:
-  - name: train
-    num_bytes: 1325
-    num_examples: 2
-  download_size: 17101
-  dataset_size: 1325
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+size_categories: n<1K
+tags:
+- rlfh
+- argilla
+- human-feedback
 ---
+
+# Dataset Card for inspect_asr_eval_results
+
+
+
+
+
+
+
+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).
+
+
+## Using this dataset with Argilla
+
+To load with Argilla, you'll just need to install Argilla as `pip install argilla --upgrade` and then use the following code:
+
+```python
+import argilla as rg
+
+ds = rg.Dataset.from_hub("michaljunczyk/inspect_asr_eval_results")
+```
+
+This will load the settings and records from the dataset repository and push them to you Argilla server for exploration and annotation.
+
+## Using this dataset with `datasets`
+
+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:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("michaljunczyk/inspect_asr_eval_results")
+```
+
+This will only load the records of the dataset, but not the Argilla settings.
+
+## Dataset Structure
+
+This dataset repo contains:
+
+* 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`.
+* The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
+* A dataset configuration folder conforming to the Argilla dataset format in `.argilla`.
+
+The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.
+
+### Fields
+
+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.
+
+| Field Name | Title | Type | Required | Markdown |
+| ---------- | ----- | ---- | -------- | -------- |
+| audio | Audio file | text | True | True |
+| hyp | ASR output | text | True | False |
+| ref | Reference transcription | text | True | False |
+
+
+### Questions
+
+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.
+
+| Question Name | Title | Type | Required | Description | Values/Labels |
+| ------------- | ----- | ---- | -------- | ----------- | ------------- |
+| error_types | Mark all ASR errors present in the hypothesis or select OK - no errors. | multi_label_selection | True | Select all that apply. | ['none', 'spacing', 'punctuation', 'numerical', 'removal', 'addition', 'replacement', 'spelling', 'syntax', 'foreign_language', 'empty', 'hallucination'] |
+| asr_error | If applicable, mark error spans in ASR hypothesis. | span | False | Mark and classify ASR errors. | N/A |
+| ref_issue | If applicable, mark issues in reference. | label_selection | False | N/A | ['minor', 'major', 'critical'] |
+| audio_issue | If applicable, mark issues in audio. | label_selection | False | N/A | ['invalid', 'hard_noise', 'hard_interlocutor'] |
+
+
+<!-- check length of metadata properties -->
+
+
+
+
+
+### Data Instances
+
+An example of a dataset instance in Argilla looks as follows:
+
+```json
+{
+    "_server_id": "f1cb2f9c-4428-48f7-97e2-3c7359c426a8",
+    "fields": {
+        "audio": "\n\u003caudio controls\u003e\n    \u003csource src=\"https://huggingface.co/datasets/michaljunczyk/bigos-eval-results-secret/resolve/main/inspection_input/audio/amu-cai/pl-asr-bigos-v2-secret/pwr-viu-unk/pwr-viu-unk-test-0003-00283.mp3\" type=\"audio/mpeg\"\u003e\n\u003c/audio\u003e\n",
+        "hyp": "Hyphotesis",
+        "ref": "Reference transcription wav"
+    },
+    "id": "dce1711c-1d36-4d2a-86ac-afaf85aacb06",
+    "metadata": {
+        "subset": "pwr-viu-unk-3"
+    },
+    "responses": {
+        "asr_error": [
+            {
+                "user_id": "bee532bf-10c0-4a3f-9386-3b5c3522197a",
+                "value": []
+            }
+        ],
+        "error_types": [
+            {
+                "user_id": "bee532bf-10c0-4a3f-9386-3b5c3522197a",
+                "value": [
+                    "none"
+                ]
+            }
+        ]
+    },
+    "status": "completed",
+    "suggestions": {},
+    "vectors": {}
+}
+```
+
+While the same record in HuggingFace `datasets` looks as follows:
+
+```json
+{
+    "_server_id": "f1cb2f9c-4428-48f7-97e2-3c7359c426a8",
+    "asr_error.responses": [
+        []
+    ],
+    "asr_error.responses.status": [
+        "submitted"
+    ],
+    "asr_error.responses.users": [
+        "bee532bf-10c0-4a3f-9386-3b5c3522197a"
+    ],
+    "audio": "\n\u003caudio controls\u003e\n    \u003csource src=\"https://huggingface.co/datasets/michaljunczyk/bigos-eval-results-secret/resolve/main/inspection_input/audio/amu-cai/pl-asr-bigos-v2-secret/pwr-viu-unk/pwr-viu-unk-test-0003-00283.mp3\" type=\"audio/mpeg\"\u003e\n\u003c/audio\u003e\n",
+    "audio_issue.responses": null,
+    "audio_issue.responses.status": null,
+    "audio_issue.responses.users": null,
+    "error_types.responses": [
+        [
+            "none"
+        ]
+    ],
+    "error_types.responses.status": [
+        "submitted"
+    ],
+    "error_types.responses.users": [
+        "bee532bf-10c0-4a3f-9386-3b5c3522197a"
+    ],
+    "hyp": "Hyphotesis",
+    "id": "dce1711c-1d36-4d2a-86ac-afaf85aacb06",
+    "ref": "Reference transcription wav",
+    "ref_issue.responses": null,
+    "ref_issue.responses.status": null,
+    "ref_issue.responses.users": null,
+    "status": "completed",
+    "subset": "pwr-viu-unk-3"
+}
+```
+
+
+### Data Splits
+
+The dataset contains a single split, which is `train`.
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation guidelines
+
+Inspect ASR evaluation results and data.
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+[More Information Needed]
+
+### Contributions
+
+[More Information Needed]