vqa_dataset¶

torchtune.datasets.multimodal.vqa_dataset(model_transform: 转换, *, source: str, image_dir: str = None, column_map: Optional[Dict[str, str]] = None, new_system_prompt: Optional[str] = None, packed: bool = False, filter_fn: Optional[Callable] = None, split: str = 'train', **load_dataset_kwargs: Dict[str, Any]) → SFTDataset[source]¶

配置一个自定义的视觉问答数据集，其中包含用户问题、图像和模型响应的单独列。

此构建函数可用于直接从yaml配置中配置自定义视觉问答数据集，作为SFTDataset的替代方案，因为它旨在易于配置。

数据集应遵循以下格式：

|  input          |  image          |  output          |
|-----------------|-----------------|------------------|
| "user prompt"   | images/1.jpg    | "model response" |

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

column_map = {“input”: “question”, “output”: “answer”, “image”: “picture”}

Parameters:

model_transform (Transform) – 可调用对象，用于对样本应用模型特定的预处理。这包括标记化和任何特定模态的转换。预计至少返回"tokens"和"mask"键。
source (str) – Hugging Face 上数据集仓库的路径。对于本地数据集，将 source 定义为数据文件类型（例如“json”、“csv”、“text”），在 data_files 中传入文件路径，并设置 split="train"。有关更多详细信息，请参阅 Hugging Face 的 load_dataset。
image_dir (str) – 包含数据集中所有图像路径的目录路径。例如，如果 image_dir="/home/user/dataset/"` 并且样本图像路径是 ``"images/1.jpg"，那么最终加载的图像路径将是 "/home/user/dataset/images/1.jpg"。如果为 None，则假定图像在当前工作目录中可用或位于远程 URL 上。对于纯文本，请保留为 None。默认值为 None。
column_map (可选[字典[str, str]]) – 用于将预期的“input”、“output”和“image”列名更改为数据集中实际的列名。键应为“input”、“output”和“image”，值应为实际的列名。默认值为None，保持默认的“input”、“output”和“image”列名。
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
[
    {
        "question": "What is presented on the image?",
        "answer": "PyTorch logo.",
        "picture": "rgb_pytorch.png"
    },
    {
        ...
    },
    ...,
]

>>> from torchtune.datasets.multimodal import vqa_dataset
>>> dataset = vqa_dataset(
...     model_transform=model_transform,
...     source="json",
...     data_files="my_dataset.json",
...     column_map={
...         "input": "question",
...         "output": "answer",
...         "image": "picture"
...     },
...     split="train",
... )
>>> tokens = dataset[0]["tokens"]
>>> model_transform.decode(tokens)
"What is presented on the image?PyTorch logo."

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

dataset:
  _component_: torchtune.datasets.multimodal.vqa_dataset
  source: json
  data_files: my_dataset.json
  column_map:
    input: question
    output: answer
    image: picture
  split: train

Returns:: 配置的 SFTDataset
Return type:: SFTDataset
Raises:: ValueError – 如果 packed 为 True，目前还不支持多模态数据集。