instruct_dataset

torchtune.datasets.instruct_dataset(tokenizer: ModelTokenizer, *, source: str, column_map: Optional[Dict[str, str]] = None, 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]

配置包含用户指令提示和模型响应的自定义数据集。

此构建器函数可用于直接从 yaml 配置配置自定义指令数据集，作为 SFTDataset 的替代方案，因为它更易于配置。

数据集应遵循此格式

|  input          |  output          |
|-----------------|------------------|
| "user prompt"   | "model response" |

如果您的列名不同，您可以使用 column_map 参数更改预期的列名。例如，如果您的数据集有列 "question" 和 "answer"，您可以使用

column_map = {"input": "question", "output": "answer"}

训练期间提示的掩码由 train_on_input 标志控制，该标志默认为 False： - 如果 train_on_input 为 True，则提示在训练期间使用并计入损失。 - 如果 train_on_input 为 False，则提示被掩码（令牌替换为 -100）

参数：

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

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

• column_map (Optional[Dict[str, str]]) – 用于将预期的“input”和“output”列名更改为数据集中实际列名的映射。键应为“input”和“output”，值应为实际列名。默认为 None，保留默认的“input”和“output”列名。

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

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

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

• filter_fn (Optional[Callable]) – 用于在任何预处理之前过滤数据集的可调用对象。有关更多详细信息，请参阅 Hugging Face 文档。

• split (str) – split 参数用于 datasets.load_dataset。您可以使用此参数加载给定 split 的子集，例如 split="train[:10%]"。默认为“train”。

• **load_dataset_kwargs (Dict[str, Any]) – 传递给 load_dataset 的其他关键字参数，例如 data_files 或 split。

示例

my_dataset.json
[
    {
        "question": "What time is it in London?",
        "answer": "It is 10:00 AM in London.",
    },
    {
        ...
    },
    ...,
]

>>> from torchtune.datasets import instruct_dataset
>>> dataset = instruct_dataset(
...     tokenizer=tokenizer,
...     source="json",
...     data_files="my_dataset.json",
...     column_map={
...         "input": "question",
...         "output": "answer",
...     },
...     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.instruct_dataset
  source: json
  data_files: my_dataset.json
  column_map:
    input: question
    output: answer
  train_on_input: False
  packed: False
  split: train

返回：

配置好的 SFTDataset

如果 packed=True，则返回 PackedDataset

返回类型：

Union[SFTDataset, PackedDataset]

抛出：

ValueError – 如果 packed=True 且 tokenizer.max_seq_len 未设置。