OpenAIToMessages

class torchtune.data.OpenAIToMessages(train_on_input: bool = False, column_map: Optional[Dict[str, str]] = None, new_system_prompt: Optional[str] = None)

将符合 OpenAI 聊天完成 JSON 结构的单个聊天样本转换为 torchtune 的 Message 结构。这支持文本和图像消息。

单个样本通常包含单个可选系统提示和一个或多个用户和助手消息回合。

例如

{
    "messages": [
        {
            "role": <system|user|assistant>,
            "content": [
                {
                    "type": "text",
                    "text": "What'''s in this image?",
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": <url>,
                    },
                },
        },
        ...
    ]
}

Message 如下

[
    {
        "role": <system|user|assistant>,
        "content": [
            {
                "type": "text",
                "content": "What'''s in this image?",
            },
            {
                "type": "image",
                "content": <PIL.Image.Image>,
            },
        ],
    },
    ...
]

参数:

• train_on_input (bool) – 是否应保留提示未掩盖。默认值：False

• column_map (Optional[Dict[str, str]]) – 从预期的列（“消息”）到数据集中新列名的映射。键应为“消息”，值应为新列名。如果为 None，则保留默认的“消息”。默认值为 None。

• new_system_prompt (Optional[str]) – 如果指定，则附加系统消息。这可以作为指导模型响应的说明。设置此项将覆盖数据集中已存在的任何系统消息。默认值为 None。

引发:

ValueError – 如果提供 column_map 且 messages 不在 column_map 中。