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, 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 参数指向包含对话的列。

训练期间的 prompt 掩码由 train_on_input 标志控制，该标志默认为 False。

如果 train_on_input 为 True，则在训练期间使用 prompt 并计入损失。
如果 train_on_input 为 False，则 prompt 会被掩码掉（token 替换为 -100）。

参数:

tokenizer (ModelTokenizer) – 模型使用的分词器，实现了 tokenize_messages 方法。
source (str) – Hugging Face 上数据集仓库的路径。对于本地数据集，将 source 定义为数据文件类型（例如“json”、“csv”、“text”），并在 data_files 中传入文件路径。有关更多详细信息，请参阅 Hugging Face 的 load_dataset。
conversation_column (str) – 包含对话的列名。
conversation_style (str) – 指定数据集中对话预期风格的字符串，用于自动转换为 Message 结构。支持的风格包括：“sharegpt”、“openai”
train_on_input (bool) – 模型是否在 prompt 上进行训练。默认为 False。
new_system_prompt (Optional[str]) – 如果指定，则在前面添加一个系统消息。这可以用作指导模型响应的指令。默认为 None。
packed (bool) – 在训练前是否将数据集打包到 max_seq_len。默认为 False。
filter_fn (Optional[Callable]) – 用于在任何预处理之前过滤数据集的可调用对象。有关更多详细信息，请参阅 Hugging Face 文档。
split (str) – datasets.load_dataset 的 split 参数。您可以使用此参数加载给定分割的子集，例如 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

返回:

配置好的 SFTDataset: 如果 packed=True，则返回 PackedDataset

返回类型:

Union[SFTDataset, PackedDataset]

抛出:

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

chat_dataset¶

文档

教程

资源