# Утилиты данных

## is_conversational[[trl.is_conversational]]

#### trl.is_conversational[[trl.is_conversational]]

```python
trl.is_conversational(example: dict[str, typing.Any])
```

[Источник](https://github.com/huggingface/trl/blob/v1.18.1/trl/data_utils.py#L126)

**Параметры:**

example (`dict[str, Any]`) : Одна запись данных набора данных. Пример может содержать разные ключи в зависимости от типа набора данных.

**Возвращает:** `bool`

`True`, если данные представлены в формате диалога, `False` в противном случае.

Проверьте, находится ли пример в диалоговом формате.

Примеры:

```python
>>> example = {"prompt": [{"role": "user", "content": "What color is the sky?"}]}
>>> is_conversational(example)
True

>>> example = {"prompt": "The sky is"}
>>> is_conversational(example)
False
```

## maybe_convert_to_chatml[[trl.maybe_convert_to_chatml]]

#### trl.maybe_convert_to_chatml[[trl.maybe_convert_to_chatml]]

```python
trl.maybe_convert_to_chatml(example: dict[str, list])
```

[Источник](https://github.com/huggingface/trl/blob/v1.18.1/trl/data_utils.py#L967)

**Параметры:**

example (`dict[str, list]`) : Одна запись данных, содержащая список сообщений.

**Возвращает:** `dict[str, list]`

Пример, отформатированный в стиле ChatML.

Преобразование диалогового набора данных с полями `from` и `value` в формат ChatML.

Эта функция изменяет данные диалога для приведения их к формату ChatML от OpenAI:
- Заменяет ключ `"from"` на `"role"` в словарях сообщений.
- Заменяет ключ `"value"` на `"content"` в словарях сообщений.
- Переименовывает `"conversations"` в `"messages"` для согласованности с ChatML.

Пример:
```python
>>> from trl import maybe_convert_to_chatml

>>> example = {
...     "conversations": [
...         {"from": "user", "value": "What color is the sky?"},
...         {"from": "assistant", "value": "It is blue."},
...     ]
... }
>>> maybe_convert_to_chatml(example)
{'messages': [{'role': 'user', 'content': 'What color is the sky?'},
              {'role': 'assistant', 'content': 'It is blue.'}]}
```

## extract_prompt[[trl.extract_prompt]]

#### trl.extract_prompt[[trl.extract_prompt]]

```python
trl.extract_prompt(example: dict[str, collections.abc.Sequence])
```

[Источник](https://github.com/huggingface/trl/blob/v1.18.1/trl/data_utils.py#L548)

**Параметры:**

example (`dict[str, list]`) : Словарь, представляющий одну запись данных в наборе данных предпочтений. Он должен содержать ключи `"chosen"` и `"rejected"`, где каждое значение является либо диалоговым, либо стандартным (`str`).

**Возвращает:** `dict[str, list]`

Словарь, содержащий:
- `"prompt"`: самый длинный общий префикс между завершениями "chosen" и "rejected".
- `"chosen"`: Остальная часть завершения "chosen", с удалённым промптом.
- `"rejected"`: Остальная часть завершения "rejected", с удалённым промптом.

Извлекает общий промпт из примера данных предпочтений, где промпт неявно содержится в обоих вариантах завершения — выбранном и отклонённом.

Функция определяет самую длинную общую последовательность (префикс) ходов диалога между завершениями «chosen» и «rejected» и извлекает её в качестве промпта. Затем она удаляет этот промпт из соответствующих завершений «chosen» и «rejected».

Примеры:

```python
>>> example = {
...     "chosen": [
...         {"role": "user", "content": "What color is the sky?"},
...         {"role": "assistant", "content": "It is blue."},
...     ],
...     "rejected": [
...         {"role": "user", "content": "What color is the sky?"},
...         {"role": "assistant", "content": "It is green."},
...     ],
... }
>>> extract_prompt(example)
{'prompt': [{'role': 'user', 'content': 'What color is the sky?'}],
 'chosen': [{'role': 'assistant', 'content': 'It is blue.'}],
 'rejected': [{'role': 'assistant', 'content': 'It is green.'}]}
```

Или с помощью метода `map` класса [Dataset](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.Dataset):

```python
>>> from trl import extract_prompt
>>> from datasets import Dataset

>>> dataset_dict = {
...     "chosen": [
...         [
...             {"role": "user", "content": "What color is the sky?"},
...             {"role": "assistant", "content": "It is blue."},
...         ],
...         [
...             {"role": "user", "content": "Where is the sun?"},
...             {"role": "assistant", "content": "In the sky."},
...         ],
...     ],
...     "rejected": [
...         [
...             {"role": "user", "content": "What color is the sky?"},
...             {"role": "assistant", "content": "It is green."},
...         ],
...         [
...             {"role": "user", "content": "Where is the sun?"},
...             {"role": "assistant", "content": "In the sea."},
...         ],
...     ],
... }
>>> dataset = Dataset.from_dict(dataset_dict)
>>> dataset = dataset.map(extract_prompt)
>>> dataset[0]
{'prompt': [{'role': 'user', 'content': 'What color is the sky?'}],
 'chosen': [{'role': 'assistant', 'content': 'It is blue.'}],
 'rejected': [{'role': 'assistant', 'content': 'It is green.'}]}
```

## unpair_preference_dataset[[trl.unpair_preference_dataset]]

#### trl.unpair_preference_dataset[[trl.unpair_preference_dataset]]

```python
trl.unpair_preference_dataset(dataset: typing.Union[~DatasetType, ~IterableDatasetType], **map_kwargs)
```

[Источник](https://github.com/huggingface/trl/blob/v1.18.1/trl/data_utils.py#L445)

**Параметры:**

dataset ([Dataset](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.Dataset) или [DatasetDict](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.DatasetDict) или [IterableDataset](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.IterableDataset) или [IterableDatasetDict](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.IterableDatasetDict)) : набор данных предпочтений для разделения на пары. Набор данных должен содержать столбцы `"chosen"`, `"rejected"` и, при необходимости, `"prompt"`.

- ****map_kwargs** (`dict`, *необязательный*) : Дополнительные именованные аргументы, передаваемые в метод map набора данных при разделении предпочтений.

**Возвращает:**

[Dataset](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.Dataset) или [DatasetDict](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.DatasetDict) или [IterableDataset](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.IterableDataset) или [IterableDatasetDict](https://huggingface.co/docs/datasets/v5.2.0/en/package_reference/main_classes#datasets.IterableDatasetDict): набор данных с непарными предпочтениями.

Разделить набор данных предпочтений.

Вывод содержит `"prompt"`, `"completion"` и `"label"`, а также любые дополнительные столбцы, которые дублируются для каждой выбранной и отклонённой строки.

Пример:

```python
>>> from datasets import Dataset

>>> dataset_dict = {
...     "prompt": ["The sky is", "The sun is"],
...     "chosen": [" blue.", "in the sky."],
...     "rejected": [" green.", " in the sea."],
... }
>>> dataset = Dataset.from_dict(dataset_dict)
>>> dataset = unpair_preference_dataset(dataset)
>>> dataset
Dataset({
    features: ['prompt', 'completion', 'label'],
    num_rows: 4
})

>>> dataset[0]
{'prompt': 'The sky is', 'completion': ' blue.', 'label': True}
```

