Upload folder using huggingface_hub

.argilla/dataset.json

@@ -0,0 +1,16 @@
+{
+  "id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+  "name": "my-information-security-policy-distiset",
+  "guidelines": "Please review the conversation and provide an evaluation.",
+  "allow_extra_metadata": false,
+  "status": "ready",
+  "distribution": {
+    "strategy": "overlap",
+    "min_submitted": 1
+  },
+  "metadata": null,
+  "workspace_id": "13427d53-ef84-4f57-9ea4-ac800624a7eb",
+  "last_activity_at": "2025-02-22T03:05:11.697142",
+  "inserted_at": "2025-02-22T02:54:57.502977",
+  "updated_at": "2025-02-22T02:54:58.031457"
+}

.argilla/settings.json

@@ -0,0 +1,319 @@
+{
+  "guidelines": "Please review the conversation and provide an evaluation.",
+  "allow_extra_metadata": false,
+  "distribution": {
+    "strategy": "overlap",
+    "min_submitted": 1
+  },
+  "fields": [
+    {
+      "id": "70949c0d-a69f-4d19-8df5-d5ac96822fa8",
+      "name": "context",
+      "title": "Context",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.595276",
+      "updated_at": "2025-02-22T02:54:57.595276"
+    },
+    {
+      "id": "ac18cc7d-ca3b-490f-a0d7-36b7c1f9cce6",
+      "name": "chat",
+      "title": "Chat",
+      "required": true,
+      "settings": {
+        "type": "chat",
+        "use_markdown": true
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.609825",
+      "updated_at": "2025-02-22T02:54:57.609825"
+    },
+    {
+      "id": "14762611-71db-418c-b970-ca13a00afd48",
+      "name": "positive_retrieval",
+      "title": "Positive retrieval",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.625450",
+      "updated_at": "2025-02-22T02:54:57.625450"
+    },
+    {
+      "id": "585a9e4e-62ff-4aa9-a943-fa32a5e91507",
+      "name": "positive_reranking",
+      "title": "Positive reranking",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.794934",
+      "updated_at": "2025-02-22T02:54:57.794934"
+    },
+    {
+      "id": "9fc8b8f0-282e-4512-bd90-96e3cc75f5b8",
+      "name": "negative_retrieval",
+      "title": "Negative retrieval",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.810111",
+      "updated_at": "2025-02-22T02:54:57.810111"
+    },
+    {
+      "id": "4017d993-fda8-4e1e-8eb9-acaeb91f3035",
+      "name": "negative_reranking",
+      "title": "Negative reranking",
+      "required": true,
+      "settings": {
+        "type": "text",
+        "use_markdown": false
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.826333",
+      "updated_at": "2025-02-22T02:54:57.826333"
+    }
+  ],
+  "questions": [
+    {
+      "id": "b939f916-6d90-4ded-a640-a45187cbd7d4",
+      "name": "relevant",
+      "title": "Are the question and response relevant to the given context?",
+      "description": null,
+      "required": true,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "yes",
+            "text": "yes",
+            "description": null
+          },
+          {
+            "value": "no",
+            "text": "no",
+            "description": null
+          }
+        ],
+        "visible_options": null
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.855222",
+      "updated_at": "2025-02-22T02:54:57.855222"
+    },
+    {
+      "id": "5e3a46d9-50d0-458c-88f4-2954a270d831",
+      "name": "is_response_correct",
+      "title": "Is the response correct?",
+      "description": null,
+      "required": true,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "yes",
+            "text": "yes",
+            "description": null
+          },
+          {
+            "value": "no",
+            "text": "no",
+            "description": null
+          }
+        ],
+        "visible_options": null
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.872306",
+      "updated_at": "2025-02-22T02:54:57.872306"
+    },
+    {
+      "id": "88513b1b-dac7-4cc3-8e5d-beb3450ef5d4",
+      "name": "is_positive_retrieval_relevant",
+      "title": "Is the positive retrieval relevant?",
+      "description": null,
+      "required": false,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "yes",
+            "text": "yes",
+            "description": null
+          },
+          {
+            "value": "no",
+            "text": "no",
+            "description": null
+          }
+        ],
+        "visible_options": null
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.886567",
+      "updated_at": "2025-02-22T02:54:57.886567"
+    },
+    {
+      "id": "3faac67a-d598-4238-b7b6-81260ed14818",
+      "name": "is_positive_reranking_relevant",
+      "title": "Is the positive reranking relevant?",
+      "description": null,
+      "required": false,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "yes",
+            "text": "yes",
+            "description": null
+          },
+          {
+            "value": "no",
+            "text": "no",
+            "description": null
+          }
+        ],
+        "visible_options": null
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.902345",
+      "updated_at": "2025-02-22T02:54:57.902345"
+    },
+    {
+      "id": "c694532e-bb81-4be8-87bf-d8cd44b9a6fd",
+      "name": "is_negative_retrieval_relevant",
+      "title": "Is the negative retrieval relevant?",
+      "description": null,
+      "required": false,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "yes",
+            "text": "yes",
+            "description": null
+          },
+          {
+            "value": "no",
+            "text": "no",
+            "description": null
+          }
+        ],
+        "visible_options": null
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.916426",
+      "updated_at": "2025-02-22T02:54:57.916426"
+    },
+    {
+      "id": "7d8a2d21-4e57-4b9e-b5d1-536e07596022",
+      "name": "is_negative_reranking_relevant",
+      "title": "Is the negative reranking relevant?",
+      "description": null,
+      "required": false,
+      "settings": {
+        "type": "label_selection",
+        "options": [
+          {
+            "value": "yes",
+            "text": "yes",
+            "description": null
+          },
+          {
+            "value": "no",
+            "text": "no",
+            "description": null
+          }
+        ],
+        "visible_options": null
+      },
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.930119",
+      "updated_at": "2025-02-22T02:54:57.930119"
+    }
+  ],
+  "metadata": [
+    {
+      "id": "c1b82b5b-2174-4dbb-8bec-f32cc07a3f5d",
+      "name": "context_length",
+      "title": "Context length",
+      "settings": {
+        "type": "integer",
+        "min": null,
+        "max": null
+      },
+      "visible_for_annotators": true,
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.988296",
+      "updated_at": "2025-02-22T02:54:57.988296"
+    },
+    {
+      "id": "9b048fd5-0a24-43fc-8004-0c023dfdc10e",
+      "name": "question_length",
+      "title": "Question length",
+      "settings": {
+        "type": "integer",
+        "min": null,
+        "max": null
+      },
+      "visible_for_annotators": true,
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:58.000555",
+      "updated_at": "2025-02-22T02:54:58.000555"
+    },
+    {
+      "id": "b35b0681-c660-4b08-a267-9fca5c63410f",
+      "name": "response_length",
+      "title": "Response length",
+      "settings": {
+        "type": "integer",
+        "min": null,
+        "max": null
+      },
+      "visible_for_annotators": true,
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:58.011576",
+      "updated_at": "2025-02-22T02:54:58.011576"
+    }
+  ],
+  "vectors": [
+    {
+      "id": "0764639a-0846-4919-8893-dff9afdcd40f",
+      "name": "context_embeddings",
+      "title": "context_embeddings",
+      "dimensions": 256,
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.947200",
+      "updated_at": "2025-02-22T02:54:57.947200"
+    },
+    {
+      "id": "b10f1ef9-97d3-4cb1-b2ac-08e54da8f050",
+      "name": "question_embeddings",
+      "title": "question_embeddings",
+      "dimensions": 256,
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.961650",
+      "updated_at": "2025-02-22T02:54:57.961650"
+    },
+    {
+      "id": "07b7fc97-924e-467b-b826-2b92350edab9",
+      "name": "response_embeddings",
+      "title": "response_embeddings",
+      "dimensions": 256,
+      "dataset_id": "671aa5a0-ed35-42b6-a23d-92b423c3e299",
+      "inserted_at": "2025-02-22T02:54:57.974564",
+      "updated_at": "2025-02-22T02:54:57.974564"
+    }
+  ]
+}

.argilla/version.json

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

README.md

@@ -1,89 +1,174 @@
 ---
-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: context
-    dtype: string
-  - name: chat
-    list:
-    - name: content
-      dtype: string
-    - name: role
-      dtype: string
-  - name: positive_retrieval
-    dtype: string
-  - name: positive_reranking
-    dtype: string
-  - name: negative_retrieval
-    dtype: string
-  - name: negative_reranking
-    dtype: string
-  - name: relevant.responses
-    sequence: string
-  - name: relevant.responses.users
-    sequence: string
-  - name: relevant.responses.status
-    sequence: string
-  - name: is_response_correct.responses
-    sequence: string
-  - name: is_response_correct.responses.users
-    sequence: string
-  - name: is_response_correct.responses.status
-    sequence: string
-  - name: is_positive_retrieval_relevant.responses
-    sequence: string
-  - name: is_positive_retrieval_relevant.responses.users
-    sequence: string
-  - name: is_positive_retrieval_relevant.responses.status
-    sequence: string
-  - name: is_positive_reranking_relevant.responses
-    sequence: string
-  - name: is_positive_reranking_relevant.responses.users
-    sequence: string
-  - name: is_positive_reranking_relevant.responses.status
-    sequence: string
-  - name: is_negative_retrieval_relevant.responses
-    sequence: string
-  - name: is_negative_retrieval_relevant.responses.users
-    sequence: string
-  - name: is_negative_retrieval_relevant.responses.status
-    sequence: string
-  - name: is_negative_reranking_relevant.responses
-    sequence: string
-  - name: is_negative_reranking_relevant.responses.users
-    sequence: string
-  - name: is_negative_reranking_relevant.responses.status
-    sequence: string
-  - name: metadata.context_length
-    dtype: int64
-  - name: metadata.question_length
-    dtype: int64
-  - name: metadata.response_length
-    dtype: int64
-  - name: vector.context_embeddings
-    sequence: float64
-  - name: vector.question_embeddings
-    sequence: float64
-  - name: vector.response_embeddings
-    sequence: float64
-  splits:
-  - name: train
-    num_bytes: 83180
-    num_examples: 10
-  download_size: 98826
-  dataset_size: 83180
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+tags:
+- rlfh
+- argilla
+- human-feedback
 ---
+
+# Dataset Card for my-information-security-policy-distiset-curated
+
+
+
+
+
+
+
+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("daqc/my-information-security-policy-distiset-curated", 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("daqc/my-information-security-policy-distiset-curated")
+```
+
+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 |
+| ---------- | ----- | ---- | -------- |
+| context | Context | text | True |
+| chat | Chat | chat | True |
+| positive_retrieval | Positive retrieval | text | True |
+| positive_reranking | Positive reranking | text | True |
+| negative_retrieval | Negative retrieval | text | True |
+| negative_reranking | Negative reranking | 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 |
+| ------------- | ----- | ---- | -------- | ----------- | ------------- |
+| relevant | Are the question and response relevant to the given context? | label_selection | True | N/A | ['yes', 'no'] |
+| is_response_correct | Is the response correct? | label_selection | True | N/A | ['yes', 'no'] |
+| is_positive_retrieval_relevant | Is the positive retrieval relevant? | label_selection | False | N/A | ['yes', 'no'] |
+| is_positive_reranking_relevant | Is the positive reranking relevant? | label_selection | False | N/A | ['yes', 'no'] |
+| is_negative_retrieval_relevant | Is the negative retrieval relevant? | label_selection | False | N/A | ['yes', 'no'] |
+| is_negative_reranking_relevant | Is the negative reranking relevant? | label_selection | False | N/A | ['yes', 'no'] |
+
+
+<!-- check length of metadata properties -->
+
+### Metadata
+
+The **metadata** is a dictionary that can be used to provide additional information about the dataset record.
+| Metadata Name | Title | Type | Values | Visible for Annotators |
+| ------------- | ----- | ---- | ------ | ---------------------- |
+ | context_length | Context length | integer |  -  | True |
+ | question_length | Question length | integer |  -  | True |
+ | response_length | Response length | integer |  -  | True |
+
+
+
+
+### Vectors
+The **vectors** contain a vector representation of the record that can be used in  search.
+
+| Vector Name | Title | Dimensions |
+|-------------|-------|------------|
+| context_embeddings | context_embeddings | [1, 256] |
+| question_embeddings | question_embeddings | [1, 256] |
+| response_embeddings | response_embeddings | [1, 256] |
+
+
+
+### 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
+
+Please review the conversation and provide an evaluation.
+
+#### 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]