chat_dataset

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, **load_dataset_kwargs: Dict[str, Any]) → Union[SFTDataset, PackedDataset]

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

此构建器函数可用于直接从 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）。

参数：

• tokenizer (ModelTokenizer) – 模型使用的分词器，它实现了 tokenize_messages 方法。

• source (str) – Hugging Face 上数据集存储库的路径。对于本地数据集，将源定义为数据文件类型（例如“json”、“csv”、“text”），在 data_files 中传入文件路径，并设置 split="train"。有关更多详细信息，请参见 Hugging Face 的 load_dataset。

• conversation_column (str) – 包含对话的列的名称。

• conversation_style (str) – 指定数据集中对话预期样式的字符串，用于自动转换为 Message 结构。支持的样式包括：“sharegpt”、“openai”

• train_on_input (bool) – 模型是否在提示上进行训练。默认为 False。

• new_system_prompt (Optional[str]) – 如果指定，则添加系统消息。这可以作为指导模型响应的说明。默认为 None。

• packed (bool) – 是否在训练前将数据集打包到 max_seq_len。默认为 False。

• **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

返回:

配置好的 SFTDataset

或 PackedDataset 如果 packed=True

返回类型:

Union[SFTDataset, PackedDataset]

引发:

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