size_categories:n<1K rlfh argilla human-feedback region:us
---
size_categories: n<1K
tags:
- rlfh
- argilla
- human-feedback
---

# Dataset Card for new_questions

This dataset has been created with [Argilla](https://docs.argilla.io).

As shown in the sections below, this dataset can be loaded into Argilla as explained in [Load with Argilla](#load-with-argilla), or used directly with the `datasets` library in [Load with `datasets`](#load-with-datasets).

## Dataset Description

- **Homepage:** https://argilla.io
- **Repository:** https://github.com/argilla-io/argilla
- **Paper:** 
- **Leaderboard:** 
- **Point of Contact:** 

### Dataset Summary

This dataset contains:

* A dataset configuration file conforming to the Argilla dataset format named `argilla.cfg`. This configuration file will be used to configure the dataset when using the `FeedbackDataset.from_huggingface` method in Argilla.

* Dataset records in a format compatible with HuggingFace `datasets`. These records will be loaded automatically when using `FeedbackDataset.from_huggingface` 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.

### Load 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.FeedbackDataset.from_huggingface("frank098/new_questions")
```

### Load with `datasets`

To load 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("frank098/new_questions")
```

### Supported Tasks and Leaderboards

This dataset can contain [multiple fields, questions and responses](https://docs.argilla.io/en/latest/guides/llms/conceptual_guides/data_model.html) so it can be used for different NLP tasks, depending on the configuration. The dataset structure is described in the [Dataset Structure section](#dataset-structure).

There are no leaderboards associated with this dataset.

### Languages

[More Information Needed]

## Dataset Structure

### Data in Argilla

The dataset is created in Argilla with: **fields**, **questions**, and **guidelines**.

The **fields** are the dataset records themselves, for the moment just text fields are suppported. These are the ones that will be used to provide responses to the questions.

| Field Name | Title | Type | Required | Markdown |
| ---------- | ----- | ---- | -------- | -------- |
| category | Task category | TextField | True | False |
| context | Context | TextField | True | False |
| template_1 | Template 1 | TextField | True | False |
| example_1 | Example | TextField | True | False |
| template_2 | Template 2 | TextField | True | False |
| example_2 | Example | TextField | True | False |


The **questions** are the questions that will be asked to the annotators. They can be of different types, such as rating, text, single choice, or multiple choice.

| Question Name | Title | Type | Required | Description | Values/Labels |
| ------------- | ----- | ---- | -------- | ----------- | ------------- |
| new-instruction | First instruction | TextQuestion | True | Write the final version of the instruction, making sure that it matches the task category. If the original instruction is ok, copy and paste it here. |  N/A  |
| new-input | Second instruction: | TextQuestion | True | Write the final version of the input, making sure that it makes sense with the task category. If the original input is ok, copy and paste it here. If an input is not needed, leave this empty. |  N/A  |


Finally, the **guidelines** are just a plain string that can be used to provide instructions to the annotators. Find those in the [annotation guidelines](#annotation-guidelines) section.

### Data Instances

An example of a dataset instance in Argilla looks as follows:

```json
{
    "external_id": null,
    "fields": {
        "category": "Closed questions",
        "context": "Closed questions are designed to elicit a specific yes or no answer. They are used to gather factual information or confirm specific attributes or actions related to the topic.",
        "example_1": "Is JunOS compatible with Juniper Routers?",
        "example_2": "Does JunOS support MPLS (Multiprotocol Label Switching) technology?",
        "template_1": "Is [topic] [attribute]?",
        "template_2": "Does [subject] [action] [object]?"
    },
    "metadata": null,
    "responses": [
        {
            "status": "submitted",
            "user_id": "7a7c4dd3-769c-4a22-9658-581e4aee3577",
            "values": {
                "new-input": {
                    "value": "Hello?"
                },
                "new-instruction": {
                    "value": "Hello?"
                }
            }
        }
    ]
}
```

While the same record in HuggingFace `datasets` looks as follows:

```json
{
    "category": "Closed questions",
    "context": "Closed questions are designed to elicit a specific yes or no answer. They are used to gather factual information or confirm specific attributes or actions related to the topic.",
    "example_1": "Is JunOS compatible with Juniper Routers?",
    "example_2": "Does JunOS support MPLS (Multiprotocol Label Switching) technology?",
    "external_id": null,
    "metadata": null,
    "new-input": {
        "status": [
            "submitted"
        ],
        "user_id": [
            "7a7c4dd3-769c-4a22-9658-581e4aee3577"
        ],
        "value": [
            "Hello?"
        ]
    },
    "new-instruction": {
        "status": [
            "submitted"
        ],
        "user_id": [
            "7a7c4dd3-769c-4a22-9658-581e4aee3577"
        ],
        "value": [
            "Hello?"
        ]
    },
    "template_1": "Is [topic] [attribute]?",
    "template_2": "Does [subject] [action] [object]?"
}
```

### Data Fields

Among the dataset fields, we differentiate between the following:

* **Fields:** These are the dataset records themselves, for the moment just text fields are suppported. These are the ones that will be used to provide responses to the questions.
    
    * **category** is of type `TextField`.
    * **context** is of type `TextField`.
    * **template_1** is of type `TextField`.
    * **example_1** is of type `TextField`.
    * **template_2** is of type `TextField`.
    * **example_2** is of type `TextField`.

* **Questions:** These are the questions that will be asked to the annotators. They can be of different types, such as rating, text, single choice, or multiple choice.
    
    * **new-instruction** is of type `TextQuestion`, and description "Write the final version of the instruction, making sure that it matches the task category. If the original instruction is ok, copy and paste it here.".
    * **new-input** is of type `TextQuestion`, and description "Write the final version of the input, making sure that it makes sense with the task category. If the original input is ok, copy and paste it here. If an input is not needed, leave this empty.".

Additionally, we also have one more field which is optional and is the following:

* **external_id:** This is an optional field that can be used to provide an external ID for the dataset record. This can be useful if you want to link the dataset record to an external resource, such as a database or a file.

### 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

To create a varied range of questions, we collect 14 distinct question types. For each question, we create 2 example templates and provide an example for each template. Your task is to generate 2 fresh instructions that can be used with the given templates. If you come up with different ideas, feel free to deviate from the templates. Once you have generated both questions, click submit.

#### 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]