聊天数据集¶

torchtune.datasets.chat_dataset(tokenizer: ModelTokenizer, *, source: str, conversation_column: str, conversation_style: str, train_on_input: bool = False, new_system_prompt: Optional[str] = None, packed: bool = False, filter_fn: Optional[Callable] = None, split: str = 'train', **load_dataset_kwargs: Dict[str, Any]) → Union[SFTDataset, PackedDataset][source]¶

配置一个自定义数据集，包含用户和模型助手之间的对话。

此构建器函数可用于直接从yaml配置中配置自定义聊天数据集，作为SFTDataset的替代方案，因为它旨在便于配置。

数据集应包含一个包含对话的单一列：

|  conversations                         |
|----------------------------------------|
| [{"role": "user", "content": Q1},      |
|  {"role": "assistant", "content": A1}] |

这将转换为：

messages = [
    Message(role="user", content="Q1"),
    Message(role="assistant", content="A1"),
]

然后，这个消息列表会被分词用于模型训练。

您的对话结构可能有所不同，例如不同的角色名称或json结构中的不同键。您可以使用conversation_style参数从标准格式中选择，例如“sharegpt”（参见ShareGPTToMessages）或“openai”（参见OpenAIToMessages）。如果您的数据集不是这些格式之一，我们建议创建一个自定义消息转换，并在类似于chat_dataset的自定义数据集构建器函数中使用它。

如果你的列名不同，使用conversation_column参数指向包含对话的列。

在训练期间，提示的掩码由train_on_input标志控制，该标志默认设置为False。

如果 train_on_input 为 True，提示将在训练期间使用，并影响损失。
如果 train_on_input 为 False，则提示被屏蔽（标记替换为 -100）。

Parameters:

tokenizer (ModelTokenizer) – 模型使用的分词器，实现了tokenize_messages方法。
source (str) – Hugging Face 上数据集仓库的路径。对于本地数据集，将 source 定义为数据文件类型（例如“json”、“csv”、“text”），在 data_files 中传入文件路径。有关更多详细信息，请参阅 Hugging Face’s load_dataset。
conversation_column (str) – 包含对话的列的名称。
conversation_style (str) – 字符串，指定数据集中对话的预期风格，以便自动转换为消息结构。支持的风格有：“sharegpt”、“openai”
train_on_input (bool) – 模型是否在提示上进行训练。默认值为 False。
new_system_prompt (可选[str]) – 如果指定，将预置一条系统消息。这可以作为指导模型响应的指令。默认值为 None。
packed (bool) – 是否在训练前将数据集打包到max_seq_len。默认值为False。
filter_fn (可选[Callable]) – 用于在预处理之前过滤数据集的可调用对象。有关更多详细信息，请参阅Hugging Face的文档。
split (str) – split 参数用于 datasets.load_dataset。您可以使用此参数加载给定拆分的子集，例如 split="train[:10%]"。默认值为“train”。
**load_dataset_kwargs (Dict[str, Any]) – 传递给 load_dataset 的额外关键字参数，例如 data_files 或 split。

示例：

my_dataset.json
[
    {
        "conversations": [
            {
                "from": "human",
                "value": "What time is it in London?",
            },
            {
                "from": "gpt",
                "value": "It is 10:00 AM in London.",
            },
        ],
    },
    {
        "conversations": [
            ...
        ],
    },
    ...,
]

>>> from torchtune.datasets import chat_dataset
>>> dataset = chat_dataset(
...     tokenizer=tokenizer,
...     source="json",
...     data_files="my_dataset.json",
...     conversation_column="conversations",
...     conversation_style="sharegpt",
...     train_on_input=False,
...     packed=False,
...     split="train",
... )
>>> tokens = dataset[0]["tokens"]
>>> tokenizer.decode(tokens)
"What time is it in London?It is 10:00 AM in London."

这也可以通过yaml配置来完成：

dataset:
  _component_: torchtune.datasets.chat_dataset
  source: json
  data_files: my_dataset.json
  conversation_column: conversations
  conversation_style: sharegpt
  train_on_input: False
  packed: False
  split: train

Returns:

配置的 SFTDataset: 或 PackedDataset 如果 packed=True

Return type:

联合[SFTDataset, PackedDataset]

Raises:

ValueError – 如果对话格式不受支持