Upload folder using huggingface_hub

.argilla/dataset.json

@@ -0,0 +1,16 @@
+{
+  "id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+  "name": "scilake-energy-energytype",
+  "guidelines": "# Energy type validation guidelines\n## Task Description\nYour task is to validate the extraction of energy (storage) type entities and their linking to their closest matching entries in the IRENA taxonomy.\n\n## What to Validate\nFor each record, please verify the following:\n1. **Entity Spans:** Are all text spans correctly identified? Are the span boundaries accurate?\n2. **Entity Types:** Are entity types correctly assigned?\n3. **Entity Linking:** Are the matching entities in the IRENA taxonomy correctly assigned?\n\n## Instructions\n1. Carefully read the texts.\n2. Review the NER spans and correct them if:\n- The boundaries (start/end) are incorrect\n- The entity label is wrong\n3. Verify that the extracted entities are correctly linked to their closest match in the IRENA taxonomy\n4. Add any comments or feedback you deem relevant\n\n## Validation Guidelines\n- Entity Annotations: Mark spans as \"Correct\" only if boundaries and labels are accurate.\n- Entity Extraction: Mark as \"Correct\" if all energy (storage) types mentioned are extracted; \"Partially correct\" if any are missing or incorrect.\n- IRENA Linking: Mark as \"Correct\" if all links are to the appropriate entries. Use \"Partially correct\" if any are incorrect.",
+  "allow_extra_metadata": false,
+  "status": "ready",
+  "distribution": {
+    "strategy": "overlap",
+    "min_submitted": 1
+  },
+  "metadata": null,
+  "workspace_id": "0756eadb-468f-4c06-88c4-51a3fa6f665f",
+  "last_activity_at": "2025-06-19T09:39:52.323021",
+  "inserted_at": "2025-04-28T10:03:43.698371",
+  "updated_at": "2025-06-19T09:39:52.323021"
+}

.argilla/settings.json

@@ -0,0 +1,171 @@
+{
+  "guidelines": "# Energy type validation guidelines\n## Task Description\nYour task is to validate the extraction of energy (storage) type entities and their linking to their closest matching entries in the IRENA taxonomy.\n\n## What to Validate\nFor each record, please verify the following:\n1. **Entity Spans:** Are all text spans correctly identified? Are the span boundaries accurate?\n2. **Entity Types:** Are entity types correctly assigned?\n3. **Entity Linking:** Are the matching entities in the IRENA taxonomy correctly assigned?\n\n## Instructions\n1. Carefully read the texts.\n2. Review the NER spans and correct them if:\n- The boundaries (start/end) are incorrect\n- The entity label is wrong\n3. Verify that the extracted entities are correctly linked to their closest match in the IRENA taxonomy\n4. Add any comments or feedback you deem relevant\n\n## Validation Guidelines\n- Entity Annotations: Mark spans as \"Correct\" only if boundaries and labels are accurate.\n- Entity Extraction: Mark as \"Correct\" if all energy (storage) types mentioned are extracted; \"Partially correct\" if any are missing or incorrect.\n- IRENA Linking: Mark as \"Correct\" if all links are to the appropriate entries. Use \"Partially correct\" if any are incorrect.",
+  "allow_extra_metadata": false,
+  "distribution": {
+    "strategy": "overlap",
+    "min_submitted": 1
+  },
+  "fields": [
+    {
+      "id": "c62010e4-5203-4b96-8c42-68d2faa7af95",
+      "name": "doi",
+      "title": "DOI",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": true
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:43.904236",
+      "updated_at": "2025-04-28T10:03:51.861287"
+    },
+    {
+      "id": "407fa06c-c8aa-4b2d-8224-3085e95a73d0",
+      "name": "section",
+      "title": "Section",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:43.983225",
+      "updated_at": "2025-04-28T10:03:51.941063"
+    },
+    {
+      "id": "ab9ed754-05ae-4e31-86fa-d72b8b15fef2",
+      "name": "text",
+      "title": "Text",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:44.067134",
+      "updated_at": "2025-04-28T10:03:52.016753"
+    },
+    {
+      "id": "265672ea-4010-49da-9ab1-6f3dc6e0cd5c",
+      "name": "links",
+      "title": "Linked entities",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": true
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:44.149413",
+      "updated_at": "2025-04-28T10:03:52.091619"
+    }
+  ],
+  "questions": [
+    {
+      "id": "67fc361f-6085-4dc9-8fa8-ca8b17a797f4",
+      "name": "span_label",
+      "title": "Select and classify the tokens according to the specified categories.",
+      "description": null,
+      "required": true,
+      "settings": {
+        "type": "span",
+        "field": "text",
+        "options": [
+          {
+            "value": "energyType",
+            "text": "energyType",
+            "description": null
+          },
+          {
+            "value": "energyStorage",
+            "text": "energyStorage",
+            "description": null
+          }
+        ],
+        "visible_options": null,
+        "allow_overlapping": true,
+        "allow_character_annotation": true
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:44.226969",
+      "updated_at": "2025-04-28T10:03:52.478580"
+    },
+    {
+      "id": "db067e02-040c-4da8-ad70-f3d4da6a477e",
+      "name": "assess_ner",
+      "title": "Extracted entity validation",
+      "description": "Are the extracted entities correct?",
+      "required": true,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "Correct",
+            "text": "Correct",
+            "description": null
+          },
+          {
+            "value": "Partially correct",
+            "text": "Partially correct",
+            "description": null
+          },
+          {
+            "value": "Incorrect",
+            "text": "Incorrect",
+            "description": null
+          }
+        ],
+        "visible_options": 3
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:44.302372",
+      "updated_at": "2025-04-28T10:03:52.553353"
+    },
+    {
+      "id": "c38dd5b6-5483-4976-8983-182446d97585",
+      "name": "assess_nel",
+      "title": "Linked IRENA entity validation",
+      "description": "Are the linked entities in the IRENA taxonomy correct?",
+      "required": true,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "Correct",
+            "text": "Correct",
+            "description": null
+          },
+          {
+            "value": "Partially correct",
+            "text": "Partially correct",
+            "description": null
+          },
+          {
+            "value": "Incorrect",
+            "text": "Incorrect",
+            "description": null
+          }
+        ],
+        "visible_options": 3
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:44.383916",
+      "updated_at": "2025-04-28T10:03:52.632804"
+    },
+    {
+      "id": "94247fa9-0053-401b-9cbb-fa9e207bb2be",
+      "name": "comments",
+      "title": "Comments",
+      "description": "Additional comments",
+      "required": false,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "129124c9-525d-4d2e-8f98-6ed5c0d34539",
+      "inserted_at": "2025-04-28T10:03:44.468572",
+      "updated_at": "2025-04-28T10:03:52.711433"
+    }
+  ],
+  "metadata": [],
+  "vectors": []
+}

.argilla/version.json

@@ -0,0 +1,3 @@
+{
+  "argilla": "2.6.0"
+}

README.md

@@ -1,76 +1,171 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: status
-    dtype: string
-  - name: inserted_at
-    dtype: timestamp[us]
-  - name: updated_at
-    dtype: timestamp[us]
-  - name: _server_id
-    dtype: string
-  - name: doi
-    dtype: string
-  - name: section
-    dtype: string
-  - name: text
-    dtype: string
-  - name: links
-    dtype: string
-  - name: span_label.responses
-    list:
-      list:
-      - name: end
-        dtype: int64
-      - name: label
-        dtype: string
-      - name: start
-        dtype: int64
-  - name: span_label.responses.users
-    sequence: string
-  - name: span_label.responses.status
-    sequence: string
-  - name: assess_ner.responses
-    sequence: string
-  - name: assess_ner.responses.users
-    sequence: string
-  - name: assess_ner.responses.status
-    sequence: string
-  - name: assess_nel.responses
-    sequence: string
-  - name: assess_nel.responses.users
-    sequence: string
-  - name: assess_nel.responses.status
-    sequence: string
-  - name: comments.responses
-    sequence: string
-  - name: comments.responses.users
-    sequence: string
-  - name: comments.responses.status
-    sequence: string
-  - name: span_label.suggestion
-    list:
-    - name: end
-      dtype: int64
-    - name: label
-      dtype: string
-    - name: start
-      dtype: int64
-  - name: span_label.suggestion.agent
-    dtype: 'null'
-  - name: span_label.suggestion.score
-    dtype: 'null'
-  splits:
-  - name: train
-    num_bytes: 412378
-    num_examples: 147
-  download_size: 203824
-  dataset_size: 412378
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+tags:
+- rlfh
+- argilla
+- human-feedback
 ---
+
+# Dataset Card for scilake-energytype
+
+
+
+
+
+
+
+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("SIRIS-Lab/scilake-energytype", settings="auto")
+```
+
+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("SIRIS-Lab/scilake-energytype")
+```
+
+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 |
+| ---------- | ----- | ---- | -------- |
+| doi | DOI | text | True |
+| section | Section | text | True |
+| text | Text | text | True |
+| links | Linked entities | text | True |
+
+
+### 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 |
+| ------------- | ----- | ---- | -------- | ----------- | ------------- |
+| span_label | Select and classify the tokens according to the specified categories. | span | True | N/A | ['energyType', 'energyStorage'] |
+| assess_ner | Extracted entity validation | label_selection | True | Are the extracted entities correct? | ['Correct', 'Partially correct', 'Incorrect'] |
+| assess_nel | Linked IRENA entity validation | label_selection | True | Are the linked entities in the IRENA taxonomy correct? | ['Correct', 'Partially correct', 'Incorrect'] |
+| comments | Comments | text | False | Additional comments | N/A |
+
+
+<!-- check length of metadata properties -->
+
+
+
+
+### 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
+
+# Energy type validation guidelines
+## Task Description
+Your task is to validate the extraction of energy (storage) type entities and their linking to their closest matching entries in the IRENA taxonomy.
+
+## What to Validate
+For each record, please verify the following:
+1. **Entity Spans:** Are all text spans correctly identified? Are the span boundaries accurate?
+2. **Entity Types:** Are entity types correctly assigned?
+3. **Entity Linking:** Are the matching entities in the IRENA taxonomy correctly assigned?
+
+## Instructions
+1. Carefully read the texts.
+2. Review the NER spans and correct them if:
+- The boundaries (start/end) are incorrect
+- The entity label is wrong
+3. Verify that the extracted entities are correctly linked to their closest match in the IRENA taxonomy
+4. Add any comments or feedback you deem relevant
+
+## Validation Guidelines
+- Entity Annotations: Mark spans as "Correct" only if boundaries and labels are accurate.
+- Entity Extraction: Mark as "Correct" if all energy (storage) types mentioned are extracted; "Partially correct" if any are missing or incorrect.
+- IRENA Linking: Mark as "Correct" if all links are to the appropriate entries. Use "Partially correct" if any are incorrect.
+
+#### 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]