MPEP_FILIPINO

# Dataset Card for MPEP_FILIPINO

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.yaml`. 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("DIBT/MPEP_FILIPINO")
```

### 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("DIBT/MPEP_FILIPINO")
```

### Supported Tasks and Leaderboards

This dataset can contain [multiple fields, questions and responses](https://docs.argilla.io/en/latest/conceptual_guides/data_model.html#feedback-dataset) 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**, **suggestions**, **metadata**, **vectors**, and **guidelines**.

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

| Field Name | Title | Type | Required | Markdown |
| ---------- | ----- | ---- | -------- | -------- |
| source | Source | text | True | True |

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 |
| ------------- | ----- | ---- | -------- | ----------- | ------------- |
| target | Target | text | True | Translate the text. | N/A |

The **suggestions** are human or machine generated recommendations for each question to assist the annotator during the annotation process, so those are always linked to the existing questions, and named appending "-suggestion" and "-suggestion-metadata" to those, containing the value/s of the suggestion and its metadata, respectively. So on, the possible values are the same as in the table above, but the column name is appended with "-suggestion" and the metadata is appended with "-suggestion-metadata".

The **metadata** is a dictionary that can be used to provide additional information about the dataset record. This can be useful to provide additional context to the annotators, or to provide additional information about the dataset record itself. For example, you can use this to provide a link to the original source of the dataset record, or to provide additional information about the dataset record itself, such as the author, the date, or the source. The metadata is always optional, and can be potentially linked to the `metadata_properties` defined in the dataset configuration file in `argilla.yaml`.

| Metadata Name | Title | Type | Values | Visible for Annotators |
| ------------- | ----- | ---- | ------ | ---------------------- |

The **guidelines**, are optional as well, and 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": "1752",
"fields": {
"source": "what role does a pass transistor and an op amp play in a regulator"
},
"metadata": {
"evolved_from": null,
"kind": "human",
"source": "ewof/sharegpt-instruct-unfiltered-deduped"
},
"responses": [
{
"status": "submitted",
"user_id": "7a0edea3-6cb5-44c9-8ecf-fdf7935cf064",
"values": {
"target": {
"value": "ano ang papel na ginagampanan ng pass transistor at op amp sa isang regulator"
}
}
}
],
"suggestions": [
{
"agent": null,
"question_name": "target",
"score": null,
"type": null,
"value": "Ano ang papel na ginagampanan ng isang pass transistor at op amp sa isang regulator\n\nAng papel ng isang pass transistor sa isang regulator ay upang i-regulate ang output voltage at kung minsan ay ginagamit upang mabawasan ang load ng regulator. Nagbibigay ito ng malalaking daloy ng kuryente na kinakailangan upang mapanatili ang steady output kahit na ang input o ang load ay nagbabago.\n\nSa kabilang banda, ang isang operational amplifier o op amp ay isang uri ng amplifier na maaaring mag-adjust at mag-control ng voltage sa isang circuit. Ginagamit ito sa isang regulator upang mai-maintain ang tamang kahalumigmigan sa loob ng system habang sinisiguro na ang mga komponitente ay hindi mahalata ng sobrang init o lamig. Bukod dito, ginagamit din ito upang mabawasan ang distorsyon at nagsisilbi rin bilang isang voltage follower."
}
],
"vectors": {}
}
```

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

```json
{
"external_id": "1752",
"metadata": "{\"evolved_from\": null, \"kind\": \"human\", \"source\": \"ewof/sharegpt-instruct-unfiltered-deduped\"}",
"source": "what role does a pass transistor and an op amp play in a regulator",
"target": [
{
"status": "submitted",
"user_id": "7a0edea3-6cb5-44c9-8ecf-fdf7935cf064",
"value": "ano ang papel na ginagampanan ng pass transistor at op amp sa isang regulator"
}
],
"target-suggestion": "Ano ang papel na ginagampanan ng isang pass transistor at op amp sa isang regulator\n\nAng papel ng isang pass transistor sa isang regulator ay upang i-regulate ang output voltage at kung minsan ay ginagamit upang mabawasan ang load ng regulator. Nagbibigay ito ng malalaking daloy ng kuryente na kinakailangan upang mapanatili ang steady output kahit na ang input o ang load ay nagbabago.\n\nSa kabilang banda, ang isang operational amplifier o op amp ay isang uri ng amplifier na maaaring mag-adjust at mag-control ng voltage sa isang circuit. Ginagamit ito sa isang regulator upang mai-maintain ang tamang kahalumigmigan sa loob ng system habang sinisiguro na ang mga komponitente ay hindi mahalata ng sobrang init o lamig. Bukod dito, ginagamit din ito upang mabawasan ang distorsyon at nagsisilbi rin bilang isang voltage follower.",
"target-suggestion-metadata": {
"agent": null,
"score": null,
"type": null
}
}
```

### 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 supported. These are the ones that will be used to provide responses to the questions.

* **source** is of type `text`.

* **Questions:** These are the questions that will be asked to the annotators. They can be of different types, such as `RatingQuestion`, `TextQuestion`, `LabelQuestion`, `MultiLabelQuestion`, and `RankingQuestion`.

* **target** is of type `text`, and description "Translate the text.".

* **Suggestions:** As of Argilla 1.13.0, the suggestions have been included to provide the annotators with suggestions to ease or assist during the annotation process. Suggestions are linked to the existing questions, are always optional, and contain not just the suggestion itself, but also the metadata linked to it, if applicable.

* (optional) **target-suggestion** is of type `text`.

Additionally, we also have two more fields that are optional and are the following:

* **metadata:** This is an optional field that can be used to provide additional information about the dataset record. This can be useful to provide additional context to the annotators, or to provide additional information about the dataset record itself. For example, you can use this to provide a link to the original source of the dataset record, or to provide additional information about the dataset record itself, such as the author, the date, or the source. The metadata is always optional, and can be potentially linked to the `metadata_properties` defined in the dataset configuration file in `argilla.yaml`.
* **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

This is a translation dataset that contains texts. Please translate the text in the text field.

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

# 数据集卡片：MPEP_FILIPINO

本数据集基于[Argilla](https://docs.argilla.io)构建。

如下章节所述，本数据集既可按照[通过Argilla加载](#load-with-argilla)的说明导入Argilla，也可通过`datasets`库直接使用，详见[通过`datasets`加载](#load-with-datasets)。

## 数据集描述
- **主页：** https://argilla.io
- **代码仓库：** https://github.com/argilla-io/argilla
- **论文：**
- **排行榜：**
- **联系人：**

### 数据集概述
本数据集包含以下内容：
* 符合Argilla数据集格式的配置文件`argilla.yaml`。当在Argilla中使用`FeedbackDataset.from_huggingface`方法时，将使用该配置文件完成数据集的配置。
* 兼容HuggingFace `datasets`格式的数据集记录。当使用`FeedbackDataset.from_huggingface`时，这些记录会自动加载；也可通过`datasets`库调用`load_dataset`独立加载。
* 若在Argilla中已定义，则包含用于构建和整理数据集的[标注指南](#annotation-guidelines)。

## 加载方式
### 通过Argilla加载
若要通过Argilla加载该数据集，只需执行`pip install argilla --upgrade`安装并升级Argilla，随后运行以下代码：
python
import argilla as rg

ds = rg.FeedbackDataset.from_huggingface("DIBT/MPEP_FILIPINO")

### 通过`datasets`库加载
若要通过`datasets`库加载该数据集，只需执行`pip install datasets --upgrade`安装并升级`datasets`库，随后运行以下代码：
python
from datasets import load_dataset

ds = load_dataset("DIBT/MPEP_FILIPINO")

### 支持任务与排行榜
本数据集包含[多个字段、问题与回复](https://docs.argilla.io/en/latest/conceptual_guides/data_model.html#feedback-dataset)，因此可根据配置用于多种自然语言处理任务。数据集结构详见[数据集结构](#dataset-structure)章节。本数据集暂无关联的排行榜。

### 语言
[需补充更多信息]

## 数据集结构
### Argilla格式数据
本数据集在Argilla中包含以下组件：**字段（fields）**、**问题（questions）**、**建议（suggestions）**、**元数据（metadata）**、**向量（vectors）**及**指南（guidelines）**。

**字段（fields）** 即数据集记录本身，目前仅支持文本字段，用于接收针对问题的回复。

| 字段名 | 标题 | 类型 | 必填 | 支持Markdown |
| ---------- | ----- | ---- | -------- | -------- |
| source | Source | text | True | True |

**问题（questions）** 是向标注人员提出的查询，支持多种类型，包括评分（rating）、文本（text）、标签选择（label_selection）、多标签选择（multi_label_selection）及排序（ranking）。

| 问题名 | 标题 | 类型 | 必填 | 描述 | 取值/标签 |
| ------------- | ----- | ---- | -------- | ----------- | ------------- |
| target | Target | text | True | 翻译该文本。 | N/A |

**建议（suggestions）** 是为辅助标注人员完成标注流程而生成的人工或机器推荐结果，始终与现有问题关联，命名时会分别追加“-suggestion”和“-suggestion-metadata”后缀，分别存储建议内容及其元数据。其可能的取值与上表一致，但列名需追加“-suggestion”后缀，元数据则追加“-suggestion-metadata”后缀。

**元数据（metadata）** 是用于存储数据集记录额外信息的字典，可为标注人员提供额外上下文，或为数据集记录本身补充信息，例如提供数据集记录的原始来源链接、作者、日期或来源渠道等。元数据为可选字段，可与`argilla.yaml`中数据集配置文件定义的`metadata_properties`关联。

| 元数据名称 | 标题 | 类型 | 取值 | 对标注人员可见 |
| ------------- | ----- | ---- | ------ | ---------------------- |

**指南（guidelines）** 同样为可选字段，是用于向标注人员提供说明的纯文本字符串，详见[标注指南](#annotation-guidelines)章节。

### 数据实例
Argilla格式的数据集示例如下所示：
json
{
"external_id": "1752",
"fields": {
"source": "what role does a pass transistor and an op amp play in a regulator"
},
"metadata": {
"evolved_from": null,
"kind": "human",
"source": "ewof/sharegpt-instruct-unfiltered-deduped"
},
"responses": [
{
"status": "submitted",
"user_id": "7a0edea3-6cb5-44c9-8ecf-fdf7935cf064",
"values": {
"target": {
"value": "ano ang papel na ginagampanan ng pass transistor at op amp sa isang regulator"
}
}
}
],
"suggestions": [
{
"agent": null,
"question_name": "target",
"score": null,
"type": null,
"value": "Ano ang papel na ginagampanan ng isang pass transistor at op amp sa isang regulator

Ang papel ng isang pass transistor sa isang regulator ay upang i-regulate ang output voltage at kung minsan ay ginagamit upang mabawasan ang load ng regulator. Nagbibigay ito ng malalaking daloy ng kuryente na kinakailangan upang mapanatili ang steady output kahit na ang input o ang load ay nagbabago.

Sa kabilang banda, ang isang operational amplifier o op amp ay isang uri ng amplifier na maaaring mag-adjust at mag-control ng voltage sa isang circuit. Ginagamit ito sa isang regulator upang mai-maintain ang tamang kahalumigmigan sa loob ng system habang sinisiguro na ang mga komponitente ay hindi mahalata ng sobrang init o lamig. Bukod dito, ginagamit din ito upang mabawasan ang distorsyon at nagsisilbi rin bilang isang voltage follower."
}
],
"vectors": {}
}

而HuggingFace `datasets`格式的同一条记录如下：
json
{
"external_id": "1752",
"metadata": "{"evolved_from": null, "kind": "human", "source": "ewof/sharegpt-instruct-unfiltered-deduped"}",
"source": "what role does a pass transistor and an op amp play in a regulator",
"target": [
{
"status": "submitted",
"user_id": "7a0edea3-6cb5-44c9-8ecf-fdf7935cf064",
"value": "ano ang papel na ginagampanan ng pass transistor at op amp sa isang regulator"
}
],
"target-suggestion": "Ano ang papel na ginagampanan ng isang pass transistor at op amp sa isang regulator

Ang papel ng isang pass transistor sa isang regulator ay upang i-regulate ang output voltage at kung minsan ay ginagamit upang mabawasan ang load ng regulator. Nagbibigay ito ng malalaking daloy ng kuryente na kinakailangan upang mapanatili ang steady output kahit na ang input o ang load ay nagbabago.

Sa kabilang banda, ang isang operational amplifier o op amp ay isang uri ng amplifier na maaaring mag-adjust at mag-control ng voltage sa isang circuit. Ginagamit ito sa isang regulator upang mai-maintain ang tamang kahalumigmigan sa loob ng system habang sinisiguro na ang mga komponitente ay tidak mahalata ng sobrang init o lamig. Bukod dito, ginagamit din ito upang mabawasan ang distorsyon at nagsisilbi rin bilang isang voltage follower.",
"target-suggestion-metadata": {
"agent": null,
"score": null,
"type": null
}
}

### 数据字段
在数据集字段中，我们可分为以下几类：
* **字段（fields）**：即数据集记录本身，目前仅支持文本字段，用于接收针对问题的回复。
* **source** 为文本类型（`text`）。
* **问题（questions）**：向标注人员提出的查询，支持`RatingQuestion`、`TextQuestion`、`LabelQuestion`、`MultiLabelQuestion`及`RankingQuestion`等类型。
* **target** 为文本类型（`text`），描述为“翻译该文本。”。
* **建议（suggestions）**：自Argilla 1.13.0版本起，新增建议组件以辅助标注人员完成标注流程。建议与现有问题关联，为可选字段，不仅包含建议内容本身，还可附带关联的元数据（若有）。
* （可选）**target-suggestion** 为文本类型（`text`）。

此外，本数据集还包含两个可选字段：
* **元数据（metadata）**：可选字段，用于为数据集记录补充额外信息，可为标注人员提供上下文，或为记录本身补充作者、日期、来源等信息。元数据可与`argilla.yaml`配置文件中定义的`metadata_properties`关联。
* **external_id**：可选字段，用于为数据集记录分配外部ID，便于将数据集记录与外部资源（如数据库或文件）关联。

### 数据拆分
本数据集仅包含一个拆分，即`train`（训练集）。

## 数据集创建
### 数据集构建依据
[需补充更多信息]

### 源数据
#### 初始数据收集与标准化
[需补充更多信息]
#### 源语言生产者是谁？
[需补充更多信息]

### 标注
#### 标注指南
本数据集为翻译数据集，包含文本内容，请翻译文本字段中的文本。

#### 标注流程
[需补充更多信息]
#### 标注人员是谁？
[需补充更多信息]

### 个人与敏感信息
[需补充更多信息]

## 数据使用注意事项
### 数据集的社会影响
[需补充更多信息]
### 偏差讨论
[需补充更多信息]
### 其他已知局限性
[需补充更多信息]

## 附加信息
### 数据集整理者
[需补充更多信息]
### 许可信息
[需补充更多信息]
### 引用信息
[需补充更多信息]
### 贡献
[需补充更多信息]